DocumentationHosting.md (1799B)
1 # Documentation/Wikis 2 3 Documentation hosting is important and depending on ones needs, different solutions may be optimal. 4 5 ## SSGs 6 7 Static site generators are a dime a dozen, and they are great from a performance perspective and easy to maintain. I will not go into the specifics of each one but some popular one are Jekyll, Hugo, and Mkdocs. This approach for documentation hosting has pros and cons, as shown below. 8 9 **Pros:** 10 11 1. Simple to setup 12 2. Lightweight 13 3. Easy to maintain 14 4. Easy to use with git versioning 15 16 **Cons:** 17 18 1. Limited in functionality 19 20 From the perspective of a developer, SSGs are my preferred approach to documentation because editing can be done via any text editor and versioning can be done with git. If a proper CD pipeline has been implemented, the process of editing these documents is seamless and the performance and security of the web server are not of much concern because it is simply Nginx hosting HTML files. 21 22 The main con of SSGs is they are difficult for non-technical users to change. Given that they are often versioned with git and created by writing markdown files, non-technical users will likely not have a pleasant time trying to make documentation changes which is where wikis come into play. 23 24 ## Wikis 25 26 Wikis are great when non-technical people need to make changes to shared documents or in cases where a web UI for editing documents is mandatory. 27 28 ### MediWiki 29 30 This portion of the docs has not been completed. Feel free to submit a PR via email if you would like to contribute! 31 32 ### DokuWiki 33 34 This portion of the docs has not been completed. Feel free to submit a PR via email if you would like to contribute! 35 36 ### BookStack 37 38 This portion of the docs has not been completed. Feel free to submit a PR via email if you would like to contribute!