Create docs role handbook #2628
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: nannanli <nannanli@cn.ibm.com>
nannanli
requested review from
janan07,
lparadkar-rocket,
nellietan,
samanthasusu and
anaxceron
✅ Deploy Preview for zowe-docs-master ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
anaxceron
requested changes
Feb 3, 2023
Signed-off-by: nannanli <nannanli@cn.ibm.com>
Signed-off-by: nannanli <nannanli@cn.ibm.com>
| Identify and track new Zowe documentation requests and feedback in other channels like Slack, provide response, and convert into actionable issues | Slack, meetings where invited, emails | Depends, usually 2-3 hours a week | As a squad lead, you'll be the go-to-person whenever people have questions, comments, or ideas about documentation so might get involved in different discussions. | ||
| Offer guidance to doc contributors about the doc site process and answer questions | Slack, GitHub repo | On demand, usually <1 hour a week depending on the complexity of help needed | New developers in other squads are also doc contributors. Introduce new contributors to the doc process and empower them with the knowledge needed to get started. | ||
| Maintain and optimize documentation processes and update the instructions | Zowe docs-site repo | Depends | Release handbook, maintainer handbook, contributing guidelines, release process, PR review guide, issue triage guide, etc. | ||
| Identify overall documentation improvement areas and lead the squad to discuss and take action | / | Depends | For example, overall architectural change that requires squad collaboration and discussion, initiatives from other squads that need doc participation. |
There was a problem hiding this comment.
Collaboration needed here.
| ---| ---| ---| --- | ||
| Monitor Zowe docs-site issues and assign owners | Zowe docs-site GitHub repo | 1-2 hours a week | Looking to automate the process | ||
| Monitor Zowe doc-site Pull Requests and assign reviewers | Zowe docs-site GitHub repo | 1 hour a week | | ||
| Identify and track new Zowe documentation requests and feedback in other channels like Slack, provide response, and convert into actionable issues | Slack, meetings where invited, emails | Depends, usually 2-3 hours a week | As a squad lead, you'll be the go-to-person whenever people have questions, comments, or ideas about documentation so might get involved in different discussions. |
There was a problem hiding this comment.
Collaboration needed here. Members might have different channels to collect feedback and receive requests, and can work together on the response or actions. And the communicator could be a volunteer or the one who receives the request.
nellietan
reviewed
Feb 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: nannanli nannanli@cn.ibm.com
Your checklist for this pull request
🚨Please review the guidelines for contributing to this repository.
If the changes in this PR is part of the next future release, make this pull request against the docs-staging branch which will be published at the next release boundary. If the changes in this PR are part of the current release, use the default base branch, master. For more information about branches, see https://github.com/zowe/docs-site/tree/master#understanding-the-doc-branches.
If this PR relates to GitHub issues in
docs-siteor other repositories, please list in Description, prefixed with close, fix or resolve keywords.Description (including links to related git issues)
Please describe your pull request.
❤️Thank you!