Skip to content
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

Revise some of the docs, add information about upgrading #876

Merged
merged 3 commits into from
May 28, 2024
Merged

Conversation

jhump
Copy link
Member

@jhump jhump commented May 24, 2024

I was reviewing some of the docs and noticed a few things that could be improved.

The changes to the Status: Stable section of the README stem from thinking about other kinds of changes that we must reasonably make from time to time that could prevent a user from easily being able to upgrade to a newer version of the suite. I figured being very explicit about this in this document is best for clarity and transparency.

This also adds a section to the README that describes the machinery of the thing and also includes a sequence diagram to show what's going on inside the test runner.

@jhump jhump requested a review from smaye81 May 24, 2024 14:07
Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
@jhump jhump changed the title Revise some of the docs, adding information about upgrading Revise some of the docs, add information about upgrading May 24, 2024
Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
@jhump
Copy link
Member Author

jhump commented May 28, 2024

ping @smaye81

Copy link
Member

@smaye81 smaye81 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, this one slipped my mind.

docs/testing_clients.md Outdated Show resolved Hide resolved
docs/testing_clients.md Outdated Show resolved Hide resolved
1. Update to the new release of the conformance suite.
2. Update test case patterns (like in known-failing configurations) if necessary to match
any changes to test case names and organization.
3. Update/add known-failing configurations for any new failures resulting from new/updated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one case where automatically appending tests to a known-failing file would be super helpful.

Signed-off-by: Josh Humphries <2035234+jhump@users.noreply.github.com>
@jhump jhump enabled auto-merge (squash) May 28, 2024 23:12
@jhump jhump merged commit 16c2d48 into main May 28, 2024
4 checks passed
@jhump jhump deleted the jh/doc-fixes branch May 28, 2024 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants