1
0
mirror of https://github.com/kubernetes-sigs/descheduler.git synced 2026-01-26 13:29:11 +01:00

Create Structure and Links For User and Contributor Guides

This commit is contained in:
Sean Malloy
2020-02-10 00:27:55 -06:00
parent d8772f5685
commit 83a75bac80
5 changed files with 95 additions and 64 deletions

5
docs/README.md Normal file
View File

@@ -0,0 +1,5 @@
# Documentation Index
- [Contributor Guide](contributor-guide.md)
- [Release Guide](release-guide.md)
- [User Guide](user-guide.md)

24
docs/contributor-guide.md Normal file
View File

@@ -0,0 +1,24 @@
## Contributor Guide
### Build and Run
- Checkout the repo into your $GOPATH directory under src/sigs.k8s.io/descheduler
Build descheduler:
```sh
$ make
```
and run descheduler:
```sh
$ ./_output/bin/descheduler --kubeconfig <path to kubeconfig> --policy-config-file <path-to-policy-file>
```
If you want more information about what descheduler is doing add `-v 1` to the command line
For more information about available options run:
```
$ ./_output/bin/descheduler --help
```

View File

@@ -1,4 +1,4 @@
# Release process
# Release Guide
## Semi-automatic

7
docs/user-guide.md Normal file
View File

@@ -0,0 +1,7 @@
## User Guide
Starting with descheduler release v0.10.0 container images are available in the below registries.
* `asia.gcr.io/k8s-artifacts-prod/descheduler/descheduler`
* `eu.gcr.io/k8s-artifacts-prod/descheduler/descheduler`
* `us.gcr.io/k8s-artifacts-prod/descheduler/descheduler`