Skip to content

Commit

Permalink
docs: remove FILL TEMPLATE comments
Browse files Browse the repository at this point in the history
Those date back to the very beginning of the project and were used as
a reminder for content that might be missing. We have added everything
over time, so they no longer serve any real purpose.
  • Loading branch information
pohly committed Sep 10, 2020
1 parent 55476f3 commit 2d7facd
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 42 deletions.
8 changes: 1 addition & 7 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,12 +272,6 @@ A production deployment can improve upon that by using some other key
delivery mechanism, like for example
[Vault](https://www.vaultproject.io/).

<!-- FILL TEMPLATE:
* Target users and use cases
* Design decisions & tradeoffs that were made
* What is in scope and outside of scope
-->

## Volume Persistency

In a typical CSI deployment, volumes are provided by a storage backend
Expand Down Expand Up @@ -430,4 +424,4 @@ named [`Deployment`](./install.md#pmem-csi-deployment-crd) in the
`pmem-csi.intel.com/v1alpha1` API group. The operator runs inside the cluster
and listens for deployment changes. It makes sure that the required Kubernetes
objects are created for a driver deployment.
Refer to [Deployment CRD](./install.md#deployment) for details.
Refer to [Deployment CRD](./install.md#deployment) for details.
35 changes: 0 additions & 35 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -826,28 +826,6 @@ INFO: deploying from /nvme/gopath/src/github.com/intel/pmem-csi/deploy/kubernete
...
```

<!-- FILL TEMPLATE:
### How to extend the plugin
You can modify PMEM-CSI to support more xxx by changing the `variable` from Y to Z.
## Maintenance
* Known limitations
* What is supported and what isn't supported
* Disclaimer that nothing is supported with any kind of SLA
* Example configuration for target use case
* How to upgrade
* Upgrade cadence
## Troubleshooting
* If you see this error, then enter this command `blah`.
-->

## PMEM-CSI Deployment CRD

`Deployment` is a cluster-scoped Kubernetes resource in the
Expand Down Expand Up @@ -975,16 +953,3 @@ It is important to include the following details:
Vulnerability information is extremely sensitive. Please encrypt all security vulnerability reports using our [PGP key](https://www.intel.com/content/www/us/en/security-center/pgp-public-key.html).

A member of the Intel Product Security Team will review your e-mail and contact you to collaborate on resolving the issue. For more information on how Intel works to resolve security issues, see: [vulnerability handling guidelines](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html).

<!-- FILL TEMPLATE:
Contact the development team (*TBD: slack or email?*)
## References
Pointers to other useful documentation.
* Video tutorial
* Simple youtube style. Demo installation following steps in readme.
Useful to show relevant paths. Helps with troubleshooting.
-->

0 comments on commit 2d7facd

Please sign in to comment.