|
| 1 | +<!--- PR title format: [GH#<gh-issue-id>][BZ#<bz-issue-id>][OSDOCS-<jira-issue-id>]: <short-description-of-the-pr> ---> |
| 2 | + |
| 3 | +Version(s): |
| 4 | +<!--- Specify the version or versions of OpenShift your PR applies to. |
| 5 | +If your changes apply to the latest release and/or in-development version of OpenShift, open your PR against the `main` branch. ---> |
| 6 | + |
| 7 | +Issue: |
| 8 | +<!--- Add a link to the Bugzilla, Jira, or GitHub issue, if applicable. ---> |
| 9 | + |
| 10 | +Link to docs preview: |
| 11 | +<!--- Add direct link(s) to the exact page(s) with updated content from the preview build. |
| 12 | + - The preview will be generated after you open the PR. |
| 13 | + - You will need to edit the comment to add the link after the preview builds. |
| 14 | + - Review the preview build to make sure your changes are rendering properly. ---> |
| 15 | + |
| 16 | +Additional information: |
| 17 | +<!--- Optional: Include additional context or expand the description here. |
| 18 | +
|
| 19 | +Next steps after opening your PR: |
| 20 | +
|
| 21 | +* Ask for peer review from the OpenShift docs team: |
| 22 | + - For Red Hat associates: Ping @peer-review-squad requesting a review in the #forum-docs-review channel (CoreOS Slack workspace) and provide the following information: |
| 23 | + * A link to the PR. |
| 24 | + * The size of the PR that the GitHub bot assigns (ex: XS, S, M, L, XL). |
| 25 | + * If there is urgency or a deadline for the review. |
| 26 | + - For community authors: Request a review by tagging @openshift/team-documentation in a GitHub comment. |
| 27 | +
|
| 28 | + Slack is the quickest and preferred way to request a review. |
| 29 | +
|
| 30 | +* IMPORTANT: |
| 31 | + - All documentation changes must be verified by a QE team associate before merging. |
| 32 | + - Squash to one commit before submitting your PR for peer review. |
| 33 | +
|
| 34 | +* For more information about verifying your content, see: |
| 35 | + https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#verification-of-your-content |
| 36 | +
|
| 37 | +* For more information about contributing to OpenShift documentation, see: |
| 38 | + https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/contributing.adoc |
| 39 | +
|
| 40 | +Additional resources |
| 41 | +
|
| 42 | +The OpenShift docs repo adheres to the following style guides: |
| 43 | +
|
| 44 | +- OpenShift documentation guidelines (OSDOCS) |
| 45 | + https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc |
| 46 | +- Red Hat Supplementary Style Guide (SSG) |
| 47 | + https://redhat-documentation.github.io/supplementary-style-guide/ |
| 48 | +- Modular Documentation Reference Guide (Mod Docs) |
| 49 | + https://redhat-documentation.github.io/modular-docs/ |
| 50 | +- IBM Style Guide (ISG) |
| 51 | + https://www.ibm.com/docs/en/ibm-style |
| 52 | +
|
| 53 | +You can log in to the ISG by using your @redhat.com id and single sign-on (SSO) credentials. ---> |
0 commit comments