Skip to content

Commit

Permalink
updates per doc squad feedback
Browse files Browse the repository at this point in the history
Signed-off-by: anaxceron <[email protected]>
  • Loading branch information
anaxceron committed Dec 13, 2023
1 parent 55aecbc commit 2617e96
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
9 changes: 5 additions & 4 deletions .github/pr-comments/for-community.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
: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.
Certain labels are needed to open a pull request in the `docs-site` repo, but it looks like you may not be able to add labels. That's because you either do not have permissions 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.
- [ ] Use comments to add labels to your pull request. Enter the `/labels` command in a comment to add the required `review`, `area`, and `release` label types.
- Example: Enter `/labels doc cli V2` to add the `review: doc`, `area: cli`, and `version: V2` labels to your PR.
- 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.
- See the [docs-site labels](https://github.com/zowe/docs-site/issues/labels) to see the labels are available for use.
- 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.
- [ ] 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. Use the `v3-doc-branch` for Zowe V3 content.
- [ ] 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.
2 changes: 1 addition & 1 deletion .github/pr-comments/for-labeller.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- [ ] 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: `release: V1`, `release: V2`, `release: V3`)
- [ ] Specify the major Zowe release(s) 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.

Expand Down
2 changes: 1 addition & 1 deletion .github/pr-comments/for-writer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- [ ] 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: `release: V1`, `release: V2`, `release: V3`)
- [ ] Specify the major Zowe release(s) 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

0 comments on commit 2617e96

Please sign in to comment.