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

chore(docs): update README and quick.md files #154

Merged
merged 2 commits into from
Aug 15, 2020
Merged
Changes from 1 commit
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
Prev Previous commit
re-phrase the sentences based on suggestions
Signed-off-by: prateekpandey14 <[email protected]>
prateekpandey14 committed Aug 13, 2020
commit e3007a35c62fae7ea96f4cc971103d0cc513bc8c
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -64,7 +64,7 @@ perform pool operations e.g pool provisioning.
**Note:** It is not recommended to modify the CSPI CR and pool-manager in the running cluster unless you know what you are
trying to do. CSPC should be the only point of interaction.

Once the CStor pool get provisioned successfully, admin/user can create PVC to provision csi CStor volumes, when a user
Once the CStor pool(s) get provisioned successfully after creating CSPC, admin/user can create PVC to provision csi CStor volumes. When a user
creates PVC, CStor CSI driver creates CStorVolumeConfig(CVC) resource, managed and reconcile by the **cvc-controller** which creates
different volume specific resources for each persistent volume, later managed by their respective controllers, more info
can be found [here](docs/developer-guide/cstor-volume.md).
@@ -86,7 +86,7 @@ Please read the contributing guidelines [here](./CONTRIBUTING.md).

## Code of conduct

Pleae read the community code of conduct [here](./CODE_OF_CONDUCT.md).
Please read the community code of conduct [here](./CODE_OF_CONDUCT.md).

[Docker environment]: https://docs.docker.com/engine
[Go environment]: https://golang.org/doc/install
4 changes: 2 additions & 2 deletions docs/quick.md
Original file line number Diff line number Diff line change
@@ -27,8 +27,8 @@ Note:
------

It's always a better idea to install latest tag [release](https://github.com/openebs/cstor-operators/releases) yamls, unless we build the images locally. The latest release specific yamls of cstor-operators,
csi-operators and ndm-operators, can be fetched and apply directly from [release pages](https://github.com/openebs/charts/tree/gh-pages).
Since below mentioned resources are already created as part of release yamls, we can skip 1-7 steps and continue from step 8 onwards.
csi-operators and ndm-operators, can be fetched and applied directly from [release pages](https://github.com/openebs/charts/tree/gh-pages).
Since the below mentioned resources are already created as part of release yamls, we can skip 1-7 steps and continue from step 8 onwards.

1. Clone the repository.
```bash