OSDOCS-16567: Updated Web Console for DITA migration #104179
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@EricPonvelle: This pull request references OSDOCS-16567 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/L
|
🤖 Fri Dec 19 16:21:48 - Prow CI generated the docs preview: |
EricPonvelle
force-pushed
the
OSDOCS-16567_Web-Console
branch
from
a97cedc to
0ffe29e
Compare
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
@EricPonvelle: This pull request references OSDOCS-16567 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
EricPonvelle
force-pushed
the
OSDOCS-16567_Web-Console
branch
3 times, most recently
from
cfcd79f to
3b85138
Compare
| [id="about-administrator-perspective_{context}"] | ||
| = Administrator role in the web console | ||
|
|
||
| [role="_abstract"] |
There was a problem hiding this comment.
I am under the impression that we are supposed to write "proper" short descriptions, rather than simply slap a [role="_abstract"] tag on. Is there a plan to vet these abstracts to make sure they meet the guidelines? (Not saying they don't.)
For example, in the following, the ISG says of enables: Avoid stating that inanimate objects grant abilities to people, as in “the product enables you to…”.
There was a problem hiding this comment.
@mburke5678 ya, we are going to do that part of the CQA process in January. This pass was to correct the broader, syntax errors that Vale flags.
| .Example | ||
| **Example** |
There was a problem hiding this comment.
Not sure why this change.
I don't know all the new rules. Are we not allowed to use .Example?
There was a problem hiding this comment.
Ya, it flags all "Block titles". This may be a changing rule, but for the sake of my task, I just rolled it to bolded.
There was a problem hiding this comment.
Ah. Block titles can be used only in procedures? Is that right? Too many new rules!
| where: | ||
| `managementState: Removed`:: Set the `managementState` parameter value to `Removed` to disable the web console. The other valid values for this parameter are `Managed`, which enables the console under the cluster's control, and `Unmanaged`, which means that you are taking control of web console management. |
There was a problem hiding this comment.
Add full parameter.
| where: | |
| `managementState: Removed`:: Set the `managementState` parameter value to `Removed` to disable the web console. The other valid values for this parameter are `Managed`, which enables the console under the cluster's control, and `Unmanaged`, which means that you are taking control of web console management. | |
| where: | |
| `spec.managementState.Removed`:: Set the `managementState` parameter value to `Removed` to disable the web console. The other valid values for this parameter are `Managed`, which enables the console under the cluster's control, and `Unmanaged`, which means that you are taking control of web console management. |
| * xref:../operators/understanding/olm-understanding-software-catalog.adoc#olm-understanding-software-catalog[Understanding the software catalog] | ||
| * xref:../web_console/web_terminal/installing-web-terminal.adoc#installing-web-terminal[Installing the web terminal] | ||
| * link:https://docs.redhat.com/en/documentation/red_hat_openshift_lightspeed/1.0tp1/html/about/ols-about-openshift-lightspeed#ols-openshift-lightspeed-overview[{ols} overview] | ||
| * link:https://docs.redhat.com/en/documentation/red_hat_openshift_lightspeed/1.0tp1/html/install/ols-installing-lightspeed[Installing {ols}] | ||
| * link:https://docs.openshift.com/pipelines/1.14/create/working-with-pipelines-web-console.html[Working with {pipelines-title} in the web console] | ||
| * link:https://docs.openshift.com/pipelines/1.14/create/working-with-pipelines-web-console.html#op-console-statistics_working-with-pipelines-web-console[Pipeline execution statistics in the web console] | ||
| * link:https://access.redhat.com/documentation/en-us/red_hat_openshift_serverless/1.31/html/installing_serverless/install-serverless-operator#serverless-install-web-console_install-serverless-operator[Installing the {ServerlessProductName} Operator from the web console] |
There was a problem hiding this comment.
Are we allowed only one Additional References per assembly?
There was a problem hiding this comment.
There's a warning that flagged separated Additional Resources. This may be a malleable rule.
EricPonvelle
force-pushed
the
OSDOCS-16567_Web-Console
branch
from
3b85138 to
af3af32
Compare
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
There was a problem hiding this comment.
🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.
|
@EricPonvelle: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
@EricPonvelle: This pull request references OSDOCS-16567 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
A few comments, for what they are worth. Otherwise LGTM! |
5 participants
Version(s):
enterprise-4.20+Issue:
OSDOCS-16567
Link to docs preview:
QE review:
Additional information:
Updated the Web Console book for ROSA, ROSA Classic, and Dedicated to meet DITA compliance.