Skip to content

OSDOCS-16567: Updated Web Console for DITA migration #104179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EricPonvelle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OSDOCS-16567: Updated Web Console for DITA migration #104179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...reating_applications/odc-creating-applications-using-developer-perspective.adoc
View file
Open in desktop
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Dec 19, 2025

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ShortDescription: Assign [role="_abstract"] to a paragraph to use it as in DITA.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ toc::[]
The *Developer* perspective in the web console provides you the following options from the *+Add* view to create applications and associated services and deploy them on {product-title}:

ifndef::openshift-enterprise,openshift-webscale[]
include::snippets/unified-perspective-web-console.adoc[]
include::snippets/snip-unified-perspective-web-console.adoc[]
endif::[]

* *Getting started resources*: Use these resources to help you get started with Developer Console. You can choose to hide the header using the Options menu {kebab}.
Expand Down
1 change: 1 addition & 0 deletions modules/about-administrator_web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="about-administrator-perspective_{context}"]
= Administrator role in the web console

[role="_abstract"]
Copy link
Contributor

@mburke5678 mburke5678 Dec 19, 2025

Choose a reason for hiding this comment

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

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…”.

Copy link
Contributor Author

@EricPonvelle EricPonvelle Dec 19, 2025

Choose a reason for hiding this comment

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

@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.

The cluster administrator role enables you to view the cluster inventory, capacity, general and specific utilization information, and the stream of important events, all of which help you to simplify planning and troubleshooting tasks. Both project administrators and cluster administrators can use all features in the web console.

ifndef::openshift-rosa-hcp[]
Expand Down
3 changes: 2 additions & 1 deletion modules/about-developer_web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="about-developer_web-console_{context}"]
= Developer role in the web console

[role="_abstract"]
The developer role in the web console offers several built-in ways to deploy applications, services, and databases. With the developer role, you can:

* View real-time visualization of rolling and recreating rollouts on the component.
Expand All @@ -32,5 +33,5 @@ You can use the *Topology* view to display applications, components, and workloa

ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
.Additional resources
See link:https://docs.openshift.com/container-platform/latest/applications/odc-viewing-application-composition-using-topology-view.html[Viewing application composition using the Topology] view for more information on using the *Topology* view in *Developer* perspective.
* link:https://docs.openshift.com/container-platform/latest/applications/odc-viewing-application-composition-using-topology-view.html[Viewing application composition using the Topology]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
22 changes: 14 additions & 8 deletions modules/adding-tab-pods-page.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="adding-tab-to-pods-page_{context}"]
= Adding a tab to the pods page

[role="_abstract"]
There are different customizations you can make to the {product-title} web console. The following procedure adds a tab to the *Pod details* page as an example extension to your plugin.

[NOTE]
Expand Down Expand Up @@ -34,10 +35,10 @@ Custom plugin code is not supported by Red Hat. Only link:https://access.redhat.

----
"consolePlugin": {
"name": "my-plugin", <1>
"version": "0.0.1", <2>
"displayName": "My Plugin", <3>
"description": "Enjoy this shiny, new console plugin!", <4>
"name": "my-plugin",
"version": "0.0.1",
"displayName": "My Plugin",
"description": "Enjoy this shiny, new console plugin!",
"exposedModules": {
"ExamplePage": "./components/ExamplePage"
},
Expand All @@ -46,10 +47,15 @@ Custom plugin code is not supported by Red Hat. Only link:https://access.redhat.
}
}
----
<1> Update the name of your plugin.
<2> Update the version.
<3> Update the display name for your plugin.
<4> Update the description with a synopsis about your plugin.
+
--
where:

`consolePlugin.name.my-plugin`:: Update the name of your plugin.
`consolePlugin.version.0.0.1`:: Update the version.
`consolePlugin.displayName.My Plugin`:: Update the display name for your plugin.
`consolePlugin.description.Enjoy this shiny, new console plugin!`:: Update the description with a synopsis about your plugin.
--

. Add the following to the `console-extensions.json` file:
+
Expand Down
1 change: 1 addition & 0 deletions modules/build-image-docker.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="build-image-with-docker_{context}"]
= Build an image with Docker

[role="_abstract"]
To deploy your plugin on a cluster, you need to build an image and push it to an image registry first.

.Procedure
Expand Down
27 changes: 10 additions & 17 deletions modules/csp-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,26 @@

:_mod-docs-content-type: CONCEPT
[id="content-security-policy-overview_{context}"]
= Content Security Policy (CSP) overview
= Key features of Content Security Policy (CSP)

[role="_abstract"]
A Content Security Policy (CSP) is delivered to the browser in the `Content-Security-Policy-Report-Only` response header. The policy is specified as a series of directives and values. Each directive type serves a different purpose, and each directive can have a list of values representing allowed sources.

[id="content-security-policy-key-features_{context}"]
== Key features of `contentSecurityPolicy`


=== Directive Types

[id="content-security-policy-directive-types_{context}"]
== Directive Types
The supported directive types include `DefaultSrc`, `ScriptSrc`, `StyleSrc`, `ImgSrc`, and `FontSrc`. These directives allow you to specify valid sources for loading different types of content for your plugin. Each directive type serves a different purpose. For example, `ScriptSrc` defines valid JavaScript sources, while `ImgSrc` controls where images can be loaded from.

//backporting the ConnectSrc directive, but that is tbd - openshift/console#14701 and https://github.com/openshift/api/pull/2164



=== Values

[id="content-security-policy-values_{context}"]
== Values
Each directive can have a list of values representing allowed sources. For example, `ScriptSrc` can specify multiple external scripts. These values are restricted to 1024 characters and cannot include whitespace, commas, or semicolons. Additionally, single-quoted strings and wildcard characters (`*`) are disallowed.


=== Unified Policy

[id="content-security-policy-unified-policy_{context}"]
== Unified Policy
The {product-title} web console aggregates the CSP directives across all enabled `ConsolePlugin` custom resources (CRs) and merges them with its own default policy. The combined policy is then applied with the `Content-Security-Policy-Report-Only` HTTP response header.


=== Validation Rules
[id="content-security-policy-validation-rules_{context}"]
== Validation Rules
* Each directive can have up to 16 unique values.
* The total size of all values across directives must not exceed 8192 bytes (8KB).
* Each value must be unique, and additional validation rules are in place to ensure no quotes, spaces, commas, or wildcard symbols are used.
1 change: 1 addition & 0 deletions modules/deployment-plug-in-cluster.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="deploy-on-cluster_{context}"]
= Deploy your plugin on a cluster

[role="_abstract"]
After pushing an image with your changes to a registry, you can deploy the plugin to a cluster using a Helm chart.

.Prerequisites
Expand Down
4 changes: 2 additions & 2 deletions modules/disabling-plug-in-browser.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
[id="disabling-your-plugin-browser_{context}"]
= Disabling your plugin in the browser

[role="_abstract"]
Console users can use the `disable-plugins` query parameter to disable specific or all dynamic plugins that would normally get loaded at run-time.

.Procedure

* To disable a specific plugin(s), remove the plugin you want to disable from the comma-separated list of plugin names.

* To disable all plugins, leave an empty string in the `disable-plugins` query parameter.

+
[NOTE]
====
Cluster administrators can disable plugins in the *Cluster Settings* page of the web console.
Expand Down
1 change: 1 addition & 0 deletions modules/dynamic-plug-in-development.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="dynamic-plugin-development_{context}"]
= Dynamic plugin development

[role="_abstract"]
You can run the plugin using a local development environment. The {product-title} web console runs in a container connected to the cluster you have logged into.

.Prerequisites
Expand Down
Loading