Update ADMINS.md #341
Update ADMINS.md #341
Conversation
Update admins info based on opensearch-project/OpenSearch#18445 (comment) and update other stale info. Signed-off-by: Sandesh Kumar <[email protected]>
sandeshkr419
requested review from
CEHENKLE,
dblock,
mch2,
peternied and
saratvemulapalli
as code owners
Signed-off-by: Sandesh Kumar <[email protected]>
ADMINS.md
Outdated
| ## Admin Permissions | ||
|
|
||
| Admins have [admin-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and protect the repository as follows. | ||
| Admins are granted [admin-level permissions](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) on a repository. These privileges should be utilized to serve the project community and protect the repositories as follows: |
There was a problem hiding this comment.
Would it be more correct to say that admins have permissions across all repositories in the opensearch-project organization?
There was a problem hiding this comment.
I think yes. Will reword it accordingly.
ADMINS.md
Outdated
| Perform administrative tasks, such as [adding](RESPONSIBILITIES.md#adding-a-new-maintainer) and [removing maintainers](RESPONSIBILITIES.md#removing-a-maintainer). | ||
|
|
||
| Please note that maintainers typically do not have admin-level permissions in their repos in this organization. Admin-level permissions allow for sensitive and destructive actions, such as managing security, or deleting a repository. Therefore, admin access in opensearch-project was designed to be deliberately centralized in ways that requires that two people to make any one sensitive change. If you need to perform an admin function, such as adding or removing a maintainer, please [follow the maintainer nomination process](RESPONSIBILITIES.md#becoming-a-maintainer), then ask to effect permissions by tagging `@admin` in your pull request, or the [#maintainers channel on the public Slack](https://opensearch.slack.com/archives/C05L60S4UBT). One of the above-mentioned admins will make this change for you. | ||
| Please note that maintainers typically do not have admin-level permissions in their repos in this organization. Admin-level permissions allow for sensitive and destructive actions, such as managing security, or deleting a repository. Therefore, admin access in opensearch-project was designed to be deliberately centralized in ways that requires that two people to make any one sensitive change. If you need to perform an admin function, such as adding or removing a maintainer, please [follow the maintainer nomination process](RESPONSIBILITIES.md#becoming-a-maintainer), then ask to effect permissions by tagging `@opensearch-project/admin` in your pull request, or the [#admin-requests](https://opensearch.slack.com/archives/C051CKVFB2A) channel on the public Slack. One of the admins will review and help facilitate this change for you. |
There was a problem hiding this comment.
If we're updating this paragraph anyway, I believe the current process involves opening an issue in this (.github) repository that references the PR in the repository where you're adding a maintainer.
For example, I recently opened #337 which pointed to opensearch-project/OpenSearch#18384, which has the nomination details.
In a nutshell, the process is:
- Go through the maintainer nomination / removal process.
- Open a PR on the repo where the new maintainer is getting added / removed, including details of the process from step 1 (minus individual votes).
- Open an issue on the .github repo with a link to the PR from step 2.
- Once the admins have updated permissions and resolved the .github issue, merge the PR from step 2.
There was a problem hiding this comment.
If you need to perform an admin function, such as adding or removing a maintainer, please follow the maintainer nomination process, then ask to effect permissions by tagging @opensearch-project/admin in your pull request, or the #admin-requests channel on the public Slack. One of the admins will review and help facilitate this change for you.
If you need to perform an admin function, such as adding or removing a maintainer, please follow the maintainer nomination process, then ask to effect permissions by opening a issue in .github repo. One of the admins will review and help facilitate this change for you.
How does this rewording looks like?
Not linking destructive action links (like removing a maintainer) on removing permissions just to keep a positive tone and keep this section concise and just to state the current process.
Signed-off-by: Sandesh Kumar <[email protected]>
Signed-off-by: Sandesh Kumar <[email protected]>
|
@msfroh Thanks for suggestive improvements. I have reworded those sections. Please check when you get a chance. |
4 participants
Description
Update admins info based on opensearch-project/OpenSearch#18445 (comment) and update other stale info.
Issues Resolved
Stale info.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.