almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity

Fix a couple typos in lorax-composer docs.

Browse Source 
The description of blueprint versions was wrong, now it is
correct.

(cherry picked from commit 9e41052992)
This commit is contained in:
Brian C. Lane 2018-06-29 14:15:54 -07:00
parent 914c33ef97
commit 6acbb0be0e
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/composer-cli.rst
View File

@ -27,7 +27,7 @@ blueprints save http-server``. If there are no blueprints available you can
copy one of the examples `from the test suite copy one of the examples `from the test suite
<https://github.com/weldr/lorax/tree/master/tests/pylorax/blueprints/>`_. <https://github.com/weldr/lorax/tree/master/tests/pylorax/blueprints/>`_.
Edit the file (it will be saved with a .toml extension) and chance the Edit the file (it will be saved with a .toml extension) and change the
description, add a package or module to it. Send it back to the server by description, add a package or module to it. Send it back to the server by
running ``composer-cli blueprints push http-server.toml``. You can verify that it was running ``composer-cli blueprints push http-server.toml``. You can verify that it was
saved by viewing the changelog - ``composer-cli blueprints changes http-server``. saved by viewing the changelog - ``composer-cli blueprints changes http-server``.

4
docs/lorax-composer.rst
View File

@ -120,7 +120,9 @@ when it is written to disk. It should be short and descriptive.
``version`` is a `semver compatible <https://semver.org/>`_ version number. If ``version`` is a `semver compatible <https://semver.org/>`_ version number. If
a new blueprint is uploaded with the same ``version`` the server will a new blueprint is uploaded with the same ``version`` the server will
automatically bump the PATCH level of the ``version``. If the ``version`` automatically bump the PATCH level of the ``version``. If the ``version``
doesn't match it will be used as is. eg. Uploading a blueprint with ``version`` set to ``0.0.1`` when the existing blueprint ``version`` is ``0.0.1`` will result in the new blueprint being stored as ``version 0.0.1``. doesn't match it will be used as is. eg. Uploading a blueprint with ``version``
set to ``0.1.0`` when the existing blueprint ``version`` is ``0.0.1`` will
result in the new blueprint being stored as ``version 0.1.0``.
[[packages]] and [[modules]] [[packages]] and [[modules]]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~