Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Company   NameDocument ProjectProject TypeOpen Source LicenseDocument Library   ManagementSCMDevelop LanguageLanguage Style
   
ReviewBug TrackingCompile ToolTranslation ProcessRelease MethodCI ToolRelease CycleRelease FormOther Supporting ToolsSearch Implementation
NASA   And RackspaceopenstackOpen source projectApache 2.0Open libraryGitrst--PR/Review   meeting/Docking internal bug tracking systemissues/JIRASphinxIndependent branchOffline CIwww-generator.py
    publishdocs.sh
Released with product   releaseWebsite/pdf    R & D document generation tool?contains terminology tools?
   
?
MicrosoftMicrosoft AzureOpen source projectMITOpen library +   Private libraryGit/GithubMarkdownDFMPRPR/Labels
    Automation bot tracking building and Bug
DocFXIndependent branchOffline CIDocFXEvery dayWebsiteDocFX?
GoogleGoogle-TensorflowOpen source projectApache License 2.0Open library + Private   libraryGit/GithubMarkdownGFMissuesissuesWebsite   generator+doxygen?Offline CIg3doc
    website generator
?WebsiteAPI automatic   generation tool, gen_docs.sh, text processing toolsBorrow Google website   search
Google-KubernetesOpen source projectApache License 2.0
    Creative Commons Attribution 4.0
Open library +   Private libraryGit/GithubMarkdownGFMPR/issuesissuesJekyll?OnlineJekyll?websites??
Google-GCPClosed source project?Private libraryInternal gitmarkdown???g3doc?Offline??website??
senchaExtjsClosed source project?Private   libraryGit/GithubMarkdown???JsDuck?Offline??website??
StackExchangeStackoverflowClosed source project??Git/GithubMarkdown?????Online??website??
AmazonAWSClosed source project?All open(only   Developer guide)Git/Githubrst???Sphinx?Offline CIbuild_docs.py?website??
Labs126Closed source project??Git/GithubMarkdownGFM??Jekyll?Offline CI??website??
DockerdockerOpen source project?Open library +   Private libraryGithubMarkdownGFM??hugo????website??
?
Project of document tool
SphinxSphinxOpen   source projectBSD??rst/markdown?????Offlinesphinx cli?website/Apple Help/ePub/LaTex/text/manual page   (unix)/Textinfo/linkcheck builder/c++ domain??
GithubGitbookOpen source projectApache 2.0??md/ascii textGFM????Offlinegitbook cli?website/pdf/epub/mobi??
GithubClosed   source project?All openGit/Github??PR/issues?Jekyll?OnlineJekyll??Jekyll-Auth?


Anchor
DocToolChainRecommendation
DocToolChainRecommendation
Recommendation

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).