Skip to content

Commit

Permalink
github-management: fix markdown formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhita committed Jan 2, 2019
1 parent 76ecb46 commit 60ff4bd
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
26 changes: 14 additions & 12 deletions github-management/kubernetes-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/\<project-name\>.
* For now all repos will live in `github.com/kubernetes-sigs/\<project-name\>`.
* Must contain the topic for the sponsoring SIG - e.g.
`k8s-sig-api-machinery`. (Added through the *Manage topics* link on the
repo page.)
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions github-management/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
<!--- TODO(cblecker): Define specific roles that need this. -->

### Write

Expand Down

0 comments on commit 60ff4bd

Please sign in to comment.