User talk:Rain/Sandbox: Difference between revisions
(Blanked the page) Tags: Blanking Manual revert |
No edit summary |
||
| Line 1: | Line 1: | ||
==What does and does not belong on this page== | |||
If something describes in detail how an aspect of the implementation of Pavlov VR dedicated servers works, it belongs on this page. | |||
If something is only tangentially related to dedicated servers, like how to get an MD5 checksum from text, how to use bash, port forwarding, file permissions, specific features of tools/libraries, do not belong on this page. That's what guides are for and wikis do not contain guides! Guides may be linked at the bottom of the article. | |||
If something is a hack and not officially supported, such as having more than 10 max players on shack servers, does not belong on this page. | |||
Users are expected to have a certain brain capacity to be able to google for things to figure them out. This is not an IT help forum that explains in detail how to use computers. All it must contain is information specific to dedicated server software. | |||
==Grammar and syntax== | |||
The user/reader is never to be referred to directly. Reflexive and personal pronouns are to be avoided. | |||
Bad: You can run the command. | |||
Good: This command can be run. | |||
Bad: If this does not work, try something else. | |||
Good: There are alternatives, should this not work. | |||
Bad: Note: I don't think this is accurate | |||
Good: Note: The accuracy of this information may be questionable. | |||
Command descriptions use the imperative third person form. These sentences are formulated by starting with "This command...". | |||
Bad: Ban a player | |||
Good: Bans a player | |||
Bad: To enable or disable the whitelist | |||
Good: Enables or disables the whitelist | |||
Revision as of 06:09, 30 June 2023
What does and does not belong on this page
If something describes in detail how an aspect of the implementation of Pavlov VR dedicated servers works, it belongs on this page.
If something is only tangentially related to dedicated servers, like how to get an MD5 checksum from text, how to use bash, port forwarding, file permissions, specific features of tools/libraries, do not belong on this page. That's what guides are for and wikis do not contain guides! Guides may be linked at the bottom of the article.
If something is a hack and not officially supported, such as having more than 10 max players on shack servers, does not belong on this page.
Users are expected to have a certain brain capacity to be able to google for things to figure them out. This is not an IT help forum that explains in detail how to use computers. All it must contain is information specific to dedicated server software.
Grammar and syntax
The user/reader is never to be referred to directly. Reflexive and personal pronouns are to be avoided.
Bad: You can run the command.
Good: This command can be run.
Bad: If this does not work, try something else.
Good: There are alternatives, should this not work.
Bad: Note: I don't think this is accurate
Good: Note: The accuracy of this information may be questionable.
Command descriptions use the imperative third person form. These sentences are formulated by starting with "This command...".
Bad: Ban a player
Good: Bans a player
Bad: To enable or disable the whitelist
Good: Enables or disables the whitelist