Unofficial Vyatta Wiki:Editing guide

When editing articles, please follow these words of advice.

Basics

 * Search before starting an article. If you have found an article on topic you want to write about already exists, add your information to it instead of creating new one.
 * Use wiki markup. A quick reference is here (we use the same engine to Wikipedia called MediaWiki). More detailed reference is here. When in doubt, search in e.g. google for "mediawiki $something".
 * Don't forget to add categories to your article with special links at the end of your page like For example, if your page is about firewall, add   They are used for navigation (if you click a category link you'll see all articles in it).
 * Keep trying to specify the source of information you add. We aren't Wikipedia with its strict rules and you don't need to add a reference to any word on your page, but for facts like new release features or configuration techniques/snippets source is a good thing. They are typically added with references, see e.g. Version history for an example. Typically link to sources are added as references. Like this: Vyatta can be ran on example platform Add

Specifics

 * Output of configuration mode "show" commands is much more readable than "set" commands, so it's preferred way to show configuration snippets. However in pages intended for beginners it's better to put both "show" and "set" for the same config.
 * By default pages are about "Foo in Vyatta", so page BGP should be about how to configure BGP. Page about the feature itself should be named e.g. BGP (Protocol) or BGP/Theory.