Wiki Organization

Wiki Organization

There is a separate Guide Repository and corresponding Guide Website. And there are also the Wiki pages for each project. But when do you use the Wiki, and when do you use the Guide?

Use the Wiki for:

• Pre-Release
• Info required for Contributors. e.g. Architecture, Developer machine setup, etc.
• Info which stays up-to-date, where old versions have no (or little) value. Wiki does store revisions, but there is no need to make it hugely visible
• Info that does not need to be packaged or made available offline
• Each project (web, android, guides, chef) has its own wiki
• The _Footer, Home and the first/last links in the _Sidebar of all wikis are the same. This allows easy jumping between the wikis. Make sure any change you make on these is propagated back to all the wikis.

Use the Guides for:

• Post-Release
• Info required for Consumers. e.g. Installing, Field usage, Administration, etc.
• Info which needs to be versioned. e.g. API documentation for v1.0, v1.1, v1.2, etc.
• Info that needs to be packaged or made available offline as a PDF, etc.