Commit Graph

3 Commits

Author SHA1 Message Date
Timothée Ravier
6ca312a923
docs: Update Contributing and tutorial pages 2020-10-02 14:34:48 +02:00
Robert Fairley
417b5c7067 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-21 14:05:14 +00:00
Robert Fairley
3f1faa4f33 docs: Add contributing tutorial
This adds a tutorial for developing/contributing to OSTree. The following information is included:
- Installing build dependencies for OSTree
- Building OSTree, and running in a container and VM
- Adding a basic command to OSTree, and testing the command
- Suggested git workflows for working with the upstream repo

This is helpful to give new contributors a more detailed introduction to developing OSTree, and an idea of what the workflow looks like.

Closes: #1694
Approved by: cgwalters
2018-08-20 15:23:00 +00:00