-
Notifications
You must be signed in to change notification settings - Fork 23
docs: Update README.md #833
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
base: main
Are you sure you want to change the base?
Conversation
7951d01 to
b6f5deb
Compare
b6f5deb to
f5110f8
Compare
azgabur
left a comment
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 refactor 👍
README.md
Outdated
| For more details, see the [Dynaconf wiki page](https://www.dynaconf.com/envvars/). | ||
|
|
||
| ### Kubernetes Auto-Fetching | ||
| Some configuration options can be fetched from Kubernetes. To install helper services (e.g., Keycloak, Jaeger, MockServer, Redis), see [values-tools.yaml](https://github.com/Kuadrant/helm-charts-olm/blob/main/values-tools.yaml): |
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.
I would rather link readme and section which talks about what is being installed: https://github.com/Kuadrant/helm-charts-olm?tab=readme-ov-file#testing-charts
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.
Also change the link title "values-tools.yaml"
f5110f8 to
83226f5
Compare
README.md
Outdated
| ```shell | ||
| make test flags=--lf # Run last failed tests | ||
| make test flags=-n1 # Run tests with just one thread | ||
| make test flags=-v # Run in verbose mode |
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.
flags=--lf make test env variables are declared before the command, not after
Signed-off-by: emmaaroche <eroche@redhat.com>
83226f5 to
7b6afb2
Compare
Description
Refactors
README.mdand documents the new UI tests.Closes #817
Changes
Documentation Structure
CONTRIBUTING.mdguideVerification steps
Eye review.