Skip to content

Web terminal docs#28480

Merged
jeana-redhat merged 1 commit intoopenshift:masterfrom
Preeticp:WTO
Jan 28, 2021
Merged

Web terminal docs#28480
jeana-redhat merged 1 commit intoopenshift:masterfrom
Preeticp:WTO

Conversation

@Preeticp
Copy link
Contributor

@Preeticp Preeticp commented Jan 10, 2021

This PR adds docs for web terminal in Web Console.
This PR applies to 4.5, 4.6, and 4.7
Preview here: https://wto--ocpdocs.netlify.app/openshift-enterprise/latest/web_console/odc-about-web-terminal.html

@openshift-ci-robot openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 10, 2021
@openshift-docs-preview-bot

The preview will be available shortly at:

@Preeticp
Copy link
Contributor Author

Preeticp commented Jan 10, 2021

@gajanan-more, @sleshchenko @abhinandan13jan @sahil143 can you please review this PR. Thank you.
The preview for it is available here: https://wto--ocpdocs.netlify.app/openshift-enterprise/latest/web_console/odc-about-web-terminal.html

@Preeticp
Copy link
Contributor Author

Preeticp commented Jan 17, 2021

@gajanan-more, @sleshchenko, @JPinkney I have made changes as per the review comments. PTAL and let me know if any other changes are required. If no further changes are required, request you to add a LGTM. Thank you!

Copy link

@JPinkney JPinkney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few minor comments

@Preeticp Preeticp changed the title [WIP] Web terminal docs Web terminal docs Jan 22, 2021
@openshift-ci-robot openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 22, 2021
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few suggestions, please reach out with any questions. Overall looking great!

@jeana-redhat jeana-redhat added the peer-review-done Signifies that the peer review team has reviewed this PR label Jan 22, 2021
@netlify
Copy link

netlify bot commented Jan 27, 2021

Deploy preview for osdocs ready!

Built with commit a04cc64

https://deploy-preview-28480--osdocs.netlify.app

@Preeticp
Copy link
Contributor Author

@jeana-redhat thank you for the review!!
I have fixed all the comments except for the one wrt the 'masthead' suggestion. So far I have not seen the word used in the OCP docs, neither do I find it in the IBM style guide. I see it being used in this PR, though: https://github.com/openshift/openshift-docs/pull/28577/files#diff-7eb7eb2ece30f224e5f35faa147a712c19030fd4e9cebea0e4da5f5bf07a4b4fR156
But on the other hand see this comment here asking the word to be removed: #17796 (comment)
How about header/menu bar instead? I do see that in the IBM style guide. Probably something to be discussed in the channel/team meeting?

Another thing worth discussing is (though I have made the change) usage of this symbol for navigation between menus: '->'
I wonder why we deviate from the ISG recommendation on this. As per the Menus and Navigation section, on Pg 229 in the latest version of the IBM guide:
"To separate menu choices, use the symbol that your authoring tool proves. If a symbol is not
provided, use the greater than symbol (>), and insert a space on each side of the symbol."
Using > this might avoid the confusion over -> or any other interpretation of the same. WDYT?

Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new output uncovered a couple command lines that were missing their $ prompt. Otherwise looks great! Lmk when you have those done and re-squashed and I can help get it published 👍

removed bold from heading

review edits

review edits 2

image tag edit

review edits first part

review edits 2

minor fix

review fix 3
@jeana-redhat
Copy link
Contributor

jeana-redhat commented Jan 27, 2021

Hey Preeti, I totally missed this comment - sorry! Wasn't ignoring your questions on purpose.

@jeana-redhat thank you for the review!!
I have fixed all the comments except for the one wrt the 'masthead' suggestion. So far I have not seen the word used in the OCP docs, neither do I find it in the IBM style guide. I see it being used in this PR, though: https://github.com/openshift/openshift-docs/pull/28577/files#diff-7eb7eb2ece30f224e5f35faa147a712c19030fd4e9cebea0e4da5f5bf07a4b4fR156
But on the other hand see this comment here asking the word to be removed: #17796 (comment)
How about header/menu bar instead? I do see that in the IBM style guide. Probably something to be discussed in the channel/team meeting?

I landed on masthead after chatting a bit with @ahardin-rh, and finding it used in docs here. "Header" is not used in this sense in the docs, but I see where you found it in the IBM style guide (p. 233, "Select an action from the menu bar on the header." - good find!). So maybe "the menu bar on the header" is what we should use in general. @ahardin-rh - thoughts? Do we need to bring this up or just go ahead and defer to the ISG here and maybe update that instance of masthead?

Another thing worth discussing is (though I have made the change) usage of this symbol for navigation between menus: '->'
I wonder why we deviate from the ISG recommendation on this. As per the Menus and Navigation section, on Pg 229 in the latest version of the IBM guide:
"To separate menu choices, use the symbol that your authoring tool proves. If a symbol is not
provided, use the greater than symbol (>), and insert a space on each side of the symbol."
Using > this might avoid the confusion over -> or any other interpretation of the same. WDYT?

I can't speak to the history of this decision, but I do know that using -> properly renders the arrow symbol in the output. I don't know what would happen if > were used instead. Example: on this page, that navigation instruction is *Home* -> *Dashboards* -> *Overview* in the raw text of the file.

@Preeticp
Copy link
Contributor Author

No worries, Jeana.
Wrt 'masthead' I know our UX team refers to it as such, but have not heard it being used extensively otherwise. Would love to hear what @ahardin-rh thinks.
Wrt using >, it renders as is. It does not render an arrow symbol. But ISG recommends >. On the other hand, it would be a huge exercise to update it in all versions with little to gain. Probably that's why it's been ignored. I am not sure about the history either :)

@jeana-redhat
Copy link
Contributor

jeana-redhat commented Jan 28, 2021

/cherrypick enterprise-4.7

@jeana-redhat
Copy link
Contributor

jeana-redhat commented Jan 28, 2021

/cherrypick enterprise-4.6

@jeana-redhat
Copy link
Contributor

jeana-redhat commented Jan 28, 2021

/cherrypick enterprise-4.5

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Jan 28, 2021

@jeana-redhat: new pull request created: #28911

Details

In response to this:

/cherrypick enterprise-4.7

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 kubernetes/test-infra repository.

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Jan 28, 2021

@jeana-redhat: new pull request created: #28912

Details

In response to this:

/cherrypick enterprise-4.6

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 kubernetes/test-infra repository.

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Jan 28, 2021

@jeana-redhat: new pull request created: #28913

Details

In response to this:

/cherrypick enterprise-4.5

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 kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.5 branch/enterprise-4.6 branch/enterprise-4.7 peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants