openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

Clean up web terminal docs

Browse Source
This commit is contained in:
Ashleigh Brennan
2023-05-08 12:06:55 -05:00
committed by openshift-cherrypick-robot
parent e37f10a423
commit 12c4c9173d
8 changed files with 35 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
web_console/odc-about-web-terminal.adoc → web_console/odc-using-web-terminal.adoc
View File

@@ -1,23 +1,18 @@
:_content-type: ASSEMBLY
[id="odc-about-web-terminal"]
= About the web terminal in the web console
[id="odc-using-web-terminal"]
= Using the web terminal
include::_attributes/common-attributes.adoc[]
:context: odc-about-web-terminal
:context: odc-using-web-terminal
toc::[]
You can launch an embedded command line terminal instance in the web console. You must first install the Web Terminal Operator to use the web terminal.
[NOTE]
====
Cluster administrators can access the web terminal in {product-title} 4.7 and later.
====
You can launch an embedded command line terminal instance in the web console. You must first install the {web-terminal-op} to use the web terminal.
This terminal instance is preinstalled with common CLI tools for interacting with the cluster, such as `oc`, `kubectl`,`odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx`. It also has the context of the project you are working on and automatically logs you in using your credentials.
:FeatureName: Web terminal
include::modules/odc-installing-web-terminal.adoc[leveloffset=+1]
include::modules/odc-using-web-terminal.adoc[leveloffset=+1]
include::modules/odc-access-web-terminal.adoc[leveloffset=+1]
include::modules/odc-uninstalling-web-terminal.adoc[leveloffset=+1]

9
web_console/web-console-overview.adoc
View File

@@ -11,13 +11,6 @@ The Red Hat {product-title} web console provides a graphical user interface to v
Both *Administrator* and *Developer* perspectives enable you to create quick start tutorials for {product-title}. A quick start is a guided tutorial with user tasks and is useful for getting oriented with an application, Operator, or other product offering.
include::modules/about-administrator-perspective.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
See xref:../web_console/odc-about-web-terminal.adoc#odc-about-web-terminal[About the web terminal in the web console] for more information on the web terminal Operator.
include::modules/about-developer-perspective.adoc[leveloffset=+1]
include::modules/odc-accessing-perspectives.adoc[leveloffset=+1]
@@ -31,6 +24,6 @@ include::modules/odc-accessing-perspectives.adoc[leveloffset=+1]
* xref:../web_console/using-dashboard-to-get-cluster-information.adoc#using-dashboard-to-get-cluster-info[Viewing cluster information]
* xref:../web_console/configuring-web-console.adoc#configuring-web-console[Configuring the web console]
* xref:../web_console/customizing-the-web-console.adoc#customizing-web-console[Customizing the web console]
* xref:../web_console/odc-about-web-terminal.adoc#odc-about-web-terminal[Launching an embedded command line terminal instance in the web console]
* xref:../web_console/odc-using-web-terminal.adoc#odc-using-web-terminal[Using the web terminal]
* xref:../web_console/creating-quick-start-tutorials.adoc#creating-quick-start-tutorials[Creating quick start tutorials]
* xref:../web_console/disabling-web-console.adoc#disabling-web-console[Disabling the web console]