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 is only always latest, where old versions have little (or no) value. Wiki does store revisions if at all someone needs to look at the history
• Info that does not need to be packaged or made available offline
• Each project (web, android, guides, chef) has its own wiki. But the _Footer, Home and the first/last links in the _Sidebar are same. This allows easy jumping between 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, and the versions should be easily visible and discoverable. e.g. API documentation for v1.0, v1.1, v1.2, etc. The Guide repository will also have release branches for every RapidFTR release, and the guide website will also eventually have URLs for separate versions
• Info that needs to be packaged or made available offline as a PDF, etc.