Wiki Contributor Guidelines

Vega Strike Wiki Contributor Guidelines

This page should be a basic outline for anyone editing the Wiki. While there are no fixed rules, the below should act as a guide to help keep the information available in a uniform manner.

If you have any questions, then please feel free to ask us on Gitter

The Basics

GitHub provides an editor that can add pages. This should be used for simple changes and functionality. However, it might be desireable to do larger changes locally; this can be achieved through cloning the Wiki just like we do code:

$ git clone https://github.com/vegastrike/Vega-Strike-Engine-Source.wiki.git

Note

Checking out locally can also be an efficient way to add images and other files. Beware though - it might be a large download.

When editing locally, you will want to also review what things look like as you go along. There are a number of tools that can be used for this so use what is easiest for you. A simple one that might be useful is the Python RestView tool which can be used as follows:

$ virtualenv venv.restview
$ source venv.restview/bin/activate
$ pip install restview
$ restview Vega-Strike-Engine-Source.wiki

This will open a web-browser on the local system that can be used to view the rendered pages, at least for any ReStructured Text (RST) formatted pages.

File Formats

While the GitHub Wiki supports a number of formats, in general ReStructured Text (RST) and MarkDown (MD) formats are pretty good. Please use the ones that are easist to communicate the information being related for the specified page. This may change over time.

Please name all files using the CamelCase format.

Note

Some formats work better in some editors than others. For example, MarkDown (MD) while supported does not generally look good under Vim out of the box; while ReStructured Text (RST) looks a lot better. The two formats are roughly equivalent in terms of functionality.

The Project Name

The original VegaStrike Wiki (wiki.vega-strike.org) recorded the project's name as being officially "Vega Strike" and called for it to be referred as such every where possible. We'll continue this tradition in the spirit of honoring the original developers and community.

Style Guidelines

• If you add a new page or add headers to a page, please keep them short and sweet; it should be a simple, short, and proper sentence.
• Don't be afraid to split content into multiple pages; just be sure to things get linked together.