ToriOS Documentation

Registered by amjjawad  on 2014-01-14

As always, Documentation for any Software Project is 'very' important. Since we have not yet started with serious development, it would be great if we could find someone who will be dedicated to document each and every single step from day one because that would be very easy. The sooner we start with this, the easier it would be for any contributor. No way ToriOS will be ready over night and it might take months of hard work so document every step from the beginning is very good idea.

What we need?

1- Where to host these documents?
2- Who will volunteer for this task?
3- What markup do we use, LaTeX is easy to make in to PDF for printable / downloadable manuals
    HTML / CSS etc

====================================
How To Edit The Whiteboard on Blueprints
====================================
The steps are very easy and simple:

1- While you are viewing the Blueprint you would like to edit, Click on the Yellow Icon which says "Edit Whiteboard" - please see: https://wiki.ubuntu.com/UbuntuGNOME/Brainstorming?action=AttachFile&do=get&target=step2.png

2- Add your name/username/launchpad name between two [YOUR_NAME_HERE].

3- Post your suggestion at the bottom of the Whiteboard.

4- Once done, click on the Green Icon to accept the changes. You are Done.

5- Thank you for editing the Whiteboard.

6- Please 'do not' edit the description of the blueprint.

Blueprint information

Status:
Started
Approver:
amjjawad 
Priority:
Medium
Drafter:
amjjawad 
Direction:
Needs approval
Assignee:
Geoffrey De Belie
Definition:
Discussion
Series goal:
None
Implementation:
Slow progress
Milestone target:
None
Started by
amjjawad  on 2014-02-17

Related branches

Sprints

Whiteboard

[Smile4ever] I suggest we host the documentation on our own wiki, based on MediaWiki software? I have a lot of experience with MediaWiki, and it works great. It needs PHP and MySQL and some other - rather frequent - libraries. Website: http://mediawiki.org

For the offline documentation, we can use LaTex actually if we use MediaWiki syntax: http://stackoverflow.com/questions/2029270/convert-latex-to-mediawiki-syntax
http://stackoverflow.com/questions/2431530/convert-mediawiki-to-latex-syntax
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

[zleap] While my knowledge of LaTeX is minimal I can create basic documents I just think LaTeX is more open to people to edit etc, better than using open document format as LaTeX is simply plain text with markup
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

[zleap] Made a start using LaTeX and TeX Studio under Lubuntu 13.10
http://ubuntuone.com/0b4bWMCUqrpH3coeXOZSTO for the pdf file

Just updated this so it should now be possible to download the latest version, I am not sure why 1 page shows 4 then contents in the other corner

Another update http://ubuntuone.com/0b4bWMCUqrpH3coeXOZSTO

and source file : http://ubuntuone.com/5rzAxxDWQ3DQi6210090p6
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

[amjjawad] Blueprints don't allow to assign to more than one, it is either a person or a team. I assigned this to Smile4ever and I see zleap has subscribed to it so please, since both of you are in charged of the Wiki and the Documentation part, I leave this blueprint between your kind hands ;)

I know nothing yet to be done but there are few things that we need to get it up and running or shown - will communicate that later or post here :)
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[Smile4ever] WikiMap: http://wiki.torios.org/index.php?title=WikiMap
Translating pages on the wiki: http://wiki.torios.org/index.php?title=Help:Translating
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

I have moved the files relating to TorioS documentation to github
https://github.com/zleap/torios-manual

[zleap] 23/5/2014
Technical overview added with the information from the mailing list added as ennumerate list

Ok I have added the above to the manual, under technical overview, and uploaded to my github account

https://github.com/zleap/torios-manual

It is in the Manual so thereofre can be edited
TO do; Remove numbering from original text so that latex handles the numbering of theitems

This is easy as Latex will do this for us, if we remove an item, the list will be auto renumbered, (why I like latex)

[zleap] 23/5/2014 : 19:53

Downloaded the logo.svg from website, saved as a png file and inserted the final logo in to the manual

[zleap] 12 06 2014

Manual updated added note on use of JWM window manager, uploaded latest pdf of manual
https://github.com/zleap/torios-manual

[Smile4ever] 21 07 2014

Documentation wiki will be based on DokuWiki, still investigating how multilanguage should work, link to plugin: https://www.dokuwiki.org/plugin:translation
This will replace the wiki that was in place before William broke it. DokuWiki should be more resistent and stable because it makes use of plain text files internally.

[Momozor] 08 05 2019

zleap made the latest ToriOS (WIP) manual and hosted at Github - https://github.com/zleap/ToriosManualv2

(?)

Work Items

Work items:
1- To discuss some basic tasks to be done for the Wiki and Documentation side of ToriOS at the very early stages : INPROGRESS
2 - Smile4ever to setup a new wiki based on DokuWIKI: INPROGRESS
3- Smile4ever to create a new WikiMap (https://wiki.ubuntu.com/UbuntuGNOME/OneStopPage#Section_A:_Wiki_Map) for ToriOS Wiki : INPROGRESS
4- Smile4ever to provide a way for translating pages on the new wiki: INPROGRESS

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.