leapp icon indicating copy to clipboard operation
leapp copied to clipboard

Intial documentation refactor

Open matejmatuska opened this issue 1 year ago • 3 comments

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

matejmatuska avatar Jul 30 '24 11:07 matejmatuska

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. If you want to request a review or rebuild a package in copr, you can use following commands as a comment:

  • review please @oamg/developers to notify leapp developers of the review request
  • /packit copr-build to submit a public copr build using packit

To launch regression testing public members of oamg organization can leave the following comment:

  • /rerun to schedule basic regression tests using this pr build and leapp-repository*master* as artifacts
  • /rerun 42 to schedule basic regression tests using this pr build and leapp-repository*PR42* as artifacts
  • /rerun-sst to schedule sst tests using this pr build and leapp-repository*master* as artifacts
  • /rerun-sst 42 to schedule sst tests using this pr build and leapp-repository*PR42* as artifacts

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.

github-actions[bot] avatar Jul 30 '24 11:07 github-actions[bot]

Rebased

matejmatuska avatar Sep 09 '24 11:09 matejmatuska

Comments addressed and I also rebased.

matejmatuska avatar Sep 11 '24 05:09 matejmatuska