Geoscience Documentation Made Easy – The Open Source Knowledge Hub
summary
Digital Earth Australia consolidates multiple documentation sites into a single static site that serves product pages, user guides and rendered Jupyter notebooks; it stores content as plain text (YAML + Markdown) in Git, uses Sphinx + Jinja2 templates to generate templated product pages without a database, and uses nbsphinx notebook rendering to publish runnable outputs on the web. Editing follows a docs-as-code with GitHub PR workflow so peer review happens before merge, the repo is open source and forkable, and the site is live for DEA products.
AI-written summary · about
chapters (13)
- 0:00Introduction and acknowledgment
- 0:43Documentation challenges and solution
- 1:46Demo of the Knowledge Hub
- 3:35Data product pages overview
- 5:00User guides and markdown format
- 5:41Jupyter notebooks publishing
- 7:03Code comments as documentation
- 7:49Content formats and workflow
- 9:14GitHub editing workflow
- 10:16Advanced Sphinx templates
- 11:42Jupyter notebooks rendering
- 13:07Open source and collaboration
- 14:10Q&A session
related talks
05mDocs as Part of the Product: Open Source Technical Documentation at Scale
47mEngineering Documentation
30mBuilding technical documentation as a product at scale
44mPushing documentation (so it doesn't hurt anymore)
40mThe Knowledge: Towards a Culture of Engineering Documentation
18mearthaccess: Accelerating NASA Earthdata sci through open, collaborative development
31mCreating a documentation site for users with AsciiDoc and Antora
36mBuilding Docs like Code: Continuous Integration for Documentation