Skip to content

Commit

Permalink
docs: fix dead links based on errors
Browse files Browse the repository at this point in the history
Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
  • Loading branch information
aramase committed Nov 10, 2021
1 parent 00a1445 commit 95218a6
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 26 deletions.
28 changes: 13 additions & 15 deletions docs/MEMBERSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@
## Overview

Hello! We're excited to have you contribute to Secrets Store CSI Driver sig-auth subproject! This document outlines the various roles for the Secrets Store CSI Driver sig-auth subproject, along with the responsibilites and privileges that come with them. Community members generally start at the first level of membership and advance up it as their involvement in the project grows. Our project members are happy to help you advance along the contributor ladder.
Hello! We're excited to have you contribute to Secrets Store CSI Driver sig-auth subproject! This document outlines the various roles for the Secrets Store CSI Driver sig-auth subproject, along with the responsibilities and privileges that come with them. Community members generally start at the first level of membership and advance up it as their involvement in the project grows. Our project members are happy to help you advance along the contributor ladder.

Each of the contributor roles below is organized into lists of three types of things:

* "Responsibilities" are things that a contributor is expected to do
* "Requirements" are qualifications a contributor needs to meet to be in that role
* "Privileges" are things a contributor on that level is entitled to

### Community Participant

Description: A Community Participant participates in the community and contributes their time, thoughts, etc.
Description: A Community Participant participates in the community and contributes their time, thoughts, etc.

* Responsibilities include:
* Responsibilities include:
* Following the [CNCF CoC](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)
* How users can get involved with the community:
* Participating in discussions in GitHub, Slack, and meetings
Expand Down Expand Up @@ -51,11 +52,11 @@ Description: A Contributor contributes directly to the project and adds value to

### Reviewer

Description: Reviewers are Contributors who are able to review code for quality and correctness on the Secrets Store CSI Driver. They are knowledgeable about the codebase and software engineering principles. A Reviewer has the rights, responsiblities, and requirements of a Contributor, plus:
Description: Reviewers are Contributors who are able to review code for quality and correctness on the Secrets Store CSI Driver. They are knowledgeable about the codebase and software engineering principles. A Reviewer has the rights, responsibilities, and requirements of a Contributor, plus:

* Responsibilities include:
* Running tests for PRs from members who aren’t part of Kubernetes org
* This involves running ok-to-test after assessing the PR briefly
* This involves running ok-to-test after assessing the PR briefly
* Project quality control via code reviews
* Focusing on code quality and correctness, including testing and factoring
* May also review for more holistic issues, but not a requirement
Expand All @@ -81,10 +82,9 @@ Description: Reviewers are Contributors who are able to review code for quality

**Note:** Acceptance of code contributions requires at least one approver in addition to the assigned reviewers.


### Approver

Description: Code approvers are able to both review and approve code contributions. While code review is focused on code quality and correctness, approval is focused on holistic acceptance of a contribution including: backwards / forwards compatibility, adhering to API and flag conventions, subtle performance and correctness issues, interactions with other parts of the system, etc. An Approver has the rights, responsiblities, and requirements of a reviewer, plus:
Description: Code approvers are able to both review and approve code contributions. While code review is focused on code quality and correctness, approval is focused on holistic acceptance of a contribution including: backwards / forwards compatibility, adhering to API and flag conventions, subtle performance and correctness issues, interactions with other parts of the system, etc. An Approver has the rights, responsibilities, and requirements of a reviewer, plus:

* Responsibilities include:
* Approvers entry in the [OWNERS](https://github.com/kubernetes-sigs/secrets-store-csi-driver/blob/v0.0.22/OWNERS#L1) file
Expand All @@ -111,7 +111,7 @@ Description: Code approvers are able to both review and approve code contributio

Description: Maintainers are very established contributors who are responsible for the entire project. As such, they have the ability to review and approve PRs against any area of the project, and are expected to participate in making decisions about the strategy and priorities of the project.

A Maintainer has the rights, responsiblities, and requirements of an Approver, plus:
A Maintainer has the rights, responsibilities, and requirements of an Approver, plus:

* Responsibilities include:
* Reviewing and approving PRs that involve multiple parts of the project
Expand All @@ -122,14 +122,14 @@ A Maintainer has the rights, responsiblities, and requirements of an Approver, p
* Determining strategy and policy for the project
* Participating in, and leading, community meetings
* Requirements
* Experience as an Approver for at least 6 months
* Experience as an Approver for at least 6 months
* Demonstrates a broad knowledge of the project across multiple areas
* Is able to exercise judgement for the good of the project, independent of their employer, social circles, or teams
* Mentors other Contributors

* Additional privileges:
* Represent the project in public as a Maintainer
* Communicate with the CNCF on behalf of the project
* Communicate with the CNCF on behalf of the project
* Have a vote in Maintainer decisions

Process of becoming a maintainer:
Expand All @@ -152,8 +152,7 @@ It is important for contributors to be and stay active to set an example and sho

### Involuntary Removal or Demotion

Involuntary removal/demotion of a contributor happens when responsibilites and requirements aren't being met. This may include repeated pattern of inactivity, extended period of inactivity, a period of failing to meet the requirements of your role, and/or a violation of the [CNCF CoC](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). This process is important because it protects the community and its deliverables while also opens up opportunities for new contributors to step in.

Involuntary removal/demotion of a contributor happens when responsibilities and requirements aren't being met. This may include repeated pattern of inactivity, extended period of inactivity, a period of failing to meet the requirements of your role, and/or a violation of the [CNCF CoC](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). This process is important because it protects the community and its deliverables while also opens up opportunities for new contributors to step in.

Involuntary removal or demotion is handled through a vote by a majority of the current Maintainers.

Expand All @@ -165,9 +164,8 @@ Contact the Maintainers about changing to Emeritus status, or reducing your cont

## Contact

For inquiries, please reach out to [Secret Store CSI Driver Maintainers](TBD)

For inquiries, please reach out to Secret Store CSI Driver Maintainers in [#csi-secrets-store](https://kubernetes.slack.com/messages/csi-secrets-store) channel on [Kubernetes Slack](https://kubernetes.slack.com/)

## Docs used for reference

- [Community membership](https://github.com/kubernetes/community/blob/master/community-membership.md)
* [Community membership](https://github.com/kubernetes/community/blob/master/community-membership.md)
2 changes: 1 addition & 1 deletion docs/book/src/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The diagram below illustrates how Secrets Store CSI volume works:

![diagram](../images/diagram.png)
![diagram](./images/diagram.png)

Similar to Kubernetes secrets, on pod start and restart, the Secrets Store CSI driver communicates with the provider using gRPC to retrieve the secret content from the external Secrets Store specified in the `SecretProviderClass` custom resource. Then the volume is mounted in the pod as `tmpfs` and the secret contents are written to the volume.

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/getting-started/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ spec:
parameters: # provider-specific parameters
```
Here is a sample [`SecretProviderClass` custom resource](https://github.com/kubernetes-sigs/secrets-store-csi-driver/blob/main/test/bats/tests/vault/vault_v1alpha1_secretproviderclass.yaml)
Here is a sample [`SecretProviderClass` custom resource](https://github.com/kubernetes-sigs/secrets-store-csi-driver/blob/release-1.0/test/bats/tests/vault/vault_v1_secretproviderclass.yaml)

### Update your Deployment Yaml

Expand Down
9 changes: 0 additions & 9 deletions sample/ingress-controller-tls/README.md

This file was deleted.

0 comments on commit 95218a6

Please sign in to comment.