Bug 2112004
| Summary: | [RFE] Openscap documentation | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Kenny Tordeurs <ktordeur> |
| Component: | Documentation | Assignee: | Zuzana Lena Ansorgova <zuansorg> |
| Documentation sub component: | default | QA Contact: | |
| Status: | RELEASE_PENDING --- | Docs Contact: | |
| Severity: | medium | ||
| Priority: | medium | CC: | ddf-bot, egolov, janarula, mjivraja, zuansorg |
| Version: | 6.11.1 | Keywords: | Documentation, FutureFeature |
| Target Milestone: | Unspecified | ||
| Target Release: | Unused | ||
| Hardware: | x86_64 | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | Type: | Bug | |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Kenny Tordeurs
2022-07-28 15:20:34 UTC
A BZ with multiple requests in it is not really actionable :( I see the following asks: > Adding "rubygem-foreman_scap_client" to the list of packages provided by the "Client" repo as done for k-agent and others in https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_connected_network_environment/index#Enabling_the_Client_Repository_satellite I think this is a bad idea, that means that the docs need to play catch-up all the time we add things there (like we now did for 6.12 with the mqtt framework, or the fact that puppet is really "puppet-agent"). Instead I'd reword that to something like "The Satellite Client 6 repository provides various packages responsible for integration of clients registered to Satellite Server." > Adding an OpenSCAP section to https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/managing_hosts/index This sounds like a good idea, but will certainly require some work, as there is currently zero content about OpenSCAP in that document. On the other hand, there is https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Configuring_a_Host_for_OpenSCAP_admin which talks about all that, but it's in the Admin guide, not Host guide, which people could find confusing (as that's a thing you do on hosts at the end) > Adding Ansible instructions to https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Configuring_a_Host_for_OpenSCAP_admin Again, good idea, and can be achieved today with a rather simple extension of the docs that will yield big gains. Personally, I'd start with the last point. Then clean up the "client repo contents" (first point) and then start thinking whether re-shuffling content is a good idea or not (second point). Hey Evgeni \o, I just captured all the hurdles I saw and wanted to be sure we capture them all to try and improve them. Feel free to address whatever is possible and we can of course split this off into multiple BZ's that's not an issue. Thanks Btw, there's also https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Managing_Security_Compliance_admin Perhaps it should be reviewed as well and maybe the two chapters should be merged? *** Bug 2177292 has been marked as a duplicate of this bug. *** *** Bug 1928849 has been marked as a duplicate of this bug. *** First PR of multiple: https://github.com/theforeman/foreman-documentation/pull/2173 This will be published with the planned Satellite 6.14 GA. |