Skip to content

Commit

Permalink
Merge pull request #3248 from zowe/anax-test-branch-updatedcomments
Browse files Browse the repository at this point in the history
updating comments; adding community member comment
  • Loading branch information
anaxceron authored Nov 10, 2023
2 parents 289d694 + 66b51c5 commit 3d8471d
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 9 deletions.
13 changes: 12 additions & 1 deletion .github/pr-comments/for-community.md
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
Please use the "/labels" command
:smiley_cat: Thank you for creating this PR!

Looks like you either do not have permissions to add labels in the `docs-site` repo, or you are using a fork in your PR. To publish your content to [Zowe Docs](https://docs.zowe.org/), follow these steps.

- [ ] Enter the `/labels` command in a comment to add required `review`, `area`, and `release` labels to your pull request.
- The `review` label indicates the kind of review your content requires. The `area` label indicates the content topic area. The `release` labels tells us the major release aligned with your content.
- Example: Enter `/labels doc cli V2` to add the `review: doc`, `area: cli`, and `version: V2` labels to your PR.
- To remove a label, use the minus sign: `/labels -V2`
- [ ] Select the `master` branch if your PR updates content that is on the **live site**. Select `docs-staging` if your PR updates content for a future release.
- [ ] Notify the Doc Squad about this PR. If you don't know whom should review your content, message the [#zowe-doc](https://openmainframeproject.slack.com/archives/CC961JYMQ) Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

**Need help?** Contact the Doc Squad in the [#zowe-doc](https://openmainframeproject.slack.com/archives/CC961JYMQ) Slack channel.
8 changes: 4 additions & 4 deletions .github/pr-comments/for-labeller.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:smiley_cat: Thank you for creating this PR! To publish your content to [Zowe Docs](https://docs.zowe.org/), follow these required steps.

- [ ] Add the label `needs review by doc`.
- [ ] Add the label `review: doc`.
- [ ] Identify your content topic with a label. (Examples: `area: apiml`, `area: cli`, `area: install and config`, etc.)
- [ ] Specify the major Zowe release for your content. (Examples: `V1`, `V2`, `V3`.)
- [ ] Select the `master` branch if your PR updates content that is on the live site. Select `docs-staging` if your PR updates content for a future release.
- [ ] Notify the Doc Squad about this PR. If you don't know who should review your content, message the [#zowe-doc](https://openmainframeproject.slack.com/archives/CC961JYMQ) Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.
- [ ] Specify the major Zowe release for your content. (Examples: `release: V1`, `release: V2`, `release: V3`)
- [ ] Select the `master` branch if your PR updates content that is on the **live site**. Select `docs-staging` if your PR updates content for a future release.
- [ ] Notify the Doc Squad about this PR. If you don't know whom should review your content, message the [#zowe-doc](https://openmainframeproject.slack.com/archives/CC961JYMQ) Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

**Need help?** Contact the Doc Squad in the [#zowe-doc](https://openmainframeproject.slack.com/archives/CC961JYMQ) Slack channel.
4 changes: 2 additions & 2 deletions .github/pr-comments/for-writer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:smiley_cat: Thank you for creating this PR! To publish your content to [Zowe Docs](https://docs.zowe.org/), follow these steps.

- [ ] Add the label `needs review by sme` if an SME needs to check your content.
- [ ] Add the label `review: sme` if an SME needs to check your content.
- [ ] Identify your content topic with a label. (Examples: `area: apiml`, `area: cli`, `area: install and config`, etc.)
- [ ] Specify the major Zowe release for your content. (Examples: `V1`, `V2`, `V3`.)
- [ ] Specify the major Zowe release for your content. (Examples: `release: V1`, `release: V2`, `release: V3`)
- [ ] Link any [Doc Issues](https://github.com/zowe/docs-site/issues) related to this PR.
- [ ] Fix broken links found in your content areas.
- [ ] Notify the SME to review this PR (if applicable).
Expand Down
10 changes: 8 additions & 2 deletions .github/workflows/pull-request-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ jobs:
repo-token: ${{ secrets.GITHUB_TOKEN }}
template-path: "./.github/pull_request_template.md"
comment: true
comment-empty-description: ":warning: Looks like something is wrong with the PR description. Remember to include a description and the file(s) included in this PR."
comment-template-not-filled: ":warning: Looks like we're missing description information. Please answer both description prompts."
comment-empty-description: ":warning: Looks like something is wrong with the PR description. Remember to include a description and the file(s) included in this PR.
If you have addressed this issue already, refresh your browser to remove this comment."
comment-template-not-filled: ":warning: Looks like we're missing description information.
If you have addressed this issue already, refresh your browser to remove this comment."
- name: Check PR
id: file_type_checker
uses: JJ/github-pr-contains-action@releases/v10
Expand All @@ -71,6 +73,7 @@ jobs:
header: File name is missing
message: |
:file_folder: The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our [Zowe Docs GitHub Slack channel](https://openmainframeproject.slack.com/archives/C05GH3LT59D).
If you have addressed this issue already, refresh your browser to remove this comment.
review-labels:
name: Check for missing review label
Expand All @@ -93,6 +96,7 @@ jobs:
header: Review label missing
message: |
:mag: The **review** label is missing. Add a `needs review by` label so we can determine who needs to approve this PR.
If you have addressed this issue already, refresh your browser to remove this comment.
- name: Fixed Review Label Comment PR
if: success()
uses: marocchino/sticky-pull-request-comment@v2
Expand Down Expand Up @@ -120,6 +124,7 @@ jobs:
header: Release label missing
message: |
:floppy_disk: The **release** label is missing. Add a `current release` or `next release` label so your content is published with the correct Zowe release.
If you have addressed this issue already, refresh your browser to remove this comment.
- name: Fixed Release Label Comment PR
if: success()
uses: marocchino/sticky-pull-request-comment@v2
Expand Down Expand Up @@ -147,6 +152,7 @@ jobs:
header: Area label missing
message: |
:pushpin: The **subject area** label is missing. Add an `area:` label so we know what your content is about.
If you have addressed this issue already, refresh your browser to remove this comment.
- name: Fixed Area Label Comment PR
if: success()
uses: marocchino/sticky-pull-request-comment@v2
Expand Down

0 comments on commit 3d8471d

Please sign in to comment.