Skip to content

Commit

Permalink
docs: explicitly add the contribution section
Browse files Browse the repository at this point in the history
  • Loading branch information
brightzheng100 authored and prometherion committed Oct 2, 2021
1 parent 3c609f8 commit 6a175e9
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,25 +150,28 @@ Error from server (Forbidden): pods is forbidden:
User "bob" cannot list resource "pods" in API group "" in the namespace "kube-system"
```

# Documentation
Please, check the project [documentation](./docs/index.md) for more cool things you can do with Capsule.

# Removal
Similar to `deploy`, you can get rid of Capsule using the `remove` target.

```
$ make remove
```

# Documentation
Please, check the project [documentation](./docs/index.md) for more cool things you can do with Capsule.

# Contribution
Capsule is Open Source with Apache 2 license and any contribution is welcome.

Please refer to the corresponding docs:
- [contributing.md](./docs/contributing.md) for the general guide; and
- [dev-guide.md](./docs/dev-guide.md) for how to set up the development env to get started.

# FAQ
- Q. How to pronounce Capsule?

A. It should be pronounced as `/ˈkæpsjuːl/`.

- Q. Can I contribute?

A. Absolutely! Capsule is Open Source with Apache 2 license and any contribution is welcome. Please refer to the corresponding [section](./docs/operator/contributing.md) in the documentation.

- Q. Is it production grade?

A. Although under frequent development and improvements, Capsule is ready to be used in production environments as currently, people are using it in public and private deployments. Check out the [release](/~https://github.com/clastix/capsule/releases) page for a detailed list of available versions.
Expand Down

0 comments on commit 6a175e9

Please sign in to comment.