Skip to content

[WIP] OSDOCS#2948: Updates to the OCP quick start documentation #83347

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -898,10 +898,14 @@ Topics:
File: uninstalling-web-terminal
- Name: Disabling the web console
File: disabling-web-console
Name: Quick starts
Dir: quick-starts
Distros: openshift-enterprise,openshift-origin
- Name: Creating quick start tutorials
File: creating-quick-start-tutorials
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Quick start tutorials in the web console
File: quick-starts-web-console
Name: Creating quick start tutorials
File: creating-quick-start-tutorials
- Name: Optional capabilities and products
File: capabilities_products-web-console
Distros: openshift-enterprise,openshift-origin
Expand Down
32 changes: 32 additions & 0 deletions modules/accessing-quick-starts.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Module included in the following assemblies:
//
// * web_console/about-quick-start-tutorials.adoc

:_mod-docs-content-type: PROCEDURE
[id="accessing-quick-starts_{context}"]
= Accessing quick starts

You can access quick starts under the *Getting started resources* pane on the *Overview* page of the web console.

.Prerequisites
* You have access to a {product-title} cluster with `cluster-admin` privledges. [Need to check and see if it is in dev console too]
. In the *Administrator* or *Developer* perspective, click the *Help icon* and select *Quick Starts*. (need to verify if this is in this location too)
.Procedure

. Log into the {product-title} web console using your credintials.

. There are two ways you can acccess quick start tutorials:
.. On the *Cluster Overview* page, navigate to the *Getting started resources* section and click *View all quick starts* under *Build with guided documentation*.
.. In the *Administrator* or *Developer* perspective, click the *Help icon* and select *Quick Starts*.

. Once you are on the *Quick Starts* page, click a quick start card with the topic you would like step-by-step instructions and tasks for.

. In the panel that appears, 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.
.. 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.

. After completing the final task, click *Close* to close the quick start.
25 changes: 0 additions & 25 deletions modules/quick-start-components.adoc

This file was deleted.

23 changes: 0 additions & 23 deletions modules/quick-start-user-workflow.adoc

This file was deleted.

29 changes: 17 additions & 12 deletions modules/quick-starts-accessing-and-executing-code-snippets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,28 @@
//
// * web_console/creating-quick-start-tutorials.adoc

:_mod-docs-content-type: PROCEDURE
[id="quick-starts-accessing-and-executing-code-snippets_{context}"]
= Code snippet markdown reference
= Code snippet markdown syntax

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.
You can execute a CLI code snippet when it is included in a quick start from the web console.

[id="quick-starts-syntax-for-inline-code-snippets_{context}"]
== Syntax for inline code snippets
.Prerequisites
* You have access to a {product-title} cluster with `cluster-admin` privledges.

.Procedure

. Copy an in-line or multi-line code snippet to the clipboard.

.. Syntax for inline code snippets
+
----
`code block`{{copy}}
`code block`{{execute}}
----

[NOTE]
====
If the `execute` syntax is used, the *Copy to clipboard* action is present whether you have the Web Terminal Operator installed or not.
====

[id="quick-starts-syntax-for-multi-line-code-snippets_{context}"]
== Syntax for multi-line code snippets

.. Syntax for multi-line code snippets
+
----
```
multi line code block
Expand All @@ -32,3 +33,7 @@ multi line code block
multi line code block
```{{execute}}
----

. Optional: Install the Web Terminal Operator.


74 changes: 0 additions & 74 deletions modules/quick-starts-supported-tags.adoc

This file was deleted.

24 changes: 0 additions & 24 deletions modules/understanding-quick-starts.adoc

This file was deleted.

1 change: 1 addition & 0 deletions web_console/quick-starts/_attributes
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,7 @@ toc::[]

If you are creating quick start tutorials for the {product-title} web console, follow these guidelines to maintain a consistent user experience across all quick starts.

include::modules/understanding-quick-starts.adoc[leveloffset=+1]

include::modules/quick-start-user-workflow.adoc[leveloffset=+1]

include::modules/quick-start-components.adoc[leveloffset=+1]

// Hiding in ROSA/OSD, as dedicated-admins cannot create "consolequickstarts" resource
// Hiding in ROSA/OSD, as dedicated-admins cannot create "consolequickstarts" resource
ifndef::openshift-rosa,openshift-dedicated[]
include::modules/contributing-quick-starts.adoc[leveloffset=+1]

Expand All @@ -35,12 +29,16 @@ include::modules/quick-start-limiting-access.adoc[leveloffset=+2]

include::modules/quick-starts-linking-to-others.adoc[leveloffset=+2]

include::modules/quick-starts-supported-tags.adoc[leveloffset=+2]

include::modules/quick-starts-highlighting-reference.adoc[leveloffset=+2]

include::modules/quick-starts-accessing-and-executing-code-snippets.adoc[leveloffset=+2]

//[id="quick-start-code-snippet-additional-resources"]
//[role="_additional-resources"]
//== Additional resources

//* xref:../web terminal operator

include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]

[id="quick-start-tutorials-additional-resources"]
Expand All @@ -50,3 +48,4 @@ include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
* For voice and tone requirements, refer to link:https://www.patternfly.org/v4/ux-writing/brand-voice-and-tone[PatternFly's brand voice and tone guidelines].
* For other UX content guidance, refer to all areas of link:https://www.patternfly.org/v4/ux-writing/about[PatternFly's UX writing style guide].
endif::openshift-rosa,openshift-dedicated[]
* For a cheat sheet of supported markdown tags, refer to link:https://www.markdownguide.org/cheat-sheet/[Markdwon Cheat Sheet].
1 change: 1 addition & 0 deletions web_console/quick-starts/images
1 change: 1 addition & 0 deletions web_console/quick-starts/modules
13 changes: 13 additions & 0 deletions web_console/quick-starts/quick-starts-web-console.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
:_mod-docs-content-type: ASSEMBLY
[id="creating-quick-start-tutorials"]
= Quick start tutorials in the web console
include::_attributes/common-attributes.adoc[]
:context: quick-start-tutorials

toc::[]

A quick start is a guided tutorial with user tasks in the {product-title} web console. With quick starts, you can get oriented with an application, Operator, or other product offering.

A quick start primarily consists of tasks and steps. Each task has multiple steps, and each quick start has multiple tasks.

include::modules/accessing-quick-starts.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions web_console/quick-starts/snippets