54 lines
1.7 KiB
Text
54 lines
1.7 KiB
Text
== Update RelEng Rendered Docs
|
|
|
|
=== Description
|
|
|
|
When an improvement happens to the Release Engineering documentation
|
|
following the `contributing <contributing>` for the
|
|
http://sphinx-doc.org/[Sphinx]
|
|
https://en.wikipedia.org/wiki/ReStructuredText[reStructured Text] source
|
|
found in `docs/source` within the https://pagure.io/releng[RelEng git
|
|
repository] someone has to manually perform a process in order to update
|
|
the documentation that is hosted in the https://pagure.io/pagure[pagure]
|
|
documentation space for https://docs.pagure.org/releng/[Fedora RelEng
|
|
docs].
|
|
|
|
=== Action
|
|
|
|
In order to render the documentation using
|
|
http://sphinx-doc.org/[Sphinx], you need to first be sure to have the
|
|
package installed:
|
|
|
|
....
|
|
$ dnf install python-sphinx
|
|
....
|
|
|
|
Then we'll need to clone the RelEng repository and the RelEng docs
|
|
repository (the docs git repository is provided by pagure
|
|
automatically). There is a script in the [.title-ref]#releng# repository
|
|
that takes care of cleanly updating the documentation site for us.
|
|
|
|
....
|
|
$ ./scripts/update-docs.sh
|
|
....
|
|
|
|
The documentation is now live.
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
This will require someone with permissions to push to the rawhide branch
|
|
for the releng repository. If you are curious whom all has this ability,
|
|
please refer to the `Main Page <index>` and contact someone from the
|
|
"Team Composition"
|
|
====
|
|
|
|
=== Verification
|
|
|
|
Visit the https://docs.pagure.org/releng/[Fedora RelEng docs] website
|
|
and verify that the changes are reflected live on the docs site.
|
|
|
|
=== Consider Before Running
|
|
|
|
No considerations at this time. The docs git repository is simply a
|
|
static html hosting space and we can just re-render the docs and push to
|
|
it again if necessary.
|