diff --git a/modules/configure-web-terminal-image-admin.adoc b/modules/configure-web-terminal-image-admin.adoc index 83993b0b321b..af28c91213ec 100644 --- a/modules/configure-web-terminal-image-admin.adoc +++ b/modules/configure-web-terminal-image-admin.adoc @@ -7,6 +7,7 @@ [id="configure-web-terminal-image-admin_{context}"] = Configuring the web terminal image for all users +[role="_abstract"] You can use the *Administrator* perspective of the web console to set the default web terminal image for all users. .Prerequisites @@ -14,8 +15,15 @@ You can use the *Administrator* perspective of the web console to set the defaul * You have cluster administrator permissions and are logged in to the web console. * You have installed the {web-terminal-op}. -include::snippets/access-cluster-configuration-console.adoc[] +.Procedure +. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings*. +. On the *Cluster Settings* page, click the *Configuration* tab. +. On the *Configuration* page, click the *Console* configuration resource with the description *operator.openshift.io*. ++ +image::cluster-settings-console.png[Image of the Configuration page showing the correct Console configuration resource to select] + +. From the *Action* drop-down list, select *Customize*, which opens the *Cluster configuration* page. . Click the *Web Terminal* tab, which opens the *Web Terminal Configuration* page. . Enter the URL of the image that you want to use. . Click *Save*. \ No newline at end of file diff --git a/modules/configure-web-terminal-timeout-admin.adoc b/modules/configure-web-terminal-timeout-admin.adoc index 5edc4128b2c7..af3893881b2f 100644 --- a/modules/configure-web-terminal-timeout-admin.adoc +++ b/modules/configure-web-terminal-timeout-admin.adoc @@ -7,6 +7,7 @@ [id="configure-web-terminal-timeout-admin_{context}"] = Configuring the web terminal timeout for all users +[role="_abstract"] You can use the *Administrator* perspective of the web console to set the default web terminal timeout period for all users. .Prerequisites @@ -14,8 +15,15 @@ You can use the *Administrator* perspective of the web console to set the defaul * You have cluster administrator permissions and are logged in to the web console. * You have installed the {web-terminal-op}. -include::snippets/access-cluster-configuration-console.adoc[] +.Procedure +. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings*. +. On the *Cluster Settings* page, click the *Configuration* tab. +. On the *Configuration* page, click the *Console* configuration resource with the description *operator.openshift.io*. ++ +image::cluster-settings-console.png[Image of the Configuration page showing the correct Console configuration resource to select] + +. From the *Action* drop-down list, select *Customize*, which opens the *Cluster configuration* page. . Click the *Web Terminal* tab, which opens the *Web Terminal Configuration* page. . Set a value for the timeout. From the drop-down list, select a time interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*. . Click *Save*. \ No newline at end of file diff --git a/modules/disable-quickstarts-admin-console.adoc b/modules/disable-quickstarts-admin-console.adoc index 429867cb146c..b3de3fb97aa2 100644 --- a/modules/disable-quickstarts-admin-console.adoc +++ b/modules/disable-quickstarts-admin-console.adoc @@ -6,14 +6,22 @@ [id="disable-quickstarts-admin-console_{context}"] = Disabling quick starts in the web console +[role="_abstract"] You can use the *Administrator* perspective of the web console to disable one or more quick starts. .Prerequisites * You have cluster administrator permissions and are logged in to the web console. -include::snippets/access-cluster-configuration-console.adoc[] +.Procedure +. In the *Administrator* perspective, navigate to *Administration* -> *Cluster Settings*. +. On the *Cluster Settings* page, click the *Configuration* tab. +. On the *Configuration* page, click the *Console* configuration resource with the description *operator.openshift.io*. ++ +image::cluster-settings-console.png[Image of the Configuration page showing the correct Console configuration resource to select] + +. From the *Action* drop-down list, select *Customize*, which opens the *Cluster configuration* page. . On the *General* tab, in the *Quick starts* section, you can select items in either the *Enabled* or *Disabled* list, and move them from one list to the other by using the arrow buttons. ** To enable or disable a single quick start, click the quick start, then use the single arrow buttons to move the quick start to the appropriate list. diff --git a/modules/odc-access-web-terminal.adoc b/modules/odc-access-web-terminal.adoc index 5a1197a101f6..0ac9178668fc 100644 --- a/modules/odc-access-web-terminal.adoc +++ b/modules/odc-access-web-terminal.adoc @@ -7,7 +7,7 @@ = Accessing the web terminal [role="_abstract"] -After the {web-terminal-op} is installed, you can access the web terminal. After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, and `subctl` in the web terminal. +After the {web-terminal-op} is installed, you can access the web terminal. After the web terminal is initialized, you can use the preinstalled CLI tools such as `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, and `subctl` in the web terminal. You can re-run commands by selecting them from the list of commands you have run in the terminal. These commands persist across multiple terminal sessions. The web terminal remains open until you close it or until you close the browser window or tab. @@ -41,12 +41,12 @@ endif::openshift-rosa,openshift-dedicated[] ifndef::openshift-rosa,openshift-dedicated[] . Optional: Set the web terminal timeout for the current session: .. Click Timeout. -.. In the field that appears, enter the timeout value. +.. In the field that is displayed, enter the timeout value. .. From the drop-down list, select a timeout interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*. . Optional: Select a custom image for the web terminal to use. .. Click Image. -.. In the field that appears, enter the URL of the image that you want to use. +.. In the field that is displayed, enter the URL of the image that you want to use. endif::openshift-rosa,openshift-dedicated[] . Click *Start* to initialize the web terminal using the selected project. diff --git a/modules/odc-configure-web-terminal-timeout-session.adoc b/modules/odc-configure-web-terminal-timeout-session.adoc index d22eb58c86ce..40afbf5a8aed 100644 --- a/modules/odc-configure-web-terminal-timeout-session.adoc +++ b/modules/odc-configure-web-terminal-timeout-session.adoc @@ -27,9 +27,9 @@ cluster that has the {web-terminal-op} installed. . Click the web terminal icon (image:odc-wto-icon.png[title="web terminal icon"]). . Optional: Set the web terminal timeout for the current session: .. Click Timeout. -.. In the field that appears, enter the timeout value. +.. In the field that is displayed, enter the timeout value. .. From the drop-down list, select a timeout interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*. . Optional: Select a custom image for the web terminal to use. -.. Click Image. -.. In the field that appears, enter the URL of the image that you want to use. +.. Click Image. +.. In the field that is displayed, enter the URL of the image that you want to use. . Click *Start* to begin a terminal instance using the specified timeout setting. diff --git a/snippets/access-cluster-configuration-console.adoc b/snippets/access-cluster-configuration-console.adoc deleted file mode 100644 index 24e1944026d4..000000000000 --- a/snippets/access-cluster-configuration-console.adoc +++ /dev/null @@ -1,17 +0,0 @@ -// Text snippet included in the following modules: -// -// * modules/disable-quickstarts-admin-console.adoc -// * modules/configure-web-terminal-image-admin.adoc -// * modules/configure-web-terminal-timeout-admin.adoc - -:_mod-docs-content-type: SNIPPET - -.Procedure - -. In the *Administrator* perspective, navigate to *Administation* -> *Cluster Settings*. -. On the *Cluster Settings* page, click the *Configuration* tab. -. On the *Configuration* page, click the *Console* configuration resource with the description *operator.openshift.io*. -+ -image::cluster-settings-console.png[Image of the Configuration page showing the correct Console configuration resource to select] - -. From the *Action* drop-down list, select *Customize*, which opens the *Cluster configuration* page. \ No newline at end of file