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

chore: improve readme and remove resources #174

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# verify-conformance

> a GitHub bot for verifying conformance submissions on github.com/cncf/k8s-conformance
A GitHub bot for verifying conformance submissions on [github.com/cncf/k8s-conformance](https://github.com/cncf/k8s-conformance).

The behaviour of the bot is described here, in [Gherkin](https://cucumber.io/docs/gherkin/). Each scenario is a requirement a PR must meet to qualify for conformance.
Ensuring that the conformance submissions contain the correct data with valid and passing results.

Note: the line immediately beneath the scenario is the comment posted to the PR if the requirement is not met.
This tool is apart of the Kubernetes Conformance ecosystem. For other tools and info, see:

See the feature scenarios, [in ./kodata/features](./kodata/features/verify-conformance.feature).
- tracking: [APISnoop](https://apisnoop.cncf.io)
- test runners: [Hydrophone](https://sigs.k8s.io/hydrophone) and [Sonobuoy](https://sonobuoy.io)
- tests: [git.k8s.io/kubernetes/test/conformance](http://git.k8s.io/kubernetes/test/conformance)
- info: [cncf.io/ck](https://cncf.io/ck)

![verify-conformance](./verify-conformance.png "verify-conformance")

# Developing
See the submission scenarios [in ./kodata/features](./kodata/features/verify-conformance.feature).

for more, read [the development docs](./docs/development.md).
![verify-conformance](./verify-conformance.png "verify-conformance")

# Docs

read the docs [here](./docs/README.md).

## Developing

read [the development docs](./docs/development.md).
1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@
- [contributing](../contributing.md)
- [development](./development.md)
- [maintenance](./maintenance.md)
- [resources](./resources.md)
- [security](../security.md)

49 changes: 0 additions & 49 deletions docs/resources.md

This file was deleted.

Loading