Skip to content

Commit 7f25c1c

Browse files
committed
OSDOCS#2948: Updates to the OCP quick start documentation
1 parent 6c2d011 commit 7f25c1c

11 files changed

+55
-111
lines changed

_topic_maps/_topic_map.yml

+7-2
Original file line numberDiff line numberDiff line change
@@ -898,9 +898,14 @@ Topics:
898898
File: uninstalling-web-terminal
899899
- Name: Disabling the web console
900900
File: disabling-web-console
901+
Name: Quick starts
902+
Dir: quick-starts
901903
Distros: openshift-enterprise,openshift-origin
902-
- Name: Creating quick start tutorials
903-
File: creating-quick-start-tutorials
904+
Topics:
905+
- Name: Understanding quick start tutorials in the web console
906+
File: Understanding-quick-starts-web-console
907+
Name: Creating quick start tutorials
908+
File: creating-quick-start-tutorials
904909
Distros: openshift-enterprise,openshift-origin
905910
- Name: Optional capabilities and products
906911
File: capabilities_products-web-console

modules/accessing-quick-starts.adoc

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * web_console/about-quick-start-tutorials.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="accessing-quick-starts_{context}"]
7+
= Accessing quick starts
8+
9+
You can access quick starts under the *Getting started resources* pane on the *Overview* page of the web console.
10+
11+
.Prerequisites
12+
* You have access to a {product-title} cluster with `cluster-admin` privledges. [Need to check and see if it is in dev console too]
13+
14+
.Procedure
15+
16+
. Log into the {product-title} web console using your credintials.
17+
18+
. On the *Cluster Overview* page, navigate to the *Getting started resources* section and click *View all quick starts* under *Build with guided documentation*.
19+
20+
. Once you are on the *Quick Starts* page, you can select a topic you would like step-by-step instructions and tasks for.

modules/quick-starts-accessing-and-executing-code-snippets.adoc

+3-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
[id="quick-starts-accessing-and-executing-code-snippets_{context}"]
66
= Code snippet markdown reference
77

8-
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.
8+
You can execute a CLI code snippet when it is included in a quick start from the web console. To use this feature, you can:
9+
* Install the Web Terminal Operator.
10+
* Copy a code snippet to the clipboard regardless of whether you have the Web Terminal Operator installed or not.
911

1012
[id="quick-starts-syntax-for-inline-code-snippets_{context}"]
1113
== Syntax for inline code snippets
@@ -15,11 +17,6 @@ You can execute a CLI code snippet when it is included in a quick start from the
1517
`code block`{{execute}}
1618
----
1719

18-
[NOTE]
19-
====
20-
If the `execute` syntax is used, the *Copy to clipboard* action is present whether you have the Web Terminal Operator installed or not.
21-
====
22-
2320
[id="quick-starts-syntax-for-multi-line-code-snippets_{context}"]
2421
== Syntax for multi-line code snippets
2522

modules/quick-starts-supported-tags.adoc

-74
This file was deleted.

modules/understanding-quick-starts.adoc

-24
This file was deleted.

web_console/quick-starts/_attributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

web_console/creating-quick-start-tutorials.adoc renamed to web_console/quick-starts/creating-quick-start-tutorials.adoc

+8-5
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,11 @@ toc::[]
1717

1818
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.
1919

20-
include::modules/understanding-quick-starts.adoc[leveloffset=+1]
21-
2220
include::modules/quick-start-user-workflow.adoc[leveloffset=+1]
2321

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

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

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

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

38-
include::modules/quick-starts-supported-tags.adoc[leveloffset=+2]
39-
4036
include::modules/quick-starts-highlighting-reference.adoc[leveloffset=+2]
4137

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

40+
//[id="quick-start-code-snippet-additional-resources"]
41+
//[role="_additional-resources"]
42+
//== Additional resources
43+
44+
//* xref:../web terminal operator
45+
4446
include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
4547

4648
[id="quick-start-tutorials-additional-resources"]
@@ -50,3 +52,4 @@ include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
5052
* 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].
5153
* 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].
5254
endif::openshift-rosa,openshift-dedicated[]
55+
* For a cheat sheet of supported markdown tags, refer to link:https://www.markdownguide.org/cheat-sheet/[Markdwon Cheat Sheet].

web_console/quick-starts/images

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

web_console/quick-starts/modules

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

web_console/quick-starts/snippets

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="creating-quick-start-tutorials"]
3+
= Understanding quick start tutorials in the web console
4+
include::_attributes/common-attributes.adoc[]
5+
:context: understanding-quick-start-tutorials
6+
7+
toc::[]
8+
9+
A quick start is a guided tutorial with user tasks in the {product-title} web console. They are especially useful for getting oriented with an application, Operator, or other product offering.
10+
11+
A quick start primarily consists of tasks and steps. Each task has multiple steps, and each quick start has multiple tasks.
12+
13+
include::modules/accessing-quick-starts.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)