OSDOCS-16567: Updated Web Console for DITA migration

Author: EricPonvelle

.vale.ini

@@ -1,14 +1,14 @@
 StylesPath = .vale/styles
 
-MinAlertLevel = suggestion
+MinAlertLevel = warning
 
 Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc, https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
 
 Vocab = OpenShiftDocs
 
 # Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
-[[!.]*.adoc]
-BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc
+[*.adoc]
+BasedOnStyles = AsciiDocDITA
 
 # Disabling rules (NO)
 RedHat.ReleaseNotes = NO
@@ -19,31 +19,16 @@ Vale.Avoid = YES
 
 # Enable specifc DITA rules on assemblies
 AsciiDocDITA.AdmonitionTitle = error
-AsciiDocDITA.AssemblyContents = error
-AsciiDocDITA.AuthorLine = error
-AsciiDocDITA.BlockTitle = error
-AsciiDocDITA.CalloutList = error
-AsciiDocDITA.ContentType = error
-AsciiDocDITA.DiscreteHeading = error
-AsciiDocDITA.DocumentID = error
-AsciiDocDITA.DocumentTitle = error
-AsciiDocDITA.EntityReference = error
-AsciiDocDITA.EquationFormula = error
-AsciiDocDITA.ExampleBlock = error
-AsciiDocDITA.LineBreak = error
-AsciiDocDITA.NestedSection = error
+AsciiDocDITA.ThematicBreak = error
+AsciiDocDITA.TableFooter = error
 AsciiDocDITA.PageBreak = error
-AsciiDocDITA.RelatedLinks = error
-AsciiDocDITA.ShortDescription = error
+AsciiDocDITA.DiscreteHeading = error
 AsciiDocDITA.SidebarBlock = error
-AsciiDocDITA.TableFooter = error
-AsciiDocDITA.TaskContents = error
-AsciiDocDITA.TaskDuplicate = error
+AsciiDocDITA.LineBreak = error
+AsciiDocDITA.EquationFormula = error
 AsciiDocDITA.TaskExample = error
-AsciiDocDITA.TaskSection = error
-AsciiDocDITA.TaskStep = error
-AsciiDocDITA.TaskTitle = error
-AsciiDocDITA.ThematicBreak = error
+AsciiDocDITA.EntityReference = error
+AsciiDocDITA.ExampleBlock = error
 
 # Disable module specific rules
 OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = NO

modules/about-administrator_web-console.adoc

@@ -6,6 +6,7 @@
 [id="about-administrator-perspective_{context}"]
 = Administrator role in the web console
 
+[role="_abstract"]
 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[]

modules/about-developer_web-console.adoc

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

modules/adding-tab-pods-page.adoc

@@ -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]
@@ -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"
   },
@@ -46,10 +47,14 @@ 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:
+
+`"name": "my-plugin",`:: Update the name of your plugin.
+`"version": "0.0.1",`:: Update the version.
+`"displayName": "My Plugin",`:: Update the display name for your plugin.
+`"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:
 +

modules/build-image-docker.adoc

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

modules/csp-overview.adoc

@@ -4,33 +4,22 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="content-security-policy-overview_{context}"]
-= Content Security Policy (CSP) overview
+= Key features of `contentSecurityPolicy` (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
-
+== 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
-
+== 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
-
+== 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
+== 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.

modules/deployment-plug-in-cluster.adoc

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

modules/disabling-plug-in-browser.adoc

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

modules/dynamic-plug-in-development.adoc

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