...
| Company Name | Document Project | Project Type | Open Source License | Document Library Management | SCM | Develop Language | Language Style | Review | Bug Tracking | Compile Tool | Translation Process | Release Method | CI Tool | Release Cycle | Release Form | Other Supporting Tools | Search Implementation |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| NASA And Rackspace | openstack | Open source project | Apache 2.0 | Open library | Git | rst | -- | PR/Review meeting/Docking internal bug tracking system | issues/JIRA | Sphinx | Independent branch | Offline CI | www-generator.py publishdocs.sh | Released with product release | Website/pdf | R & D document generation tool?contains terminology tools? | ? |
| Microsoft | Microsoft Azure | Open source project | MIT | Open library + Private library | Git/Github | Markdown | DFM | PR | PR/Labels Automation bot tracking building and Bug | DocFX | Independent branch | Offline CI | DocFX | Every day | Website | DocFX | ? |
| Google-Tensorflow | Open source project | Apache License 2.0 | Open library + Private library | Git/Github | Markdown | GFM | issues | issues | Website generator+doxygen | ? | Offline CI | g3doc website generator | ? | Website | API automatic generation tool, gen_docs.sh, text processing tools | Borrow Google website search | |
| Google-Kubernetes | Open source project | Apache License 2.0 Creative Commons Attribution 4.0 | Open library + Private library | Git/Github | Markdown | GFM | PR/issues | issues | Jekyll | ? | Online | Jekyll | ? | websites | ? | ? | |
| Google-GCP | Closed source project | ? | Private library | Internal git | markdown | ? | ? | ? | g3doc | ? | Offline | ? | ? | website | ? | ? | |
| sencha | Extjs | Closed source project | ? | Private library | Git/Github | Markdown | ? | ? | ? | JsDuck | ? | Offline | ? | ? | website | ? | ? |
| StackExchange | Stackoverflow | Closed source project | ? | ? | Git/Github | Markdown | ? | ? | ? | ? | ? | Online | ? | ? | website | ? | ? |
| Amazon | AWS | Closed source project | ? | All open(only Developer guide) | Git/Github | rst | ? | ? | ? | Sphinx | ? | Offline CI | build_docs.py | ? | website | ? | ? |
| Labs126 | Closed source project | ? | ? | Git/Github | Markdown | GFM | ? | ? | Jekyll | ? | Offline CI | ? | ? | website | ? | ? | |
| Docker | docker | Open source project | ? | Open library + Private library | Github | Markdown | GFM | ? | ? | hugo | ? | ? | ? | ? | website | ? | ? |
| ? | |||||||||||||||||
| Project of document tool | |||||||||||||||||
| Sphinx | Sphinx | Open source project | BSD | ? | ? | rst/markdown | ? | ? | ? | ? | ? | Offline | sphinx cli | ? | website/Apple Help/ePub/LaTex/text/manual page (unix)/Textinfo/linkcheck builder/c++ domain | ? | ? |
| Github | Gitbook | Open source project | Apache 2.0 | ? | ? | md/ascii text | GFM | ? | ? | ? | ? | Offline | gitbook cli | ? | website/pdf/epub/mobi | ? | ? |
| Github | Closed source project | ? | All open | Git/Github | ? | ? | PR/issues | ? | Jekyll | ? | Online | Jekyll | ? | ? | Jekyll-Auth | ? | |
| Anchor | ||||
|---|---|---|---|---|
|
Based on the comparison above, a discussion with Sofia Wallin on experience with Documentation in OPNFV, and two detailed examples A Sample about how to develop documents by Markdown and An Example of Creating Documents with ReStructured Text-Sphinx-Readthedocs were we recommend:
- ReStructured Text-Sphinx-Readthedocs as the way to organize and publish ONAP documentation.
- Where there are existing source documents in other formats or ReStructured Text is hard to use for new content, we will identify options to support these on a case by case basis (eg. Templates for ReStructured Text or , Extensions for Sphinx, Converters, etc).