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

Anax test branch #3273

Merged
merged 92 commits into from
Jan 4, 2024
Merged

Anax test branch #3273

merged 92 commits into from
Jan 4, 2024

Conversation

anaxceron
Copy link
Collaborator

@anaxceron anaxceron commented Nov 27, 2023

Introduces updated instructions for pull requests opened in the docs-site repository.

Instructions to have Zowe Docs content reviewed/published are provided based on the type of user that opens a pull request, and the labels the user adds to the pull request.

Instructions presented to TSC in November and subsequently updated after receiving feedback. These PR instructions have now been updated to be used by committers, contributors, and people who do not have the access to add labels to issues or PRs in this repo.

anaxceron added 30 commits July 7, 2023 15:33
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
Signed-off-by: anaxceron <[email protected]>
@anaxceron anaxceron added the area: docs Documentation issue or issues that have documentation impact label Nov 27, 2023
@anaxceron anaxceron self-assigned this Nov 27, 2023
Copy link

github-actions bot commented Nov 27, 2023

@github-actions github-actions bot temporarily deployed to pull request November 27, 2023 20:41 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 29, 2023 19:08 Inactive

- [ ] 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`)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, for v3, it seems like a good idea to inform the PR opener to target the v3 branch. Glad we discussed this. ;-)

Copy link
Collaborator

@janan07 janan07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These refactored instructions look much clearer than what we currently have. I still think it would be great to automate the reviewer list from the community to automatically add the list of doc squad members to sign off on it, but I understand that creating this automation creates extra work for our dev support, so I agree that this PR is good to merge now and perhaps we can add this functionality at some point in the future. Great job with this PR!

@github-actions github-actions bot temporarily deployed to pull request December 13, 2023 21:14 Inactive
- [ ] 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).
- [ ] Merge to the `master` branch if your PR updates content that is on the live site. Merge to `docs-staging` if your PR updates content for a future release.
Copy link
Collaborator

@janan07 janan07 Jan 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if this point is necessary or could perhaps cause someone to open a PR against a different branch than that which was used as the base branch (e.g. someone opens a new branch against docs-staging, but then targets the master branch). Maybe it would be best to say to target the branch that was used to base your PR branch.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@janan07 That would be the intent -- to remind folks that the live changes use the master branch and changes for the future use the docs-staging branch. So if their base branch doesn't align w/ this, then, yep, they'd need to change their branch to align w/ our branching strategy.

@github-actions github-actions bot temporarily deployed to pull request January 4, 2024 19:37 Inactive
@anaxceron anaxceron merged commit 40f0c55 into master Jan 4, 2024
3 of 4 checks passed
@anaxceron anaxceron deleted the anax-test-branch branch January 4, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Documentation issue or issues that have documentation impact
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants