Intial documentation refactor #878
Conversation
Thank you for contributing to the Leapp project!Please note that every PR needs to comply with the Leapp Guidelines and must pass all tests in order to be mergeable.
To launch regression testing public members of oamg organization can leave the following comment:
Please open ticket in case you experience technical problem with the CI. (RH internal only) Note: In case there are problems with tests not being triggered automatically on new PR/commit or pending for a long time, please consider rerunning the CI by commenting leapp-ci build (might require several comments). If the problem persists, contact leapp-infra. |
matejmatuska
force-pushed
the
refactor-docs
branch
2 times, most recently
from
c502d92
to
8468c87
Compare
matejmatuska
force-pushed
the
refactor-docs
branch
from
8468c87
to
a93e250
Compare
|
Rebased |
matejmatuska
force-pushed
the
refactor-docs
branch
from
318761b
to
849b217
Compare
An old local copy of the code of the extension was used instead of directly using the extension.
The the leapp-repository related (in el7toel8) are intentionally left out and therefore removed from the documentation.
The location in index.rst tree is also changed.
The python-coding-guidelines.md file is kept for now.
Previously it resided in tutorials, but it's more relevant here.
matejmatuska
force-pushed
the
refactor-docs
branch
from
d393179
to
a6d75a7
Compare
|
Comments addressed and I also rebased. |
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
| @source venv/bin/activate && \ | ||
| $(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
|
||
| livehtml: |
There was a problem hiding this comment.
| livehtml: | |
| livehtml: html |
this will automatically build html, so you do not need to think about it
The documentation is reorganized to adhere to the new hierarchy design and also drops the documentation related to oamg/leapp-repository and related direct references.
Note that some pages/sections might feel a little out of place or miss some content (most notably building-blocks-and-architecture and libraries-and-api), that's expected and these places will be filled in in future patches.
A few typo corrections are also included.
Depends on #854