Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues in the structuring of cleanup-related documentation #5139

Merged
merged 1 commit into from May 16, 2023

Conversation

Martchus
Copy link
Contributor

  • Fix target of link "cleanup-related properties"; the anchor has been renamed to basic_cleanup at some point
  • Reduce the "Cleanup" section in the installation guide so it only mentions the most important points and otherwise just directs the user to the "Cleanup …" section in the users guide which some information was moved to. This way the cleanup is still mentioned as configuration step for new installations but does not duplicate information already present elsewhere.
  • Rename the "Asset cleanup" section in the users guide to just "Cleanup" and move it out of "Asset handling". This makes more sense because this section is not covering only asset cleanup.
  • Remove the reference to "Use of the REST API" as this section doesn't contain related information anymore and is also not under the "Asset handling" section anymore (as it was stated).
  • Related ticket: https://progress.opensuse.org/issues/129412

* Fix target of link "cleanup-related properties"; the anchor
  has been renamed to `basic_cleanup` at some point
* Reduce the "Cleanup" section in the installation guide so it
  only mentions the most important points and otherwise just
  directs the user to the "Cleanup …" section in the users guide
  which some information was moved to. This way the cleanup is
  still mentioned as configuration step for new installations
  but does not duplicate information already present elsewhere.
* Rename the "Asset cleanup" section in the users guide to just
  "Cleanup" and move it out of "Asset handling". This makes more
  sense because this section is not covering *only* asset
  cleanup.
* Remove the reference to "Use of the REST API" as this section
  doesn't contain related information anymore and is also not
  under the "Asset handling" section anymore (as it was stated).
* Related ticket: https://progress.opensuse.org/issues/129412
@github-actions
Copy link

github-actions bot commented May 16, 2023

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

  • Consider generating documentation locally to verify it is rendered correctly using tools/generate-htmldoc

This is an automatically generated QA checklist based on modified files.

@mergify mergify bot merged commit bbf3ceb into os-autoinst:master May 16, 2023
36 checks passed
@Martchus Martchus deleted the groupless-cleanup branch May 16, 2023 14:57
os-autoinst-bot pushed a commit to os-autoinst-bot/openQA that referenced this pull request May 17, 2023
commit bbf3ceb
Merge: 13cd331 cf80b5b
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Tue May 16 14:43:44 2023 +0000
Commit:     GitHub <noreply@github.com>
CommitDate: Tue May 16 14:43:44 2023 +0000

    Merge pull request os-autoinst#5139 from Martchus/groupless-cleanup

    Fix issues in the structuring of cleanup-related documentation
os-autoinst-bot pushed a commit to os-autoinst-bot/openQA that referenced this pull request May 18, 2023
commit bbf3ceb
Merge: 13cd331 cf80b5b
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Tue May 16 14:43:44 2023 +0000
Commit:     GitHub <noreply@github.com>
CommitDate: Tue May 16 14:43:44 2023 +0000

    Merge pull request os-autoinst#5139 from Martchus/groupless-cleanup

    Fix issues in the structuring of cleanup-related documentation
os-autoinst-bot pushed a commit to os-autoinst-bot/openQA that referenced this pull request May 19, 2023
commit bbf3ceb
Merge: 13cd331 cf80b5b
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Tue May 16 14:43:44 2023 +0000
Commit:     GitHub <noreply@github.com>
CommitDate: Tue May 16 14:43:44 2023 +0000

    Merge pull request os-autoinst#5139 from Martchus/groupless-cleanup

    Fix issues in the structuring of cleanup-related documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants