-
Notifications
You must be signed in to change notification settings - Fork 41
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
Conversation
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...
There was a problem hiding this 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.
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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 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. |
This resolves the reference to the first "we" in the text, which was previously somewhat ambiguous. See longturn#1304.
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.