diff options
author | Robert Fairley <rfairley@redhat.com> | 2018-08-20 15:40:32 -0400 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-08-21 14:05:14 +0000 |
commit | 417b5c7067436893c865eabe1774777f30e98c59 (patch) | |
tree | 2b01e58bee386ef27baccd8d1938dfb9465b83e5 /docs | |
parent | bb66a03fefb43cead6e059875cc5ad78a2401ec3 (diff) | |
download | ostree-417b5c7067436893c865eabe1774777f30e98c59.tar.gz |
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
Diffstat (limited to 'docs')
-rw-r--r-- | docs/CONTRIBUTING.md | 6 | ||||
-rw-r--r-- | docs/contributing-tutorial.md | 18 |
2 files changed, 11 insertions, 13 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ed22e90a..de14c380 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -168,7 +168,7 @@ Instead do this: } } -Contributing: Tutorial ----------------------- +Contributing Tutorial +--------------------- -For a detailed walk-through on building, modifying, and testing, see this [tutorial on how to start contributing to OSTree](contributing-tutorial.md).
\ No newline at end of file +For a detailed walk-through on building, modifying, and testing, see this [tutorial on how to start contributing to OSTree](contributing-tutorial.md). diff --git a/docs/contributing-tutorial.md b/docs/contributing-tutorial.md index a1f0c4be..47d0a1e9 100644 --- a/docs/contributing-tutorial.md +++ b/docs/contributing-tutorial.md @@ -62,11 +62,11 @@ apt-get install build-essential && \ apt-get build-dep ostree ``` -[build.sh](../ci/build.sh) will have a list of packages needed to build ostree. +[build.sh](https://github.com/ostreedev/ostree/blob/master/ci/build.sh) will have a list of packages needed to build ostree. ### OSTree Build Commands -These are the basic commands to build OSTree. Depending on the OS that OSTree will be build for, the flags or options for `./autogen.sh` and `./configure` will vary. +These are the basic commands to build OSTree. Depending on the OS that OSTree will be built for, the flags or options for `./autogen.sh` and `./configure` will vary. See `ostree-build.sh` in this tutorial below for specific commands to building OSTree for Fedora 28 and Fedora 28 Atomic Host. @@ -103,7 +103,7 @@ Make allows parallel execution of recipes. Use `make -j<N>` to speed up the buil See page 106 of the [GNU Make Manual](https://www.gnu.org/software/make/manual/make.pdf) for more information about the `--jobs` or `-j` option. -## [Testing a Build](#testing-a-build) +## Testing a Build It is best practice to build software (definitely including ostree) in a container or virtual machine first. @@ -277,10 +277,8 @@ To find the IP address of a Vagrant VM, run `vagrant ssh-config` in the same dir 6. Set `rsync` to sync changes in `/etc` and `/usr` from `<ostree-install-dir>/` on the host to the VM: - ``` - $ rsync -av <ostree-install-dir>/etc/ root@<ip-address>:/etc - $ rsync -av <ostree-install-dir>/usr/ root@<ip-address>:/usr - ``` + $ rsync -av <ostree-install-dir>/etc/ root@<ip-address>:/etc + $ rsync -av <ostree-install-dir>/usr/ root@<ip-address>:/usr Using option `-n` will execute the commands as a trial, which is helpful to list the files that will be synced. @@ -358,7 +356,7 @@ This will add a command which prints `Hello OSTree!` when `ostree hello-ostree` $ ostree hello-ostree Hello OSTree! -### [OSTree Tests](#ostree-tests) +### OSTree Tests Tests for OSTree are done by shell scripting, by running OSTree commands and examining output. These steps will go through adding a test for `hello-ostree`. @@ -436,7 +434,7 @@ When returning to work on a patch, it is recommended to update your fork with th If creating a new branch: -``` +```bash $ git checkout master $ git pull upstream master $ git checkout -b <name-of-patch> @@ -444,7 +442,7 @@ $ git checkout -b <name-of-patch> If continuing on a branch already created: -``` +```bash $ git checkout <name-of-patch> $ git pull --rebase upstream master ``` |