modules/fm-orchestrator
1
0
Fork 0
mirror of https://pagure.io/fm-orchestrator.git synced 2026-04-14 20:00:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

PR#1710: Fix docs rendering

Browse Source 
Merges #1710
https://pagure.io/fm-orchestrator/pull-request/1710

Fixes: #1669
https://pagure.io/fm-orchestrator/issue/1669
render README in Pagure
This commit is contained in:
Mike McLean
2021-06-10 14:02:24 -04:00
parent a92321b9c6 9a0e8e3db4
commit 7522cc1fb2
2 changed files with 33 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CONTRIBUTING.rst
View File

@@ -14,7 +14,7 @@ can be used to run the code analysis and unit tests.
* ``docker/Dockerfile-tests-py3`` is based on ``fedora:29``, inside which tests
run with Python 3.
Both of these images are available from Quay.io under `factory2 organization`_
Both of these images are available from Quay.io under the `factory2`_ organization
and named ``mbs-test-centos`` and ``mbs-test-fedora`` individually. Refer to
section "Updating test images in Quay" to learn how to manage these images.

63
docs/STATIC_CONTEXTS.rst
View File

@@ -23,42 +23,43 @@ the contexts, streams, and dependencies, which MBS uses to bypass MSE.
optionally set context specific ``requires`` and ``buildrequires`` values.
- The context definition needs to be defined in the initial modulemd yaml file. ``configurations``
build property overrides any dependencies set through the ``dependencies`` property.
- `static contexts` and `stream expansion` are mutually exclusive i. e. the streams defined in
``buildrequires`` and ``requires`` of `static context` will not be expanded and need
to be precisely defined by the user. (You can not use `stream expansion` notation as ``[]``
- *static contexts* and *stream expansion* are mutually exclusive i. e. the streams defined in
``buildrequires`` and ``requires`` of *static context* will not be expanded and need
to be precisely defined by the user. (You can not use *stream expansion* notation as ``[]``
or ``-f28`` as this will result in an error)
**Example**
::
document: modulemd-packager
version: 3
.
.
.
configurations:
- context: context1
platform: f28
buildrequires:
module1: stream1
document: modulemd-packager
version: 3
.
.
.
configurations:
- context: context1
platform: f28
buildrequires:
module1: stream1
.
.
.
moduleN: streamN
requires:
module1: stream1
.
.
.
moduleN: streamN
- context: context2
platform: f29
requires:
module1: stream1
.
.
.
moduleN: streamN
requires:
module1: stream1
.
.
.
moduleN: streamN
- context: context2
platform: f29
requires:
module1: stream1
.
.
.
**ModuleStreamV2 Method**
@@ -69,11 +70,11 @@ version: 3
you need to define ``contexts`` dict inside ``mbs_options`` property.
- The context definition needs to be defined in the initial modulemd yaml file. ``contexts``
build property overrides any dependencies set through the ``dependencies`` property.
- `static contexts` and `stream expansion` are mutually exclusive i. e. the streams defined in
``buildrequires`` and ``requires`` of `static context` will not be expanded and need
to be precisely defined by the user. (You can not use `stream expansion` notation as ``[]``
- *static contexts* and *stream expansion* are mutually exclusive i. e. the streams defined in
``buildrequires`` and ``requires`` of *static context* will not be expanded and need
to be precisely defined by the user. (You can not use *stream expansion* notation as ``[]``
or ``-f28`` as this will result in an error)
- `static contexts` only override ``context`` of a module stream i. e. the one which
- *static contexts* only override ``context`` of a module stream i. e. the one which
is the part of the module streams NSVC. ``build context`` is still calculated and preserved
in the resulting build in ``mbs`` property in ``xmd`` so the reuse of builds with the
same ``build contexts`` takes place.