Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Draft
emmaaroche wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Update README.md #833

emmaaroche wants to merge 1 commit into from

Conversation

@emmaaroche
Copy link
Contributor

@emmaaroche emmaaroche commented Dec 19, 2025 •
edited
Loading

Description

Refactors README.md and documents the new UI tests.

Closes #817

Still a work in progress.

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
docs: Update README.md
c8604a0 
Signed-off-by: emmaaroche <eroche@redhat.com>
@emmaaroche emmaaroche self-assigned this Dec 19, 2025
@emmaaroche emmaaroche added the documentation Improvements or additions to documentation label Dec 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@azgabur azgabur Awaiting requested review from azgabur

@trepel trepel Awaiting requested review from trepel

@zkraus zkraus Awaiting requested review from zkraus

@averevki averevki Awaiting requested review from averevki

@fabikova fabikova Awaiting requested review from fabikova

@silvi-t silvi-t Awaiting requested review from silvi-t

@crstrn13 crstrn13 Awaiting requested review from crstrn13

At least 2 approving reviews are required to merge this pull request.

Assignees

@emmaaroche emmaaroche

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update README.md

1 participant

@emmaaroche