Skip to content

Commit af3af32

Browse files
committed
OSDOCS-16567: Updated Web Console for DITA migration
1 parent 21086f3 commit af3af32

File tree

57 files changed

+172
-124
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+172
-124
lines changed

applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99
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}:
1010

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

1515
* *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}.

modules/about-administrator_web-console.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="about-administrator-perspective_{context}"]
77
= Administrator role in the web console
88

9+
[role="_abstract"]
910
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.
1011

1112
ifndef::openshift-rosa-hcp[]

modules/about-developer_web-console.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="about-developer_web-console_{context}"]
77
= Developer role in the web console
88

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

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

3334
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
3435
.Additional resources
35-
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.
36+
* link:https://docs.openshift.com/container-platform/latest/applications/odc-viewing-application-composition-using-topology-view.html[Viewing application composition using the Topology]
3637
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]

modules/adding-tab-pods-page.adoc

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="adding-tab-to-pods-page_{context}"]
77
= Adding a tab to the pods page
88

9+
[role="_abstract"]
910
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.
1011

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

3536
----
3637
"consolePlugin": {
37-
"name": "my-plugin", <1>
38-
"version": "0.0.1", <2>
39-
"displayName": "My Plugin", <3>
40-
"description": "Enjoy this shiny, new console plugin!", <4>
38+
"name": "my-plugin",
39+
"version": "0.0.1",
40+
"displayName": "My Plugin",
41+
"description": "Enjoy this shiny, new console plugin!",
4142
"exposedModules": {
4243
"ExamplePage": "./components/ExamplePage"
4344
},
@@ -46,10 +47,15 @@ Custom plugin code is not supported by Red Hat. Only link:https://access.redhat.
4647
}
4748
}
4849
----
49-
<1> Update the name of your plugin.
50-
<2> Update the version.
51-
<3> Update the display name for your plugin.
52-
<4> Update the description with a synopsis about your plugin.
50+
+
51+
--
52+
where:
53+
54+
`consolePlugin.name.my-plugin`:: Update the name of your plugin.
55+
`consolePlugin.version.0.0.1`:: Update the version.
56+
`consolePlugin.displayName.My Plugin`:: Update the display name for your plugin.
57+
`consolePlugin.description.Enjoy this shiny, new console plugin!`:: Update the description with a synopsis about your plugin.
58+
--
5359

5460
. Add the following to the `console-extensions.json` file:
5561
+

modules/build-image-docker.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="build-image-with-docker_{context}"]
77
= Build an image with Docker
88

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

1112
.Procedure

modules/csp-overview.adoc

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,26 @@
44

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

9+
[role="_abstract"]
910
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.
1011

11-
[id="content-security-policy-key-features_{context}"]
12-
== Key features of `contentSecurityPolicy`
13-
14-
15-
=== Directive Types
16-
12+
[id="content-security-policy-directive-types_{context}"]
13+
== Directive Types
1714
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.
1815

1916
//backporting the ConnectSrc directive, but that is tbd - openshift/console#14701 and https://github.com/openshift/api/pull/2164
20-
21-
22-
23-
=== Values
24-
17+
[id="content-security-policy-values_{context}"]
18+
== Values
2519
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.
2620

27-
28-
=== Unified Policy
29-
21+
[id="content-security-policy-unified-policy_{context}"]
22+
== Unified Policy
3023
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.
3124

32-
33-
=== Validation Rules
25+
[id="content-security-policy-validation-rules_{context}"]
26+
== Validation Rules
3427
* Each directive can have up to 16 unique values.
3528
* The total size of all values across directives must not exceed 8192 bytes (8KB).
3629
* Each value must be unique, and additional validation rules are in place to ensure no quotes, spaces, commas, or wildcard symbols are used.

modules/deployment-plug-in-cluster.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="deploy-on-cluster_{context}"]
77
= Deploy your plugin on a cluster
88

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

1112
.Prerequisites

modules/disabling-plug-in-browser.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
[id="disabling-your-plugin-browser_{context}"]
77
= Disabling your plugin in the browser
88

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

1112
.Procedure
1213

1314
* To disable a specific plugin(s), remove the plugin you want to disable from the comma-separated list of plugin names.
14-
1515
* To disable all plugins, leave an empty string in the `disable-plugins` query parameter.
16-
16+
+
1717
[NOTE]
1818
====
1919
Cluster administrators can disable plugins in the *Cluster Settings* page of the web console.

modules/dynamic-plug-in-development.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="dynamic-plugin-development_{context}"]
77
= Dynamic plugin development
88

9+
[role="_abstract"]
910
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.
1011

1112
.Prerequisites

0 commit comments

Comments
 (0)