Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: correcting markdown formatting errors on readme #106

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Contributing Guidelines

Welcome to Kubernetes. We are excited about the prospect of you joining our [community](https://github.com/kubernetes/community)! The Kubernetes community abides by the CNCF [code of conduct](code-of-conduct.md). Here is an excerpt:
Welcome to Kubernetes. We are excited about the prospect of you joining
our [community](https://github.com/kubernetes/community)! The Kubernetes
community abides by the CNCF [code of conduct](code-of-conduct.md). Here is an
excerpt:

_As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities._
_As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities._

## Getting Started

Expand All @@ -12,13 +18,20 @@ We have full documentation on how to get started contributing here:
If your repo has certain guidelines for contribution, put them here ahead of the general k8s resources
-->

- [Contributor License Agreement](https://git.k8s.io/community/CLA.md) Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests
- [Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](http://git.k8s.io/community/contributors/guide#contributing)
- [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet.md) - Common resources for existing developers
- [Contributor License Agreement](https://git.k8s.io/community/CLA.md)
Kubernetes projects require that you sign a Contributor License Agreement (
CLA) before we can accept your pull requests
- [Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide)
- Main contributor documentation, or you can just jump directly to
the [contributing section](http://git.k8s.io/community/contributors/guide#contributing)
- [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet.md)
- Common resources for existing developers

## Mentorship

- [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!
- [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a
diverse set of mentorship programs available that are always looking for
volunteers!

<!---
Custom Information - if you're copying this template for the first time you can add custom content here, for example:
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,29 @@

### Overview

This is a repository for iscsi [CSI](https://kubernetes-csi.github.io/docs/) driver, csi plugin name: `iscsi.csi.k8s.io`. This driver requires existing and already configured iscsi server, it could dynamically attach/mount, detach/unmount based on CSI GRPC calls.
This is a repository for iscsi [CSI](https://kubernetes-csi.github.io/docs/)
driver, csi plugin name: `iscsi.csi.k8s.io`. This driver requires existing and
already configured iscsi server, it could dynamically attach/mount,
detach/unmount based on CSI GRPC calls.

### Project status: Alpha

### Container Images & Kubernetes Compatibility:

|driver version | supported k8s version | status |
|----------------|-----------------------|--------|
|master branch | 1.19+ | alpha |

### Install driver on a Kubernetes cluster
- install by [kubectl](./docs/install-iscsi-csi-driver.md)

- install by [kubectl](./docs/install-iscsi-csi-driver.md)

### Troubleshooting
- [CSI driver troubleshooting guide](./docs/csi-debug.md)

- [CSI driver troubleshooting guide](./docs/csi-debug.md)

### Kubernetes Development

Please refer to [development guide](./docs/csi-dev.md)

## Community, discussion, contribution, and support
Expand Down
9 changes: 6 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Release Process

The Kubernetes Template Project is released on an as-needed basis. The process is as follows:
The Kubernetes Template Project is released on an as-needed basis. The process
is as follows:

1. An issue is proposing a new release with a changelog since the last release
1. All [OWNERS](OWNERS) must LGTM this release
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION`
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the
tag with `git push $VERSION`
1. The release issue is closed
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] kubernetes-template-project $VERSION is released`
1. An announcement email is sent to `[email protected]` with the
subject `[ANNOUNCE] kubernetes-template-project $VERSION is released`
3 changes: 2 additions & 1 deletion code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Kubernetes Community Code of Conduct

Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md)
Please refer to
our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md)