diff options
| author | Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com> | 2016-08-28 17:56:17 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-09-30 13:21:00 -0400 |
| commit | 1071b9940b4e114cd2eabf290b739f92fbab33de (patch) | |
| tree | a8fbef15c5be9510df93b4544e3bca1f74e2f29a /doc/sources | |
| parent | 02f6c4bb8cef17b3fe04ef4dc1ef199e20aeb4d9 (diff) | |
| download | vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.tar.gz vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.zip | |
Improve module documentation and doc cleanup.
This adds lots of config module documentation in a standard format.
It will greatly improve the content at readthedocs.
Additionally:
* Add a 'doc' env to tox.ini
* Changed default highlight language for sphinx conf from python to yaml
most examples in documentation are yaml configs
* Updated datasource examples to highlight sh code properly
Diffstat (limited to 'doc/sources')
| -rw-r--r-- | doc/sources/altcloud/README.rst | 8 | ||||
| -rw-r--r-- | doc/sources/configdrive/README.rst | 4 |
2 files changed, 6 insertions, 6 deletions
diff --git a/doc/sources/altcloud/README.rst b/doc/sources/altcloud/README.rst index b5d72ebb..0a54fda1 100644 --- a/doc/sources/altcloud/README.rst +++ b/doc/sources/altcloud/README.rst @@ -14,7 +14,7 @@ The format of the Custom Properties entry must be: For example to pass a simple bash script: -:: +.. sourcecode:: sh % cat simple_script.bash #!/bin/bash @@ -55,13 +55,13 @@ For example, to pass the same ``simple_script.bash`` to vSphere: Create the ISO ----------------- -:: +.. sourcecode:: sh % mkdir my-iso NOTE: The file name on the ISO must be: ``user-data.txt`` -:: +.. sourcecode:: sh % cp simple_scirpt.bash my-iso/user-data.txt % genisoimage -o user-data.iso -r my-iso @@ -69,7 +69,7 @@ NOTE: The file name on the ISO must be: ``user-data.txt`` Verify the ISO ----------------- -:: +.. sourcecode:: sh % sudo mkdir /media/vsphere_iso % sudo mount -o loop JoeV_CI_02.iso /media/vsphere_iso diff --git a/doc/sources/configdrive/README.rst b/doc/sources/configdrive/README.rst index 48ff579d..8c40735f 100644 --- a/doc/sources/configdrive/README.rst +++ b/doc/sources/configdrive/README.rst @@ -46,7 +46,7 @@ The following criteria are required to as a config drive: formatted. Version 2 -~~~~~~~~~~~ +~~~~~~~~~ The following criteria are required to as a config drive: @@ -70,7 +70,7 @@ The following criteria are required to as a config drive: - meta-data.json (not mandatory) Keys and values -~~~~~~~~~~~ +~~~~~~~~~~~~~~~ Cloud-init's behavior can be modified by keys found in the meta.js (version 1 only) file in the following ways. |