Skip to content

Commit df180a9

Browse files
authored
Merge pull request #33014 from ahardin-rh/quick-start-highlight
OSDOCS-2088: Added a Quick Start highlighting markdown reference
2 parents f86c451 + fa7005e commit df180a9

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * web_console/creating-quick-start-tutorials.adoc
4+
5+
[id="quick-start-highlighting-reference_{context}"]
6+
= Quick start highlighting markdown reference
7+
8+
The highlighting, or hint, feature enables Quick Starts to contain a link that can highlight and animate a component of the web console.
9+
10+
The markdown syntax contains:
11+
12+
* Bracketed link text
13+
* The `highlight` keyword, followed by the ID of the element that you want to animate
14+
15+
[id="quick-start-highlighting-perspective-switcher_{context}"]
16+
== Perspective switcher
17+
18+
[source,yaml]
19+
----
20+
[Perspective switcher]{{highlight qs-perspective-switcher}}
21+
----
22+
23+
[id="quick-start-highlighting-admin-perspective_{context}"]
24+
== Administrator perspective navigation links
25+
26+
[source,yaml]
27+
----
28+
[Home]{{highlight qs-nav-home}}
29+
[Operators]{{highlight qs-nav-operators}}
30+
[Workloads]{{highlight qs-nav-workloads}}
31+
[Serverless]{{highlight qs-nav-serverless}}
32+
[Networking]{{highlight qs-nav-networking}}
33+
[Storage]{{highlight qs-nav-storage}}
34+
[Service catalog]{{highlight qs-nav-servicecatalog}}
35+
[Compute]{{highlight qs-nav-compute}}
36+
[User management]{{highlight qs-nav-usermanagement}}
37+
[Administration]{{highlight qs-nav-administration}}
38+
----
39+
40+
[id="quick-start-highlighting-dev-perspective_{context}"]
41+
== Developer perspective navigation links
42+
43+
[source,yaml]
44+
----
45+
[Add]{{highlight qs-nav-add}}
46+
[Topology]{{highlight qs-nav-topology}}
47+
[Search]{{highlight qs-nav-search}}
48+
[Project]{{highlight qs-nav-project}}
49+
[Helm]{{highlight qs-nav-helm}}
50+
----
51+
52+
[id="quick-start-highlighting-common-nav_{context}"]
53+
== Common navigation links
54+
55+
[source,yaml]
56+
----
57+
[Builds]{{highlight qs-nav-builds}}
58+
[Pipelines]{{highlight qs-nav-pipelines}}
59+
[Monitoring]{{highlight qs-nav-monitoring}}
60+
----
61+
62+
[id="quick-start-highlighting-masthead-links_{context}"]
63+
== Masthead links
64+
65+
[source,yaml]
66+
----
67+
[CloudShell]{{highlight qs-masthead-cloudshell}}
68+
[Utility Menu]{{highlight qs-masthead-utilitymenu}}
69+
[User Menu]{{highlight qs-masthead-usermenu}}
70+
[Applications]{{highlight qs-masthead-applications}}
71+
[Import]{{highlight qs-masthead-import}}
72+
[Help]{{highlight qs-masthead-help}}
73+
[Notifications]{{highlight qs-masthead-notifications}}
74+
----

web_console/creating-quick-start-tutorials.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ include::modules/quick-starts-linking-to-others.adoc[leveloffset=+2]
2525

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

28+
include::modules/quick-starts-highlighting-reference.adoc[leveloffset=+2]
29+
2830
include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
2931

3032
[id="quick-start-tutorials-additional-resources"]

0 commit comments

Comments
 (0)