Skip to content
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

Add a link to the quick start style guidelines #515

Open
dayleparker opened this issue Aug 30, 2024 · 0 comments
Open

Add a link to the quick start style guidelines #515

dayleparker opened this issue Aug 30, 2024 · 0 comments

Comments

@dayleparker
Copy link
Contributor

I'd like to propose adding a link to the Best practices for writing quick starts resource to this guide to help those writing that content type.
As there doesn't appear to be sections by content type (although quick starts are mentioned in a few places), I wasn't sure of the best location and would rather trust the SSG maintainers to decide.

The UXD Hub resource was created by Red Hat UXD & docs teams and combines style guidance for writing PatternFly quick start content that we found spread across multiple links and sites:
https://www.uxd-hub.com/entries/resource/best-practices-for-writing-quick-starts

The aim is to help content creators and reviewers create more consistent quick starts following a single source of truth, especially in the Red Hat Hybrid Cloud Console (content was also sourced from the OpenShift docs link). See HCCDOC-2517 for more info on this initiative.

I've been adding the link to various sites, so feel free to reuse the language from PRs such as
https://github.com/patternfly/patternfly-quickstarts/pull/322/files or RedHatInsights/quickstarts#245, or the Content Types Source page. Let me know if I can help with this - thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant