Update git submodules
* Update docs/submodules/oom.git from branch 'master'
to 17804e20a22090d3c0b2333528dd6f0ca7809567
- Merge changes Ib8075c25,Iaab4b3be,I0ffd7892,I51e7f8f2,I9634797c
* changes:
docs: Mark filenames and inline code
docs: Use definition list syntax to clarify terms
docs: Enclose all snippets in code blocks
docs: Ensure literalinclude directive rendering
docs: Replace include directives for non existent file
- docs: Mark filenames and inline code
To improve readability and avoid confusion, this patch makes:
* all path names and package names - italics,
* all snippets as well as command names and arguments - fixed length.
Issue-ID: OOM-2207
Change-Id: Ib8075c25cb0479e56e3f7634639eb4d7556b36c7
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
- docs: Use definition list syntax to clarify terms
Definition list syntax quick reference:
http://docutils.sourceforge.net/docs/user/rst/quickref.html#definition-lists
Issue-ID: OOM-2208
Change-Id: Iaab4b3befd92288813a70d4e1bac8c4c7bb6e4c6
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
- docs: Enclose all snippets in code blocks
This patch improves documentation readability by making all runnable
code snippets stand out.
Issue-ID: OOM-2207
Change-Id: I0ffd7892a6c3af4d91f5bdd9adb49c1e01a9c475
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
- docs: Ensure literalinclude directive rendering
Literalinclude directive is not rendered as such unless separated from
the surrounding paragraphs by blank lines (like all paragraphs) [1].
[1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
Issue-ID: OOM-1612
Change-Id: I51e7f8f2f99dfe157b24fe7c5ae4d62281d72e86
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
- docs: Replace include directives for non existent file
This patch resolves issue with including non existent file in OOM
documentation. Included file has been removed in [1] and seems to be
replaced by "kubernetes/onap/values.yaml" from [2] (91% similarity [3]).
[1] ed5ff714fac29651318868a65267030e3c31c3ee (Change-Id: Ia51db5f1489e8d63fd7e1f10e80174eb9f182f0f)
[2] ac281bd0798ae7308402f4d19d537546d101afba (Change-Id: I4b74a3a8a35a178298af7205762e2aca7c65dda3)
[3] Similarity measured with:
$ git checkout ed5ff714^
$ wdiff --no-deleted --no-inserted --no-common --statistics \
kubernetes/onap/values.yaml docs/onap_values.yaml
Issue-ID: OOM-2203
Change-Id: I9634797c75f4da4652194f72190b21e30c4feb21
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
1 file changed