-
Notifications
You must be signed in to change notification settings - Fork 17
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
Adding Config Reference & Development Docs plus Readme Makeover #178
Conversation
Benchmark Result
Current status
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, great work - I like how you can put words in an order that they sound nice :)
Just a minor comment that you can ignore for now.
docs/configuration.md
Outdated
|
||
| Option | Description | Default | | ||
|--------|-------------|---------| | ||
| `--storage-dir` | The directory to store the dqlite data | `/var/tmp/k8s-dqlite/` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is some risk that this becomes obsolete sooner or later. We probably should generate the flag docs similar to how we do this in the k8s-snap:
https://github.com/canonical/k8s-snap/blob/main/src/k8s/Makefile#L16
I'm fine with the manual list for now, though. (You could create a card to address this in the future)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh yes, that's a nice to have! I am not expecting these to change much to be honest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
993a8da
to
1b52245
Compare
Description
This PR is adding a reference page for our k8s-dqlite arguments, a development docs page and gives a general make-over to our existing pages.