GitBook exploration

[jpmckinney]

Logging some notes here, from briefly exploring whether Gitbook can replace Sphinx (easier to edit and deploy).

Required features for any replacement:

• has GitHub integration: https://docs.gitbook.com/integrations/github/limitations
• has macros like Sphinx
• can insert custom JS
• has i18n integration/support
• has support for branches of the documentation (test * filter: https://docs.gitbook.com/content-editing/releases)
• supports multiple versions: https://docs.gitbook.com/content-editing/releases
• supports multiple languages: https://docs.gitbook.com/v2-changes/important-differences#multi-language-books https://docs.gitbook.com/content-editing/releases#usage-examples
• good search engine
• has Sphinx migrator

GitBook is moving toward being a product instead of a platform, which adds some risk around whether we can reliably use the tool in the medium/long term.