mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
61 lines
2.5 KiB
Plaintext
61 lines
2.5 KiB
Plaintext
ifndef::openshift-rosa,openshift-dedicated[]
|
|
:_mod-docs-content-type: ASSEMBLY
|
|
[id="creating-quick-start-tutorials"]
|
|
= Creating quick start tutorials in the web console
|
|
|
|
include::_attributes/common-attributes.adoc[]
|
|
include::_attributes/attributes-openshift-dedicated.adoc[]
|
|
:context: creating-quick-start-tutorials
|
|
endif::openshift-rosa,openshift-dedicated[]
|
|
ifdef::openshift-rosa,openshift-dedicated[]
|
|
:_mod-docs-content-type: ASSEMBLY
|
|
[id="creating-quick-start-tutorials"]
|
|
= About quick start tutorials
|
|
|
|
include::_attributes/common-attributes.adoc[]
|
|
include::_attributes/attributes-openshift-dedicated.adoc[]
|
|
:context: creating-quick-start-tutorials
|
|
endif::openshift-rosa,openshift-dedicated[]
|
|
|
|
toc::[]
|
|
|
|
[role="_abstract"]
|
|
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
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.
|
|
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
|
|
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
|
|
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
include::modules/contributing-quick-starts.adoc[leveloffset=+1]
|
|
|
|
include::modules/understanding-quick-start-elements.adoc[leveloffset=+2]
|
|
|
|
include::modules/quick-start-adding-custom-icon.adoc[leveloffset=+2]
|
|
|
|
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]
|
|
|
|
include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
|
|
|
|
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
|
|
[id="quick-start-tutorials-additional-resources"]
|
|
[role="_additional-resources"]
|
|
== Additional resources
|
|
|
|
* link:https://www.uxd-hub.com/entries/resource/best-practices-for-writing-quick-starts[Best practices for writing quick starts]
|
|
* link:https://www.patternfly.org/ux-writing/brand-voice-and-tone[PatternFly's brand voice and tone guidelines]
|
|
* link:https://www.patternfly.org/ux-writing/about[PatternFly's UX writing style guide] |