diff options
| author | Mark Esler <eslerm@umn.edu> | 2022-02-10 15:44:37 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-10 15:44:37 -0600 |
| commit | cbe840ac7247c9bf79cf63100b7f85ef38758763 (patch) | |
| tree | 5f48726760d9ac688004db0c39586edd154c52d4 /doc/rtd/topics/format.rst | |
| parent | 217ef6ba6c52788f4363b998b6da08863fea5cd9 (diff) | |
| download | vyos-cloud-init-cbe840ac7247c9bf79cf63100b7f85ef38758763.tar.gz vyos-cloud-init-cbe840ac7247c9bf79cf63100b7f85ef38758763.zip | |
minor improvements to documentation (#1259)
* Primarily improved grammar for clarity.
* A few Sphinx/RST syntax fixes.
* Set text width to 79 characters per footer documentation
where needed.
* Changed "yaml" to "YAML" when used in sentences.
Diffstat (limited to 'doc/rtd/topics/format.rst')
| -rw-r--r-- | doc/rtd/topics/format.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/rtd/topics/format.rst b/doc/rtd/topics/format.rst index 05580804..6d790b05 100644 --- a/doc/rtd/topics/format.rst +++ b/doc/rtd/topics/format.rst @@ -89,7 +89,7 @@ Include File This content is a ``include`` file. The file contains a list of urls, one per line. Each of the URLs will be read, -and their content will be passed through this same set of rules. Ie, the +and their content will be passed through this same set of rules. I.e., the content read from the URL can be gzipped, mime-multi-part, or plain text. If an error occurs reading a file the remaining files will not be read. @@ -112,7 +112,7 @@ These things include: - *and many more...* .. note:: - This file must be valid yaml syntax. + This file must be valid YAML syntax. See the :ref:`yaml_examples` section for a commented set of examples of supported cloud config formats. @@ -209,4 +209,4 @@ cloud-init from processing user-data. .. [#] See your cloud provider for applicable user-data size limitations... .. _blog: http://foss-boss.blogspot.com/2011/01/advanced-cloud-init-custom-handlers.html -.. vi: textwidth=78 +.. vi: textwidth=79 |