search

DocCyblade / tkl-mayan-edms

Turnkey Linux - Mayan EDMS
https://www.turnkeylinux.org/mayan-edms
Other
4 stars 12 forks source link

Create documentation #47

Closed DocCyblade closed 3 years ago

DocCyblade commented 7 years ago

Create other docs: put them on wiki for now

DocCyblade commented 7 years ago

Docs are good but where should they go? Should they be with the build code, or add them to the app in a docs folder, post them on the forums?

JedMeister commented 7 years ago

My inclination is to put the "master" docs in a /docsdirectory within the appliance build code. There is a precedent for that, it's possibly in others too, but you can see it in both the OpenVPN appliance and TKLDev. If you use RST (ReStructured Text) rather than markdown, then it renders pretty nicely in GitHub but is also really easy to convert to html (for the TurnKey website doc pages).

On a tangent; we hope to change the way that the docs work on the website after we have upgraded the website. Ideally we'll move all the docs to GitHub and have an automated script to build static html files which will be uploaded to the website. Then editing the docs will be a case of editing the text files on GitHub...