Reduce doc bloat & prep work for remediation wizard #2968
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The idea is that users don't really need docs to examine compliance failures; they can explore the web UI for that. Their end goal is to _remediate_ those failures. And remediating involves examining the failures (but in less detail than originally documented).
|
The PR preview for 45f2ab6 is available at theforeman-foreman-documentation-preview-pr-2968.surge.sh The following output files are affected by this PR: |
asteflova
added
Needs style review
guides/common/modules/proc_remediating-compliance-failures.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Maximilian Kolb <[email protected]>
I didn't test the actual remediation scripts (TBH I think that's out of scope for documenting the procedures anyway), but I did make some changes to the web UI procedures as some steps were not entirely accurate. |
maximiliankolb
approved these changes
Apr 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
theforeman/foreman_openscap#546 will introduce an OpenSCAP compliance remediation wizard. This PR is something of a prerequisite before I submit a PR to document the wizard; if I get approval and merge for this PR, I'll revert fb5ab35 to add the steps to cover the wizard.
This PR introduces the following changes:
The logic behind removing examining and instead documenting remediation is that users don't need documentation to explain the components of a compliance report: if they want to examine a report, they are more likely to just open it in the web UI and, well, look at it. A more likely end goal for users is to be able to address compliance failures, and that involves steps to find and open the compliance reports.
Please cherry-pick my commits into: