Add documentation for operator features and security hardening#455
Conversation
9264978 to
336ffee
Compare
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Thank you for the work you put into this, this PR is much needed!
Saying that, I have left a lot of comments asking for changes. Overall, it is all about the same thing: please make it more compact. I don't think users want to read through sentences that are giving them no new information. I think the documentation should go straight to the point while having the most needed information :D
The change tackles the right things, however it could use some polishing to match the old style of the documentation and some sections moved to a different place.
65c0d36 to
4660e80
Compare
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Thank you for your changes :D The structure is better now, but I left more comments to further reduce a bit of clutter. I hope my comments make sense, but if you are unsure, please let me know!
f3e5ea3 to
c2b18a9
Compare
|
Build failed (check pipeline). Post ✔️ openstack-k8s-operators-content-provider SUCCESS in 1h 20m 39s |
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Thank you for the PR! The overall content is a lot better, you applied the changes I asked for correctly 😊 For my review now, I focused more on specific parts of the text where I think small improvements are needed. So I think the update should be hopefully simple this time around. Thanks for your patience, I think we are really close to reaching an agreement!
7200481 to
26d7594
Compare
aeeaf25 to
5707612
Compare
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Lgtm. The change is really well put together and helps to cover more test-operator features in the documentation.
|
Build failed (check pipeline). Post ✔️ openstack-k8s-operators-content-provider SUCCESS in 1h 03m 35s |
|
recheck |
Document configurable OpenStack config, network attachments, nodeSelector/tolerations, security hardening, privileged mode capabilities, image creation timeout, and tempest cleanup in crds.rst. Add ServiceConfigReady condition diagnostics to guide.rst.
5707612 to
8bd31c0
Compare
|
Lgtm. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: belolipa, kstrenkova, posikoya The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
7c35f5c
into
openstack-k8s-operators:main
3 participants
Document configurable OpenStack config, network attachments, nodeSelector/tolerations, security hardening, privileged mode capabilities, image creation timeout, and tempest cleanup in crds.rst. Add ServiceConfigReady condition diagnostics to guide.rst.
To run docs:
./docs/build-docs.shsphinx-autobuild docs/source docs/build/html