From 47fe22b0081c3ec94d4c2a19b501c1f537e166fb Mon Sep 17 00:00:00 2001 From: Jocelyn Sese Date: Mon, 3 Aug 2026 15:46:35 -0400 Subject: [PATCH] OSDOCS-16919: CQA fixes for quick starts docs Split out of PR #115956 (too large for review, per skopacz1's request) into a single-purpose subset: content-type/abstract and Vale fixes for the quick starts modules, plus splitting the quick-start API documentation section out of contributing-quick-starts.adoc into its own module (viewing-quick-start-api-documentation.adoc), wired into the creating-quick-start-tutorials.adoc assembly. Co-Authored-By: Claude Sonnet 5 --- modules/contributing-quick-starts.adoc | 15 +----- modules/quick-start-adding-custom-icon.adoc | 1 + modules/quick-start-content-guidelines.adoc | 23 +++++---- modules/quick-start-limiting-access.adoc | 1 + modules/quick-start-user-workflow.adoc | 4 +- ...accessing-and-executing-code-snippets.adoc | 5 +- .../quick-starts-highlighting-reference.adoc | 1 + modules/quick-starts-linking-to-others.adoc | 3 ++ modules/quick-starts-supported-tags.adoc | 1 + .../understanding-quick-start-elements.adoc | 47 +++++++++---------- ...viewing-quick-start-api-documentation.adoc | 21 +++++++++ .../creating-quick-start-tutorials.adoc | 2 + 12 files changed, 70 insertions(+), 54 deletions(-) create mode 100644 modules/viewing-quick-start-api-documentation.adoc diff --git a/modules/contributing-quick-starts.adoc b/modules/contributing-quick-starts.adoc index 71c694b91965..c1cb89976fa6 100644 --- a/modules/contributing-quick-starts.adoc +++ b/modules/contributing-quick-starts.adoc @@ -6,6 +6,7 @@ [id="contributing-quick-starts_{context}"] = Contributing quick starts +[role="_abstract"] {product-title} introduces the quick start custom resource, which is defined by a `ConsoleQuickStart` object. Operators and administrators can use this resource to contribute quick starts to the cluster. .Prerequisites @@ -31,17 +32,3 @@ $ oc create -f my-quick-start.yaml . Update the YAML file using the guidance outlined in this documentation. . Save your edits. - -[id="viewing-quick-start-api-documentation_{context}"] -== Viewing the quick start API documentation - -.Procedure - -* To see the quick start API documentation, run: -+ -[source,terminal] ----- -$ oc explain consolequickstarts ----- - -Run `oc explain -h` for more information about `oc explain` usage. diff --git a/modules/quick-start-adding-custom-icon.adoc b/modules/quick-start-adding-custom-icon.adoc index 35bfd6ba7567..8aef6b3ca577 100644 --- a/modules/quick-start-adding-custom-icon.adoc +++ b/modules/quick-start-adding-custom-icon.adoc @@ -6,6 +6,7 @@ [id="adding-custom-icon-to-quick-start_{context}"] = Adding a custom icon to a quick start +[role="_abstract"] A default icon is provided for all quick starts. You can provide your own custom icon. .Procedure diff --git a/modules/quick-start-content-guidelines.adoc b/modules/quick-start-content-guidelines.adoc index 42ef80357f0e..7f72bea6e1d5 100644 --- a/modules/quick-start-content-guidelines.adoc +++ b/modules/quick-start-content-guidelines.adoc @@ -6,6 +6,9 @@ [id="quick-start-content-guidelines_{context}"] = Quick start content guidelines +[role="_abstract"] +Follow these content guidelines when writing quick starts for the {product-title} web console. + [id="quick-start-content-guidelines-card-copy_{context}"] == Card copy @@ -52,12 +55,12 @@ You will complete these 3 tasks: Creating a serverless application; Connecting a [id="quick-start-content-guidelines-task-steps_{context}"] == Task steps -After the user clicks *Start*, a series of steps appears that they must perform to complete the quick start. +After the user clicks *Start*, a series of steps is displayed that they must perform to complete the quick start. Follow these general guidelines when writing task steps: * Use "Click" for buttons and labels. Use "Select" for checkboxes, radio buttons, and drop-down menus. -* Use "Click" instead of "Click on" +* Use "Click" by itself. Do not add "on" after it. ** *Correct example*: + ---- @@ -104,7 +107,7 @@ Change the time range of the dashboard by clicking the dropdown menu and selecti To look at data in a specific time frame, you can change the time range of the dashboard. ---- -* Avoid directional language, like "In the top-right corner, click the icon". Directional language becomes outdated every time UI layouts change. Also, a direction for desktop users might not be accurate for users with a different screen size. Instead, identify something using its name. +* Avoid directional language, such as "In the upper-right corner, click the icon". Directional language becomes outdated every time UI layouts change. Also, a direction for desktop users might not be accurate for users with a different screen size. Instead, identify something using its name. ** *Correct example*: + ---- @@ -115,7 +118,7 @@ In the navigation menu, click Settings. ---- In the left-hand menu, click Settings. ---- -* Do not identify items by color alone, like "Click the gray circle". Color identifiers are not useful for sight-limited users, especially colorblind users. Instead, identify an item using its name or copy, like button copy. +* Do not identify items by color alone, such as "Click the gray circle". Color identifiers are not useful for sight-limited users, especially colorblind users. Instead, identify an item using its name or copy, such as button copy. ** *Correct example*: + ---- @@ -142,17 +145,17 @@ Let's set up our environment. [id="quick-start-content-guidelines-check-your-work-module_{context}"] == Check your work module -* After a user completes a step, a *Check your work* module appears. This module prompts the user to answer a yes or no question about the step results, which gives them the opportunity to review their work. For this module, you only need to write a single yes or no question. -** If the user answers *Yes*, a check mark will appear. -** If the user answers *No*, an error message appears with a link to relevant documentation, if necessary. The user then has the opportunity to go back and try again. +* After a user completes a step, a *Check your work* module is displayed. This module prompts the user to answer a yes or no question about the step results, which gives them the opportunity to review their work. For this module, you only need to write a single yes or no question. +** If the user answers *Yes*, a checkmark is displayed. +** If the user answers *No*, an error message is displayed with a link to relevant documentation, if necessary. The user then has the opportunity to go back and try again. [id="quick-start-content-guidelines-formatting-UI-elements_{context}"] == Formatting UI elements -Format UI elements using these guidelines: +Format UI elements by using these guidelines: -* Copy for buttons, dropdowns, tabs, fields, and other UI controls: Write the copy as it appears in the UI and bold it. -* All other UI elements—including page, window, and panel names: Write the copy as it appears in the UI and bold it. +* Copy for buttons, dropdowns, tabs, fields, and other UI controls: Write the copy as it is displayed in the UI and bold it. +* All other UI elements (including page, window, and panel names): Write the copy as it is displayed in the UI and bold it. * Code or user-entered text: Use monospaced font. * Hints: If a hint to a navigation or masthead element is included, style the text as you would a link. * CLI commands: Use monospaced font. diff --git a/modules/quick-start-limiting-access.adoc b/modules/quick-start-limiting-access.adoc index ab55a73c9201..b2cdf9972e93 100644 --- a/modules/quick-start-limiting-access.adoc +++ b/modules/quick-start-limiting-access.adoc @@ -6,6 +6,7 @@ [id="limiting-access-to-quick-starts_{context}"] = Limiting access to a quick start +[role="_abstract"] Not all quick starts should be available for everyone. The `accessReviewResources` section of the YAML file provides the ability to limit access to the quick start. To only allow the user to access the quick start if they have the ability to create `HelmChartRepository` resources, use the following configuration: diff --git a/modules/quick-start-user-workflow.adoc b/modules/quick-start-user-workflow.adoc index e9f3c9ac2569..0daa10ba3ffb 100644 --- a/modules/quick-start-user-workflow.adoc +++ b/modules/quick-start-user-workflow.adoc @@ -13,11 +13,11 @@ When you interact with an existing quick start tutorial, this is the expected wo . Click a quick start card. -. In the panel that appears, click *Start*. +. In the panel that is displayed, click *Start*. . Complete the on-screen instructions, then click *Next*. -. In the *Check your work* module that appears, answer the question to confirm that you successfully completed the task. +. In the *Check your work* module that is displayed, answer the question to confirm that you successfully completed the task. .. If you select *Yes*, click *Next* to continue to the next task. .. If you select *No*, repeat the task instructions and check your work again. diff --git a/modules/quick-starts-accessing-and-executing-code-snippets.adoc b/modules/quick-starts-accessing-and-executing-code-snippets.adoc index e35715b95d5a..fafa85655a20 100644 --- a/modules/quick-starts-accessing-and-executing-code-snippets.adoc +++ b/modules/quick-starts-accessing-and-executing-code-snippets.adoc @@ -6,7 +6,8 @@ [id="quick-starts-accessing-and-executing-code-snippets_{context}"] = Code snippet markdown reference -You can execute a CLI code snippet when it is included in a quick start from the web console. To use this feature, you must first install the Web Terminal Operator. The web terminal and code snippet actions that execute in the web terminal are not present if you do not install the Web Terminal Operator. Alternatively, you can copy a code snippet to the clipboard regardless of whether you have the Web Terminal Operator installed or not. +[role="_abstract"] +You can run a CLI code snippet when it is included in a quick start from the web console. To use this feature, you must first install the {web-terminal-op}. The web terminal and code snippet actions that run in the web terminal are not present if you do not install the {web-terminal-op}. Alternatively, you can copy a code snippet to the clipboard regardless of whether you have the {web-terminal-op} installed or not. [id="quick-starts-syntax-for-inline-code-snippets_{context}"] == Syntax for inline code snippets @@ -18,7 +19,7 @@ You can execute a CLI code snippet when it is included in a quick start from the [NOTE] ==== -If the `execute` syntax is used, the *Copy to clipboard* action is present whether you have the Web Terminal Operator installed or not. +If the `execute` syntax is used, the *Copy to clipboard* action is present whether you have the {web-terminal-op} installed or not. ==== [id="quick-starts-syntax-for-multi-line-code-snippets_{context}"] diff --git a/modules/quick-starts-highlighting-reference.adoc b/modules/quick-starts-highlighting-reference.adoc index ca18cb1372d7..4d4a080b4df4 100644 --- a/modules/quick-starts-highlighting-reference.adoc +++ b/modules/quick-starts-highlighting-reference.adoc @@ -6,6 +6,7 @@ [id="quick-start-highlighting-reference_{context}"] = Quick start highlighting markdown reference +[role="_abstract"] The highlighting, or hint, feature enables Quick Starts to contain a link that can highlight and animate a component of the web console. The markdown syntax contains: diff --git a/modules/quick-starts-linking-to-others.adoc b/modules/quick-starts-linking-to-others.adoc index 75e3a4abd76b..a3548935e3f7 100644 --- a/modules/quick-starts-linking-to-others.adoc +++ b/modules/quick-starts-linking-to-others.adoc @@ -6,6 +6,9 @@ [id="linking-to-other-quick-starts_{context}"] = Linking to other quick starts +[role="_abstract"] +You can link one quick start to another so that users can continue to a related quick start after completing the current one. + .Procedure * In the `nextQuickStart` section of the YAML file, provide the `name`, not the `displayName`, of the quick start to which you want to link. For example: diff --git a/modules/quick-starts-supported-tags.adoc b/modules/quick-starts-supported-tags.adoc index fe7af203f2c9..742c0c853e47 100644 --- a/modules/quick-starts-supported-tags.adoc +++ b/modules/quick-starts-supported-tags.adoc @@ -6,6 +6,7 @@ [id="supported-tags-for-quick-starts_{context}"] = Supported tags for quick starts +[role="_abstract"] Write your quick start content in markdown using these tags. The markdown is converted to HTML. [cols="2",options="header"] diff --git a/modules/understanding-quick-start-elements.adoc b/modules/understanding-quick-start-elements.adoc index 8d4cee356a15..1565dfb75400 100644 --- a/modules/understanding-quick-start-elements.adoc +++ b/modules/understanding-quick-start-elements.adoc @@ -2,10 +2,12 @@ // // * web_console/creating-quick-start-tutorials.adoc +:_mod-docs-content-type: CONCEPT [id="understanding-quick-start-elements_{context}"] = Mapping the elements in the quick start to the quick start CR -This section helps you visually map parts of the quick start custom resource (CR) with where they appear in the quick start within the web console. +[role="_abstract"] +This section helps you visually map parts of the quick start custom resource (CR) with where they are displayed in the quick start within the web console. [id="conclusion-quick-start-element_{context}"] == conclusion element @@ -19,13 +21,12 @@ summary: success: Your Spring application is running. title: Run the Spring application conclusion: >- - Your Spring application is deployed and ready. <1> + Your Spring application is deployed and ready. ---- -<1> conclusion text -.Viewing the conclusion element in the web console +The `conclusion` field defines the conclusion text. -The conclusion appears in the last section of the quick start. +In the web console, the conclusion is displayed in the last section of the quick start. image::quick-start-conclusion.png[quick start conclusion in the web console] @@ -40,18 +41,16 @@ kind: ConsoleQuickStart metadata: name: spring-with-s2i spec: - description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' <1> + description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' ... ---- -<1> description text -.Viewing the description element in the web console +The `description` field defines the description text. -The description appears on the introductory tile of the quick start on the *Quick Starts* page. +In the web console, the description is displayed on the introductory tile of the quick start on the *Quick Starts* page. image::quick-start-description.png[quick start description in the web console] - [id="displayName-quick-start-element_{context}"] == displayName element @@ -65,14 +64,13 @@ metadata: name: spring-with-s2i spec: description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' - displayName: Get started with Spring <1> + displayName: Get started with Spring durationMinutes: 10 ---- -<1> `displayName` text. -.Viewing the displayName element in the web console +The `displayName` field defines the display name text. -The display name appears on the introductory tile of the quick start on the *Quick Starts* page. +In the web console, the display name is displayed on the introductory tile of the quick start on the *Quick Starts* page. image::quick-start-display-name.png[quick start display name in the web console] @@ -90,13 +88,12 @@ metadata: spec: description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' displayName: Get started with Spring - durationMinutes: 10 <1> + durationMinutes: 10 ---- -<1> `durationMinutes` value, in minutes. This value defines how long the quick start should take to complete. -.Viewing the durationMinutes element in the web console +The `durationMinutes` field defines, in minutes, how long the quick start should take to complete. -The duration minutes element appears on the introductory tile of the quick start on the *Quick Starts* page. +In the web console, the duration minutes element is displayed on the introductory tile of the quick start on the *Quick Starts* page. image::quick-start-duration.png[quick start durationMinutes element in the web console] @@ -112,15 +109,14 @@ spec: description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.' displayName: Get started with Spring durationMinutes: 10 - icon: >- <1> + icon: >- data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGlkPSJMYXllcl8xIiBkYXRhLW5hbWU9IkxheWVyIDEiIHZpZXdCb3g9IjAgMCAxMDI0IDEwMjQiPjxkZWZzPjxzdHlsZT4uY2xzLTF7ZmlsbDojMTUzZDNjO30uY2xzLTJ7ZmlsbDojZDhkYTlkO30uY2xzLTN7ZmlsbDojNThjMGE4O30uY2xzLTR7ZmlsbDojZmZmO30uY2xzLTV7ZmlsbDojM2Q5MTkxO308L3N0eWxlPjwvZGVmcz48dGl0bGU+c25vd2Ryb3BfaWNvbl9yZ2JfZGVmYXVsdDwvdGl0bGU+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMTAxMi42OSw1OTNjLTExLjEyLTM4LjA3LTMxLTczLTU5LjIxLTEwMy44LTkuNS0xMS4zLTIzLjIxLTI4LjI5LTM5LjA2LTQ3Ljk0QzgzMy41MywzNDEsNzQ1LjM3LDIzNC4xOCw2NzQsMTY4Ljk0Yy01LTUuMjYtMTAuMjYtMTAuMzEtMTUuNjUtMTUuMDdhMjQ2LjQ5LDI0Ni40OSwwLDAsMC0zNi41NS0yNi44LDE4Mi41LDE4Mi41LDAsMCwwLTIwLjMtMTEuNzcsMjAxLjUzLDIwMS41MywwLDAsMC00My4xOS0xNUExNTUuMjQsMTU1LjI0LDAsMCwwLDUyOCw5NS4yYy02Ljc2LS42OC0xMS43NC0uODEtMTQuMzktLjgxaDBsLTEuNjIsMC0xLjYyLDBhMTc3LjMsMTc3LjMsMCwwLDAtMzEuNzcsMy4zNSwyMDguMjMsMjA4LjIzLDAsMCwwLTU2LjEyLDE3LjU2LDE4MSwxODEsMCwwLDAtMjAuMjcsMTEuNzUsMjQ3LjQzLDI0Ny40MywwLDAsMC0zNi41NywyNi44MUMzNjAuMjUsMTU4LjYyLDM1NSwxNjMuNjgsMzUwLDE2OWMtNzEuMzUsNjUuMjUtMTU5LjUsMTcyLTI0MC4zOSwyNzIuMjhDOTMuNzMsNDYwLjg4LDgwLDQ3Ny44Nyw3MC41Miw0ODkuMTcsNDIuMzUsNTIwLDIyLjQzLDU1NC45LDExLjMxLDU5MywuNzIsNjI5LjIyLTEuNzMsNjY3LjY5LDQsNzA3LjMxLDE1LDc4Mi40OSw1NS43OCw4NTkuMTIsMTE4LjkzLDkyMy4wOWEyMiwyMiwwLDAsMCwxNS41OSw2LjUyaDEuODNsMS44Ny0uMzJjODEuMDYtMTMuOTEsMTEwLTc5LjU3LDE0My40OC0xNTUuNiwzLjkxLTguODgsNy45NS0xOC4wNSwxMi4yLTI3LjQzcTUuNDIsOC41NCwxMS4zOSwxNi4yM2MzMS44NSw0MC45MSw3NS4xMiw2NC42NywxMzIuMzIsNzIuNjNsMTguOCwyLjYyLDQuOTUtMTguMzNjMTMuMjYtNDkuMDcsMzUuMy05MC44NSw1MC42NC0xMTYuMTksMTUuMzQsMjUuMzQsMzcuMzgsNjcuMTIsNTAuNjQsMTE2LjE5bDUsMTguMzMsMTguOC0yLjYyYzU3LjItOCwxMDAuNDctMzEuNzIsMTMyLjMyLTcyLjYzcTYtNy42OCwxMS4zOS0xNi4yM2M0LjI1LDkuMzgsOC4yOSwxOC41NSwxMi4yLDI3LjQzLDMzLjQ5LDc2LDYyLjQyLDE0MS42OSwxNDMuNDgsMTU1LjZsMS44MS4zMWgxLjg5YTIyLDIyLDAsMCwwLDE1LjU5LTYuNTJjNjMuMTUtNjQsMTAzLjk1LTE0MC42LDExNC44OS0yMTUuNzhDMTAyNS43Myw2NjcuNjksMTAyMy4yOCw2MjkuMjIsMTAxMi42OSw1OTNaIi8+PHBhdGggY2xhc3M9ImNscy0yIiBkPSJNMzY0LjE1LDE4NS4yM2MxNy44OS0xNi40LDM0LjctMzAuMTUsNDkuNzctNDAuMTFhMjEyLDIxMiwwLDAsMSw2NS45My0yNS43M0ExOTgsMTk4LDAsMCwxLDUxMiwxMTYuMjdhMTk2LjExLDE5Ni4xMSwwLDAsMSwzMiwzLjFjNC41LjkxLDkuMzYsMi4wNiwxNC41MywzLjUyLDYwLjQxLDIwLjQ4LDg0LjkyLDkxLjA1LTQ3LjQ0LDI0OC4wNi0yOC43NSwzNC4xMi0xNDAuNywxOTQuODQtMTg0LjY2LDI2OC40MmE2MzAuODYsNjMwLjg2LDAsMCwwLTMzLjIyLDU4LjMyQzI3Niw2NTUuMzQsMjY1LjQsNTk4LDI2NS40LDUyMC4yOSwyNjUuNCwzNDAuNjEsMzExLjY5LDI0MC43NCwzNjQuMTUsMTg1LjIzWiIvPjxwYXRoIGNsYXNzPSJjbHMtMyIgZD0iTTUyNy41NCwzODQuODNjODQuMDYtOTkuNywxMTYuMDYtMTc3LjI4LDk1LjIyLTIzMC43NCwxMS42Miw4LjY5LDI0LDE5LjIsMzcuMDYsMzEuMTMsNTIuNDgsNTUuNSw5OC43OCwxNTUuMzgsOTguNzgsMzM1LjA3LDAsNzcuNzEtMTAuNiwxMzUuMDUtMjcuNzcsMTc3LjRhNjI4LjczLDYyOC43MywwLDAsMC0zMy4yMy01OC4zMmMtMzktNjUuMjYtMTMxLjQ1LTE5OS0xNzEuOTMtMjUyLjI3QzUyNi4zMywzODYuMjksNTI3LDM4NS41Miw1MjcuNTQsMzg0LjgzWiIvPjxwYXRoIGNsYXNzPSJjbHMtNCIgZD0iTTEzNC41OCw5MDguMDdoLS4wNmEuMzkuMzksMCwwLDEtLjI3LS4xMWMtMTE5LjUyLTEyMS4wNy0xNTUtMjg3LjQtNDcuNTQtNDA0LjU4LDM0LjYzLTQxLjE0LDEyMC0xNTEuNiwyMDIuNzUtMjQyLjE5LTMuMTMsNy02LjEyLDE0LjI1LTguOTIsMjEuNjktMjQuMzQsNjQuNDUtMzYuNjcsMTQ0LjMyLTM2LjY3LDIzNy40MSwwLDU2LjUzLDUuNTgsMTA2LDE2LjU5LDE0Ny4xNEEzMDcuNDksMzA3LjQ5LDAsMCwwLDI4MC45MSw3MjNDMjM3LDgxNi44OCwyMTYuOTMsODkzLjkzLDEzNC41OCw5MDguMDdaIi8+PHBhdGggY2xhc3M9ImNscy01IiBkPSJNNTgzLjQzLDgxMy43OUM1NjAuMTgsNzI3LjcyLDUxMiw2NjQuMTUsNTEyLDY2NC4xNXMtNDguMTcsNjMuNTctNzEuNDMsMTQ5LjY0Yy00OC40NS02Ljc0LTEwMC45MS0yNy41Mi0xMzUuNjYtOTEuMThhNjQ1LjY4LDY0NS42OCwwLDAsMSwzOS41Ny03MS41NGwuMjEtLjMyLjE5LS4zM2MzOC02My42MywxMjYuNC0xOTEuMzcsMTY3LjEyLTI0NS42Niw0MC43MSw1NC4yOCwxMjkuMSwxODIsMTY3LjEyLDI0NS42NmwuMTkuMzMuMjEuMzJhNjQ1LjY4LDY0NS42OCwwLDAsMSwzOS41Nyw3MS41NEM2ODQuMzQsNzg2LjI3LDYzMS44OCw4MDcuMDUsNTgzLjQzLDgxMy43OVoiLz48cGF0aCBjbGFzcz0iY2xzLTQiIGQ9Ik04ODkuNzUsOTA4YS4zOS4zOSwwLDAsMS0uMjcuMTFoLS4wNkM4MDcuMDcsODkzLjkzLDc4Nyw4MTYuODgsNzQzLjA5LDcyM2EzMDcuNDksMzA3LjQ5LDAsMCwwLDIwLjQ1LTU1LjU0YzExLTQxLjExLDE2LjU5LTkwLjYxLDE2LjU5LTE0Ny4xNCwwLTkzLjA4LTEyLjMzLTE3My0zNi42Ni0yMzcuNHEtNC4yMi0xMS4xNi04LjkzLTIxLjdjODIuNzUsOTAuNTksMTY4LjEyLDIwMS4wNSwyMDIuNzUsMjQyLjE5QzEwNDQuNzksNjIwLjU2LDEwMDkuMjcsNzg2Ljg5LDg4OS43NSw5MDhaIi8+PC9zdmc+Cg== ... ---- -<1> The icon defined as a base64 value. -.Viewing the icon element in the web console +The `icon` field defines the icon as a base64 value. -The icon appears on the introductory tile of the quick start on the *Quick Starts* page. +In the web console, the icon is displayed on the introductory tile of the quick start on the *Quick Starts* page. image::quick-start-icon.png[quick start icon element in the web console] @@ -132,7 +128,7 @@ image::quick-start-icon.png[quick start icon element in the web console] [source,yaml] ---- ... - introduction: >- <1> + introduction: >- **Spring** is a Java framework for building applications based on a distributed microservices architecture. - Spring enables easy packaging and configuration of Spring applications into a self-contained executable application which can be easily deployed as a container to OpenShift. @@ -154,10 +150,9 @@ image::quick-start-icon.png[quick start icon element in the web console] - Developer tooling through Red Hat OpenShift and Red Hat CodeReady developer tooling to quickly scaffold new Spring projects, gain access to familiar Spring APIs in your favorite IDE, and deploy to Red Hat OpenShift ... ---- -<1> The introduction introduces the quick start and lists the tasks within it. -.Viewing the introduction element in the web console +The `introduction` field introduces the quick start and lists the tasks within it. -After clicking a quick start card, a side panel slides in that introduces the quick start and lists the tasks within it. +In the web console, after you click a quick start card, a side panel slides in that introduces the quick start and lists the tasks within it. image::quick-start-introduction.png[quick start introduction element in the web console] diff --git a/modules/viewing-quick-start-api-documentation.adoc b/modules/viewing-quick-start-api-documentation.adoc new file mode 100644 index 000000000000..11731c2c7270 --- /dev/null +++ b/modules/viewing-quick-start-api-documentation.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * web_console/creating-quick-start-tutorials.adoc + +:_mod-docs-content-type: PROCEDURE +[id="viewing-quick-start-api-documentation_{context}"] += Viewing the quick start API documentation + +[role="_abstract"] +You can view the quick start API documentation by using the `oc explain` command. + +.Procedure + +* To see the quick start API documentation, run: ++ +[source,terminal] +---- +$ oc explain consolequickstarts +---- ++ +Run `oc explain -h` for more information about `oc explain` usage. diff --git a/web_console/creating-quick-start-tutorials.adoc b/web_console/creating-quick-start-tutorials.adoc index d9a722cc462a..0139f64a3759 100644 --- a/web_console/creating-quick-start-tutorials.adoc +++ b/web_console/creating-quick-start-tutorials.adoc @@ -34,6 +34,8 @@ include::modules/quick-start-components.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/contributing-quick-starts.adoc[leveloffset=+1] +include::modules/viewing-quick-start-api-documentation.adoc[leveloffset=+2] + include::modules/understanding-quick-start-elements.adoc[leveloffset=+2] include::modules/quick-start-adding-custom-icon.adoc[leveloffset=+2]