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.

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

docs(readme): fix typos, add links #49

Merged
merged 3 commits into from
Feb 12, 2024
+10 −10
Merged

docs(readme): fix typos, add links #49

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ade61de
fix(readme): typos
maximiliantech Feb 11, 2024
2f56155
docs(readme): add links
maximiliantech Feb 11, 2024
83c2214
fix(readme): typos
maximiliantech Feb 11, 2024
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: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,27 @@
`xp-testing` is a library enabling end-to-end tests for Crossplane providers, based on
[kubernetes-sigs/e2e-framework](https://github.com/kubernetes-sigs/e2e-framework/).

The testing framework helps to setup test suites, by handling the deployments of crossplane and providers & ensures
This testing framework helps to set up test suites, by handling the deployments of crossplane and providers & ensures
providers are loaded into the cluster & helpers to speedup test development.

* `pkg/xpconditions` supports with assertions.
* `pkg/resources` helps with handling of importing and deleting of resources while testing & an opinionated way to
create Test Features.
* `pkg/setup` provides a default cluster setup, ready to take just the most necessary information and boostrap the
* [`pkg/xpconditions`](./pkg/xpconditions) supports with assertions
* [`pkg/resources`](./pkg/resources) helps with handling of importing and deleting of resources while testing & an opinionated way to
create Test Features
* [`pkg/setup`](./pkg/setup) provides a default cluster setup, ready to take just the most necessary information and boostrap the
test suite
* `pkg/xpenvfuncs` provide basic functions to compose a test environment
* [`pkg/xpenvfuncs`](./pkg/xpenvfuncs) provide basic functions to compose a test environment


## Getting Started and Documentation

For getting started guides, installation, deployment, and administration, check latest
Crossplane [document](https://crossplane.io/docs/latest).

A reference implementation of `xp-testing` is available in [provider-argocd](https://github.com/crossplane-contrib/provider-argocd/pull/89/files)
A reference implementation of `xp-testing` is available in [provider-argocd](https://github.com/crossplane-contrib/provider-argocd/pull/89/files).

## Contributing

xp-testing is a community driven project and we welcome contributions. See the
`xp-testing` is a community driven project and we welcome contributions. See the
Crossplane
[Contributing](https://github.com/crossplane/crossplane/blob/master/CONTRIBUTING.md)
guidelines to get started.
Expand All @@ -40,7 +40,7 @@ Please use the following to reach members of the community:
* Slack: Join our [slack channel](https://slack.crossplane.io)
* Forums:
[crossplane-dev](https://groups.google.com/forum/#!forum/crossplane-dev)
* Twitter: [@crossplane_io](https://twitter.com/crossplane_io)
* Twitter/X: [@crossplane_io](https://twitter.com/crossplane_io)
* Email: [[email protected]](mailto:[email protected])

## Governance and Owners
Expand All @@ -58,7 +58,7 @@ as the core Crossplane project.

## Licensing

xp-testing is under the Apache 2.0 license.
`xp-testing` is under the Apache 2.0 license.

## Credits

Expand Down
Loading