ostree/mkdocs.yml

site_name: OSTree
pages:
  - Home: 'index.md'
  - Contributing: 'CONTRIBUTING.md'
  - Contributing Tutorial: 'contributing-tutorial.md'
  - Manual:
      - Introduction: 'manual/introduction.md'
      - Repository: 'manual/repo.md'
      - Deployments: 'manual/deployment.md'
      - Atomic Upgrades: 'manual/atomic-upgrades.md'
      - Adapting Existing Systems: 'manual/adapting-existing.md'
      - Formats: 'manual/formats.md'
      - Build Systems and Repos: 'manual/buildsystem-and-repos.md'
      - Repository Management: 'manual/repository-management.md'
      - Related Projects: 'manual/related-projects.md'
mkdocs: Fix the site name 2016-03-21 12:53:40 -04:00			`site_name: OSTree`
Rewrite manual in mkdocs I don't much like Docbook (and am considering converting the man pages too), but let's start with the manual. I looked at various documentation generators (there are a lot), and I had a few requirements: - Markdown - Packaged in Fedora - Suitable for upload to a static webserver `mkdocs` seems to fit the bill. 2016-01-27 16:56:16 -05:00			`pages:`
			`- Home: 'index.md'`
			`- Contributing: 'CONTRIBUTING.md'`
docs: Add Contributing Tutorial to Mkdocs pages This adds the Contributing Tutorial (contributing-tutorial.md) to the pages setting of Mkdocs, so that the tutorial will render in the readthedocs.io documentation. Closes: #1711 Approved by: jlebon 2018-08-20 15:40:32 -04:00			`- Contributing Tutorial: 'contributing-tutorial.md'`
Rewrite manual in mkdocs I don't much like Docbook (and am considering converting the man pages too), but let's start with the manual. I looked at various documentation generators (there are a lot), and I had a few requirements: - Markdown - Packaged in Fedora - Suitable for upload to a static webserver `mkdocs` seems to fit the bill. 2016-01-27 16:56:16 -05:00			`- Manual:`
			`- Introduction: 'manual/introduction.md'`
			`- Repository: 'manual/repo.md'`
			`- Deployments: 'manual/deployment.md'`
			`- Atomic Upgrades: 'manual/atomic-upgrades.md'`
			`- Adapting Existing Systems: 'manual/adapting-existing.md'`
docs: Add a new formats section, move static deltas in there The `src/libostree/README-deltas.md` was rather hidden - let's move this into the manual. 2016-02-22 14:06:20 -05:00			`- Formats: 'manual/formats.md'`
docs: Add a section on writing buildsystems And add a test that is a demo buildsystem. 2016-03-03 21:17:53 -05:00			`- Build Systems and Repos: 'manual/buildsystem-and-repos.md'`
docs: Add a section on repository management Just keeping my promise to write more documentation. There could be a lot more to write here, but I'm trying to get a start done. Closes: #222 Approved by: jlebon 2016-03-25 10:35:25 -04:00			`- Repository Management: 'manual/repository-management.md'`
manual: Migrate related projects wiki page into manual This content currently lives here: <https://wiki.gnome.org/Projects/OSTree/RelatedProjects>. Moving it into the manual in Markdown: - Makes it look better - It's more useful alongside the rest of the docs - Is much less crummy in general than the GNOME wiki 2016-03-16 21:39:06 -04:00			`- Related Projects: 'manual/related-projects.md'`