Merge pull request #51872 from kalexand-rh/template_update

template updates

Author: kalexand-rh

.github/pull_request_template.md

@@ -1,16 +1,13 @@
 <!--- PR title format: [GH#<gh-issue-id>][BZ#<bz-issue-id>][OCPBUGS#<jira-issue-id>][OSDOCS-<jira-issue-id>]: <short-description-of-the-pr> --->
 
-<!--- If your changes apply to the latest release and/or in-development version of OpenShift, open your PR against the `main` branch. --->
+<!--- If your changes apply to the latest release and/or in-development version of OpenShift, open your PR against the `main` branch.
+
+* For more details about the information requested in this template, see:
+  https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/create_or_edit_content.adoc#submit-PR --->
 
 Version(s):
 <!--- Specify the version or versions of OpenShift your PR applies to. -->
 
-<!-- Version examples:
-  * PR applies to all versions after a specific version (e.g. 4.8): 4.8+
-  * PR applies to the in-development version (e.g. 4.12) and future versions: 4.12+
-  * PR applies only to a specific single version (e.g. 4.10): 4.10
-  * PR applies to multiple specific versions (e.g. 4.8-4.10): 4.8, 4.9, 4.10 --->
-
 Issue:
 <!--- Add a link to the Bugzilla, Jira, or GitHub issue, if applicable. --->
 
@@ -21,49 +18,8 @@ QE review:
 - [ ] QE has approved this change.
 <!--- QE approval is required to merge a PR except for changes that do not impact the meaning of the docs. --->
 
-<!-- NOTE:
-Automatic preview functionality is currently only available for some branches. For PRs that update the rendered build in any way against branches that do not create an automated preview:
-  * OpenShift documentation team members (core and aligned) must include a link to a locally generated preview.
-  * External contributors can request a generated preview from the OpenShift documentation team. --->
-
 Additional information:
 <!--- Optional: Include additional context or expand the description here.--->
 
-<!--- Next steps after opening your PR:
-
-* Ask for review from the OpenShift docs team:
-  - For community authors: Request a review by tagging @openshift/team-documentation in a GitHub comment.
-  - For Red Hat associates:
-    * For normal peer requests, add a comment that contains this text: /label peer-review-needed
-    * For normal merge review requests, add a comment that contains this text: /label merge-review-needed
-    * For urgent peer review requests, ping @peer-review-squad requesting a review in the #forum-docs-review channel (CoreOS Slack workspace) and provide the following information:
-      * A link to the PR.
-      * The size of the PR that the GitHub bot assigns (ex: XS, S, M, L, XL).
-      * Details about how the PR is urgent.
-    * For urgent merge requests, ping @merge-review-squad in the #forum-docs-review channel (CoreOS Slack workspace).
-    * Except for changes that do not impact the meaning of the content, QE review is required before content is merged.
-
-* IMPORTANT:
-  - All documentation changes must be verified by a QE team associate before merging.
-  - Squash to one commit before submitting your PR for peer review.
-
-* For more information about verifying your content, see:
-  https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#verification-of-your-content
-
-* For more information about contributing to OpenShift documentation, see:
-  https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/contributing.adoc
-
-Additional resources
-
-The OpenShift docs repo adheres to the following style guides:
-
-- OpenShift documentation guidelines (OSDOCS)
-  https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc
-- Red Hat Supplementary Style Guide (SSG)
-  https://redhat-documentation.github.io/supplementary-style-guide/
-- Modular Documentation Reference Guide (Mod Docs)
-  https://redhat-documentation.github.io/modular-docs/
-- IBM Style Guide (ISG)
-  https://www.ibm.com/docs/en/ibm-style
-
-You can log in to the ISG by using your @redhat.com id and single sign-on (SSO) credentials. --->
+<!--- After you open your PR, ask for review from the OpenShift docs team:
+  For community authors: Tag @openshift/team-documentation in a GitHub comment.--->

autocomment.sh

@@ -9,8 +9,8 @@ wget https://api.travis-ci.org/v3/job/"${TRAVIS_JOB_ID}"/log.txt
 ERROR_LIST=$(grep '31m' travis-log-408052641.txt | sed -r "s/[[:cntrl:]]\[[0-9]{1,3}m//g")
 echo "" > errors.txt
 
-ALLOWED_USERS=("mburke5678" "vikram-redhat" "abrennan89" "ahardin-rh" "kalexand-rh" "adellape" "bmcelvee" "ousleyp" "lamek" "JStickler" "rh-max" "bergerhoffer" "sheriff-rh" "jboxman" "bobfuru" "aburdenthehand" "boczkowska" "Preeticp" "neal-timpe" "codyhoag" "apinnick" "bgaydosrh" "lmandavi" "maxwelldb" "pneedle-rh" "lbarbeevargas" "jeana-redhat" "RichardHoch" "johnwilkins" "sjhala-ccs" "mgarrellRH" "SNiemann15" "sfortner-RH" "jonquilwilliams" "ktania46" "wking" "
-jc-berger" "rishumehra" "aireilly" "iranzo" "abhatt-rh" "@mohit-sheth" "stoobie" "emarcusRH" "kquinn1204" "mikemckiernan" "skrthomas" "sagidlow" "rolfedh")
+ALLOWED_USERS=("mburke5678" "abrennan89" "ahardin-rh" "kalexand-rh" "adellape" "bmcelvee" "ousleyp" "rh-max" "bergerhoffer" "sheriff-rh" "jboxman" "boczkowska" "Preeticp" "neal-timpe" "apinnick" "bgaydosrh" "lmandavi" "maxwelldb" "pneedle-rh" "jeana-redhat" "RichardHoch" "johnwilkins" "sjhala-ccs" "SNiemann15" "ktania46" "wking" "
+jc-berger" "rishumehra" "aireilly" "iranzo" "abhatt-rh" "@mohit-sheth" "emarcusRH" "kquinn1204" "skrthomas" "sagidlow")
 USERNAME=${TRAVIS_PULL_REQUEST_SLUG::-15}
 
 if [ "$TRAVIS_PULL_REQUEST" != "false" ] ; then #to make sure it only runs on PRs and not all merges

contributing_to_docs/create_or_edit_content.adoc

@@ -46,13 +46,9 @@ with the remote repository.
 [NOTE]
 ====
 Because most changes in this repository must be committed to the `main`
-branch (which is the main for the 4.x stream), the following process always
-uses `main` as the name of the source
+branch, the following process uses `main` as the name of the source
 branch. If you must use another branch as the source for your change, make
 sure that you consistently use that branch name instead of `main`.
-
-When adding or updating content for version 3.11, you should create a feature
-branch against enterprise-3.11 to submit your changes.
 ====
 
 1. From your local repository, make sure you have the `main` branch checked
@@ -157,6 +153,7 @@ your GitHub repository:
 $ git push origin <feature_branch>
 ----
 
+[id="submit-PR"]
 == Submit PR to merge your work
 
 When you have pushed your changes to your GitHub account, you can submit a PR to
@@ -168,11 +165,32 @@ any further changes that are required, and finally merge your work.
 your feature branch that includes all of your work.
 2. Click on *Pull Request* to submit the PR against the `main` branch of the
 `openshift-docs` repository.
-3. If you know which product versions your change applies to, include a comment
+3. Fill out the information requested on the template.
+** If you know which product versions your change applies to, include a comment
 that specifies the minimum version that the change applies to. The docs team
 maintains these branches for all active and future distros and your PR will be
 applied to one or more of these branches.
-4. Tag the documentation team with @openshift/team-documentation (if you are a part of the OpenShift organization. If not, tag @vikram-redhat).
+*** PR applies to all versions after a specific version (e.g. 4.8): 4.8+
+*** PR applies to the in-development version (e.g. 4.12) and future versions: 4.12+
+*** PR applies only to a specific single version (e.g. 4.10): 4.10
+*** PR applies to multiple specific versions (e.g. 4.8-4.10): 4.8, 4.9, 4.10
+** Provide a link to the preview. Automatic preview functionality is currently only available for some branches. For PRs that update the rendered build in any way against branches that do not create an automated preview:
+*** OpenShift documentation team members (core and aligned) must include a link to a locally generated preview.
+*** External contributors can request a generated preview from the OpenShift documentation team.
+** All documentation changes that impact the meaning of the docs must be verified by a QE team associate before merging.
+** Provide any other information about the change that the docs team might need to understand it.
+4. Make sure that you squash to one commit before submitting your PR.
+5. Ask for review from the OpenShift docs team:
+** For community authors: Request a review by tagging @openshift/team-documentation or @kalexand-rh in a GitHub comment.
+** For Red Hat associates:
+*** For normal peer requests, add a comment that contains this text: /label peer-review-needed
+*** For normal merge review requests, add a comment that contains this text: /label merge-review-needed
+*** For urgent peer review requests, ping @peer-review-squad requesting a review in the #forum-docs-review channel (CoreOS Slack workspace) and provide the following information:
+**** A link to the PR.
+**** The size of the PR that the GitHub bot assigns (ex: XS, S, M, L, XL).
+**** Details about how the PR is urgent.
+*** For urgent merge requests, ping @merge-review-squad in the #forum-docs-review channel (CoreOS Slack workspace).
+*** Except for changes that do not impact the meaning of the content, QE review is required before content is merged.
 
 == Confirm your changes have been merged