From fd12840f376f8c0c2b1dbefb2ed59db1f1107547 Mon Sep 17 00:00:00 2001 From: Dayle Date: Wed, 14 Aug 2024 23:02:16 +0200 Subject: [PATCH] Update quick start template with style guides Added link to Best Practices for quick starts doc, updated the OCP docs link to version 4.16 (most recent) --- packages/dev/src/quickstarts-data/yaml/template.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/dev/src/quickstarts-data/yaml/template.yaml b/packages/dev/src/quickstarts-data/yaml/template.yaml index 3d5a5435..94fa8395 100644 --- a/packages/dev/src/quickstarts-data/yaml/template.yaml +++ b/packages/dev/src/quickstarts-data/yaml/template.yaml @@ -120,8 +120,11 @@ spec: failed: Shows a failed message in the task header - title: Task 2 title description: |- + See _Best practices for writing quick starts_ on UXD Hub for style and structural guidelines, plus more info about writing content for sections in this template: + [https://www.uxd-hub.com/entries/resource/best-practices-for-writing-quick-starts] + For more information, the folks at OpenShift wrote a nice guide here: - [Creating quick starts](https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html) + [Creating quick starts](https://docs.openshift.com/container-platform/4.16/web_console/creating-quick-start-tutorials.html) Also, don't forget to [check out the source](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/template.yaml) for this quick start for more information!