Rework CI documentation into docs site - CI - Fedora mailing-lists

8 Dec 2018


      Hi, all,
tl;dr
-------------
We created a repo for Fedora CI documentation.
It is easy to contribute. Please join :)
-------------
Currently we have a lot of CI related information in Fedora wiki. While
wiki provides easy way to edit things, there are certain downsides of
storing data there.
There is no clear structure, so it is hard to navigate and differentiate
docs targeting users from docs describing certain implementation details.
It is not flexible in terms of media formats. There is no way to propose
and review changes. No issue tracker and so on.
Fortunately, Fedora Docs team has solution for that - Fedora Docs site.
Fedora Docs site has modular structure, so we can add CI documentation as a
component to it. It uses Asciidoc format which is relatively easy and
widely adopted.
So me and Petr (psss) stepped forward and created a repository on pagure
called fedora-ci/docs [1]
I've configured initial template and placeholder pages based on template
provided by Fedora Docs team, so it is ready to go: we don't need to dig
into any Antora internals, only to write articles in the asciidoc format.
Also I've created the issue [2] with the list of wiki pages related to CI
topics.
How you can help (choose one or more):
0) join the conversation about high level structure [3],
1) check that I haven't missed certain pieces of information worth
migrating, see [2],
2) review current list of wiki pages in [2], if there is smth outdated,
which shouldn't be migrated at all,
3) take one of the pages in [2], transform to asciidoc (rework if needed)
and send a pull request to fedora-ci/docs repo,
3) add new article,
4) proof-read articles, added by others.
[1] https://pagure.io/fedora-ci/docs
[2] https://pagure.io/fedora-ci/docs/issue/1
[3] https://pagure.io/fedora-ci/docs/issue/2
-- 
Aleksandra Fedorova
bookwar