User Tools

Site Tools


misc:wiki:index

This is an old revision of the document!


Organization

Namespaces

The wiki has three main tracks: projects, docs and misc. Each of these three have one namespace each where documentation is nested underneath it. Here's the content:

  • projects: Documentation that only relates to this project. Pages here should link into the doc structure, but pages with documentation should only contain things relevant to this specific project. For instance Crazyflie 2.0 assembly instruction should be placed in the projects namespace. CRTP (which spans multiple projects) should not.
  • doc: Documentation spanning multiple projects should be placed here and referenced (if necessary) from specific projects that use it. For instance CRTP and Android documentation should be placed here, but not schematics for the Crazyflie or assembly instructions for the Crazyflie 2.0.
  • misc: Things that aren't related directly to a specific project and that isn't documentation for products. Here we have placed things like this page, hacks for different projects and investigations that might span lots of different things.

Index

Each namespace should contain an index page that specifies what's in the namespace and links to it. Even though some pages links past namespaces, these should still contain an index for links from outside.

Access

To avoid spam and defacing we have decided to not have an open registration for now. If you want access to the Wiki will gladly grant it, just drop us an email at wiki@bitcraze.se.

Tags

We have installed this tag plugin to help us keep track of updates that needs to be done. There's currently two types of updates: pages that needs updating in general and pages that needs updating on specific events (like SW release). Even though we try to limit the dependencies (like not mentioning specific versions) there's still some things that needs to be updated regularly. Having these pages tagged will hopefully help us keep things up to date.

Currently we are using the following tags (clink link to list pages):

  • needs_update: The pages needs an update because it's out of date or wrong
  • update_on_client_release
  • update_on_android_release
  • update_on_ios_release
  • update_on_fw_release
  • update_on_vm_release
  • update_on_pi_release
misc/wiki/index.1436970670.txt.gz · Last modified: 2016-03-29 16:22 (external edit)