Wiki updates

[peabody124]

So cGiesen has been doing some nice work on the wiki updating some of the pages linked from the GCS. I wanted to take a few minutes to discuss the overall file layout within the wiki as well as naming convention just because I realized he and I were switching between naming formats:

e.g. https://github.com/TauLabs/TauLabs/wiki/User-Guide:-Battery-Configuration v https://github.com/TauLabs/TauLabs/wiki/OnlineHelp:-Modules-Battery

It's important to be consistent or otherwise links like https://github.com/TauLabs/TauLabs/wiki/Gcs-user-guides end up breaking. As is, I would say at least half the problem with our current wiki is that it isn't intuitive to find things. However, github wiki (i.e. gollum) is actually fairly powerful.

One issue that is a bit counterintive is the handling of directories. I found some discussion here http://stackoverflow.com/questions/11088285/github-wiki-directories . If you didn't know, the wiki is actually a git repository you can clone from here g...@github.com:TauLabs/TauLabs.wiki.git for offline editing. If you do that you can see there is actually a directory layout, where apparently different directories can pick up different _Siderbar files. E.g. notice that now the siderbar on this page lists cows: https://github.com/TauLabs/TauLabs/wiki/Autotune

One thing that isn't awesome is that I don't see an easy way to shuffle the files around via the web interface, but we can have people periodically manually organize through git. 

----------

Anyway this is all a long set up for me proposing a few namespaces. For each name space (NS) we call pages NS/NS-pagename.md. This will make the wiki more organized when you list by pages (https://github.com/TauLabs/TauLabs/wiki/_pages) although that won't show the folders which is why we have to prepend the name space to the file name as well. That way we can have more useful sidebars for each directory.

For name spaces we should come up with a few useful ones:

• OnlineHelp -- these should be pages  that are linked by the help button in GCS. However, things like the battery page are _not_ linked directly from the GCS so I personally do not think apply
  
• UserGuides -- the difference to me between these and OnlineHelp is that OnlineHelp is more like a description of what the page is, but a user guide is a walk through on how to do things. E.g. https://github.com/TauLabs/TauLabs/wiki/Gcs-user-guides. A lot of these require going to multiple parts of the UI to accomplish a goal
• Architecture -- general description of the software architecture 
• Development -- instructions regarding getting dev environments going, coding standards, pushing code, etc

[peabody124]

Oh. One other issue is how to deal with next versus master. I think most of the devs are on board for a faster release cycle now so hopefully we won't have another situation of a master that is 4 months behind. However, it's always best to update the wiki as close to a merge as possible, but that means the documentation will not be up to date for master which is meant to be the most supported version.

I'd propose in this case we can just split the page - have a heading at the top for the master version, copy and paste it to the bottom and make another heading for next?

[Carsten Giesen]

I have no preferences because of naming. I use OnlineHelp: because we link directly from GCS. We can use UserGuide too, no problem.

I'm happy to get a rule to create a name. 

[Reddog]

If people wanted to add or edit the wiki how do they do that? Do they need write access? If so how does someone get that?

[José Eduardo S. C. Xavier]

You can use the edit button inline with the title

https://github.com/TauLabs/TauLabs/wiki/Creating-a-FlyingF3-from-scratch

2013/12/26 Reddog <nat...@reddog.com.au>

--
You received this message because you are subscribed to the Google Groups "phoenixpilot" group.
To unsubscribe from this group and stop receiving emails from it, send an email to phoenixpilot...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

[peabody124]

You probably have to have a github account and be logged in.

[Flensburger]

Hi.
I'm new here.

Not easy to understand Taulabs, wiki isn't helpful really .

Changed some wiki pages and connected some pages for better understanding.

My Git-Name is LinuxJohannes.

I want to change more pages and will use the guidelines on top.

Regards

[José Eduardo S. C. Xavier]

Welcome :)

Thats great that you arranjed the wiki.

2014/1/24 Flensburger <dertro...@gmail.com>

[Flensburger]

Thanks. The first changes are done. Please check.