Reduce operator guide heading levels#47345
Conversation
ahus1
left a comment
There was a problem hiding this comment.
Hello Andrew,
thank you for preparing these changes. I'd some of the changes are or ok, while some need IMHO more discussions.
Could we restrict this PR to just changing removing the surplus headings and adjusting the level of the subheadings for now?
Best,
Alexander
| ==== Additional options | ||
|
|
||
| Additional options:: | ||
| + |
There was a problem hiding this comment.
I'd like to dispute of changing a third-level heading with a definition list for the sake of downstream docs generation. Please discuss alternatives to this approach.
There was a problem hiding this comment.
Yes, I have an alternative that I will try. Thanks.
| == Advanced configuration | ||
| This {section} describes how to use Custom Resources (CRs) for advanced configuration of your {project_name} deployment. | ||
|
|
||
| === Server configuration details | ||
| == Server configuration details |
There was a problem hiding this comment.
I'm ok with the change to remove the top level heading and change the level of any included sub-heading.
| kubectl apply -f example-postgres.yaml | ||
| ---- | ||
|
|
||
| ==== Hostname |
There was a problem hiding this comment.
This section was removed, this seems to be done by mistake. Please check.
There was a problem hiding this comment.
Thanks, reinstated. Using the description list for now, but I will try a different approach.
f6fbfbc to
5c41cd7
Compare
Closes keycloak#47340 Signed-off-by: AndyMunro <amunro@redhat.com>
Closes #47340