| Version | Date | Notes | By |
|---|---|---|---|
| 0.1 | 2017-03-18 | Initial release | JFM |
Need to change this to use git
Before writing any document in Grav check if the topic you want to write isn't already available on thie platform or any other type of documentation source used by WeMake. If it's available and you want to change or improve, check first with the creator/creators of the document.
The Grav platform is the WeMake choosen platform to provide tecnhical documentation on all areas. Grav uses Markdown Markup Language but also accepts plain HTML. You can check the Grav documentation on how to write in Markdown syntax
Once you login to Grav click on the Pages menu located on the left side menu bar. In the content area (right side of the page) you will see the documentation tree. Every document is organized by specific areas, and your document should be included in one if those areas, check with me if you need a new area or have doubts where to include your document.
On the top right click on the Add button, fill all the fields (choose Docs as the Page Template) and click Continue
After this you are ready to start writing the document.
Try to keep HTML as minimum as possible and use it only if theres no other way.
Every document MUST have a version history table like this:
| Version | Date | Notes | By |
|---|---|---|---|
| 0.2 | 2017-03-20 | Some change | JFM, ROB |
| 0.1 | 2017-03-18 | Initial release | JFM |
Version should always start as 0.1 and are incremental in sequencial order: 0.1 -> 0.2 -> 0.3....0.9 -> 1.0 -> 1.1
The most recent version MUST be on top
If the document was done/changed by more than 1 person, separate them by a comma.
Draft!!!
Outdated!!!