AAP-62665 - Adding an important section and editing previous doc. #5580
Conversation
KylaF8
added
documentation
sayjadha
left a comment
sayjadha
left a comment
There was a problem hiding this comment.
Some minor suggestions, rest LGTM.
| . Under *Route TLS termination mechanism*, click the drop-down menu and select *Edge* or *Passthrough*. For most instances *Edge* should be selected. | ||
| . Under *Route TLS credential secret*, click the drop-down menu and select a secret from the list. | ||
| . Under *Enable persistence for __/var/lib/projects__ directory* select either true or false by moving the slider. | ||
| . Navigate to *Operators → Installed Operators*. |
There was a problem hiding this comment.
For menu UI labels, consider changing it to menu:View[Operators > Installed Operators].
There was a problem hiding this comment.
Hey Kyla, you can use "menu:Operators[Installed Operators]"
| . Select your *{OperatorPlatformNameShort}* deployment. | ||
| . Select the *{ControllerNameStart}* tab. | ||
| . Create or edit an instance: | ||
| .. For new instances, click *Create {ControllerNameStart}*. |
There was a problem hiding this comment.
The steps 'for new instances' and 'for existing instances' seem to be options and the user needs to select one of these. If this is correct, consider changing the sub-numbered list to bulleted list.
There was a problem hiding this comment.
So I'd argue here it's an either or option, where order is not significant.
If you used a nested numbered list it means do step a. first then do step b. While an unordered list here dictates the order is not important so choose the most correct option for you
| . In the *Route DNS host* field, enter the common host name the route answers to. | ||
| . In the *Route TLS termination mechanism* list, select *Edge* or *Passthrough*. Edge is recommended for most instances. | ||
| . In the *Route TLS credential secret* list, select a secret. | ||
| . Use the slider to enable or disable persistence for the `/var/lib/projects` directory. |
There was a problem hiding this comment.
Question: Is this a toggle switch or a checkbox?
There was a problem hiding this comment.
Toggle is the most appropriate wording here that will be uniform across OCP docs.
3 participants
AAP-62665