From 60ff4bd4a8f25da168d836732a04b5b47e0bcea7 Mon Sep 17 00:00:00 2001 From: Nikhita Raghunath Date: Wed, 2 Jan 2019 16:31:46 +0530 Subject: [PATCH] github-management: fix markdown formatting --- github-management/kubernetes-repositories.md | 26 +++++++++++--------- github-management/permissions.md | 5 ++-- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/github-management/kubernetes-repositories.md b/github-management/kubernetes-repositories.md index 6e3b4905f..22133bc94 100644 --- a/github-management/kubernetes-repositories.md +++ b/github-management/kubernetes-repositories.md @@ -65,7 +65,7 @@ from a central body (e.g. steering committee or sig-architecture) ### Rules for new repositories - * For now all repos will live in github.com/kubernetes-sigs/\. + * For now all repos will live in `github.com/kubernetes-sigs/\`. * Must contain the topic for the sponsoring SIG - e.g. `k8s-sig-api-machinery`. (Added through the *Manage topics* link on the repo page.) @@ -108,7 +108,9 @@ in official Kubernetes releases. Additionally, the kubernetes.io website, k8s.io machinery, and other project-wide infrastructure will remain in the kubernetes github organization. -### Goals Create a broader base of repositories than the existing +### Goals + +Create a broader base of repositories than the existing gh/kubernetes/kubernetes so that the project can scale. Present expectations about the centrality and importance of the repository in the Kubernetes ecosystem. Carries the endorsement of the Kubernetes community. @@ -158,16 +160,16 @@ circumstances (e.g. a code of conduct violation). When a repository has been deemed eligible for removal, we take the following steps: - * Ownership of the repo is transferred to the [kubernetes-retired] GitHub - organization - * The repo description is edited to start with the phrase "[EOL]" - * All open issues and PRs are closed - * All external collaborators are removed - * All webhooks, apps, integrations or services are removed - * GitHub Pages are disabled - * The repo is marked as archived using [GitHub's archive feature] - * The removal is announced on the kubernetes-dev mailing list and community - meeting + * Ownership of the repo is transferred to the [kubernetes-retired] GitHub + organization + * The repo description is edited to start with the phrase "[EOL]" + * All open issues and PRs are closed + * All external collaborators are removed + * All webhooks, apps, integrations or services are removed + * GitHub Pages are disabled + * The repo is marked as archived using [GitHub's archive feature] + * The removal is announced on the kubernetes-dev mailing list and community + meeting This maintains the complete record of issues, PRs and other contributions, leaves the repository read-only, and makes it clear that the repository should diff --git a/github-management/permissions.md b/github-management/permissions.md index ba036fee3..83a4f56cc 100644 --- a/github-management/permissions.md +++ b/github-management/permissions.md @@ -29,8 +29,7 @@ Therefore, we are very cautious about giving more people this access than really need it. There are certain actions that require org owner access: -- Invite or remove members from the organization (in future, will be handled by - [peribolos]) +- Invite or remove members from the organization (handled by [peribolos]) - Access the organization audit log - Create new repositories - Transfer repositories @@ -69,7 +68,7 @@ In most cases, this level of access should not be necessary as the majority of actions will be able to be implemented by automation. Certain actions like creating a release may still need this level of access. -**// TODO(cblecker):** Define specific roles that need this. + ### Write