Skip to content

Conversation

@emmaaroche
Copy link
Contributor

@emmaaroche emmaaroche commented Dec 19, 2025

Description

Refactors README.md and documents the new UI tests.

Closes #817

Changes

Documentation Structure

  • Introduction: Added "What's tested" section
  • Prerequisites: Split into "Local Development" and "Container-based Testing"
  • Configuration: Includes "Settings Files", "Environment Variables", and "Kubernetes Auto-Fetching" sections
  • Test Requirements: Added tables showing cluster requirements and make targets for each test type
  • Running the Tests: Reorganized into "Locally" and "From a Container" sections
  • Developing Tests: Updated with collapsible AuthConfig example and OPA Playground reference
  • Contributing: Added link to CONTRIBUTING.md guide

Verification steps

Eye review.

@emmaaroche emmaaroche self-assigned this Dec 19, 2025
@emmaaroche emmaaroche added the documentation Improvements or additions to documentation label Dec 19, 2025
@emmaaroche emmaaroche force-pushed the update-readme branch 4 times, most recently from 7951d01 to b6f5deb Compare January 27, 2026 16:56
@emmaaroche emmaaroche marked this pull request as ready for review January 27, 2026 17:00
averevki
averevki previously approved these changes Jan 28, 2026
Copy link
Contributor

@azgabur azgabur left a 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):
Copy link
Contributor

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

Copy link
Contributor

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"

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
Copy link
Contributor

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README.md

3 participants