Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new documentation page about Freeciv21 on servers #1304

Merged
merged 8 commits into from
Aug 23, 2022

Conversation

lmoureaux
Copy link
Contributor

The intent of this page is to help people set up their own server. It should be an introduction with pointers to the relevant parts of the upcoming server manual.

The goal of this page is to give server admins most relevant information in a
single location, with pointers to detailed information when it makes sense.
They may get expanded later
This duplicates /help cmdlevel a bit, but is well-fitted on the "Freeciv21 on
the Server" page.
The fcdb docs need to be reviewed...
@lmoureaux lmoureaux added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 21, 2022
@lmoureaux lmoureaux requested review from jwrober and daavko and removed request for jwrober August 21, 2022 19:12
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Show resolved Hide resolved
Copy link
Collaborator

@jwrober jwrober left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not going to block this being merged. However, I do think that this page may cause some confusion for readers and we could do more cross-doc links to other pages as time progresses. My thinking with a forth-coming server manual was to include some game "recipes" to help potential server admins use the docs as a guide.

docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Show resolved Hide resolved
docs/General/on-the-server.rst Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
cheapest options.

Whether you choose to use your own machine or to rent one, the basic principle of operating a
server is the same: you need to run a program called ``freeciv21-server`` for as long as the game
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either change the colon to a semi-colon or break up into two sentences.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? This that you need to run freeciv21-server is the continuation of "the basic principle is the same". I think using a full stop or a semicolon would lose this nuance.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or maybe just a comma instead? IDK, the colon feels wrong, but I can't put my finger on it directly. I am also ok to leave as is.

docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Outdated Show resolved Hide resolved
docs/General/on-the-server.rst Show resolved Hide resolved
@lmoureaux
Copy link
Contributor Author

My thinking with a forth-coming server manual was to include some game "recipes" to help potential server admins use the docs as a guide.

I followed a similar course of thought. This was prompted by kreis' recent questions about setting up a public server*, and some of the content clearly originates from that discussion (the discussion about dependencies). I agree that this prompts for more pages, in particular a page documenting server command line options and another for game commands (which shouldn't mention the server, since they can be used from the client as well). The fcdb page also needs to be improved and taken out of Coding.

At the same time I wanted to keep the PR small to allow for easier review, which is why some content feels "missing".

*Hence the title "Freeciv21 on the Server" and not "Server Manual". This page is higher level than purely technical docs listing all available options, and omits all but the most relevant content.

@lmoureaux lmoureaux mentioned this pull request Aug 23, 2022
This resolves the reference to the first "we" in the text, which was previously
somewhat ambiguous.

See longturn#1304.
@jwrober jwrober self-requested a review August 23, 2022 18:33
@lmoureaux lmoureaux merged commit 78580e8 into longturn:master Aug 23, 2022
@lmoureaux lmoureaux deleted the docs/server-tips branch August 23, 2022 20:59
lmoureaux added a commit that referenced this pull request Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants