diff --git a/README.rst b/README.rst index 0399bd45..861331fd 100644 --- a/README.rst +++ b/README.rst @@ -65,7 +65,7 @@ MBS is able to perform local module builds by directing local Mock. MBS supports threaded Mock builds which utilizes performance and significantly speeds up local module builds. -_`Client tooling` +Client tooling ================= ``mbs-manager`` @@ -82,7 +82,7 @@ Client-side API The MBS implements a RESTful interface for module build submission and state querying. Not all REST methods are supported. See below for details. For client -tooling which utilizes the API, please refer to `Client tooling`_ section. +tooling which utilizes the API, please refer to "Client tooling" section above. Module build submission ----------------------- @@ -213,7 +213,7 @@ The response includes: - ``scmurl`` - the source control URL used to build the module. - ``state`` - the numerical state of the module build. - ``state_name`` - the named state of the module build. See the section called - `Module Build States`_ for more information. + "Module Build States" for more information. - ``state_reason`` - the reason why the module build is in this state. This is useful when the build fails. - ``stream`` - the module's stream. @@ -776,8 +776,8 @@ Possible response codes are for various requests include: implemented yet. - HTTP 503 Service Unavailable - The service is down, possibly for maintanance. -_`Module Build States` ----------------------- +Module Build States +------------------- You can see the list of possible states with:: @@ -855,7 +855,7 @@ The message body is a dictionary with these fields: ~~~~~~~~~ This is the current state of the module, corresponding with the states -described above in `Module Build States`_. +described above in "Module Build States". ``name``, ``version``, ``release`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -904,8 +904,7 @@ the following rules (all of them are evaluated from top to bottom): value, DevConfiguration is forced and ``config.py`` is used directly from the MBS's develop instance. For more information see |docs/CONTRIBUTING.rst|_. -.. |docs/CONTRIBUTING.rst| replace:: ``docs/CONTRIBUTING.rst`` -.. _docs/CONTRIBUTING.rst: docs/CONTRIBUTING.rst +.. substitutions for CONTRIBUTING defined above Setting Up Kerberos + LDAP Authentication @@ -934,10 +933,7 @@ For help on setting up a development environment, see |docs/CONTRIBUTING.rst|_. License ======= -MBS is licensed under MIT license. See |LICENSE|_ file for details. - -.. |LICENSE| replace:: ``LICENSE`` -.. _LICENSE: LICENSE +MBS is licensed under MIT license. See LICENSE file for details. Parts of MBS are licensed under 3-clause BSD license from: https://github.com/projectatomic/atomic-reactor/blob/master/LICENSE