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

Update README.md #27

Merged
merged 6 commits into from
Nov 20, 2024
Merged

Update README.md #27

merged 6 commits into from
Nov 20, 2024

Conversation

tsande16
Copy link
Contributor

This PR will cleanup old documentation within the pass-acceptance-testing repository. It updates the top level README with a brief summary and adds URLS pointing to the new documentation site.

Related to eclipse-pass/main#1081. When merged PR 1081 will close the eclipse-pass/main#1035; however these PRs can be merged in any order.

README.md Outdated

* [NodeJS](https://nodejs.org/en/) version 14+
* [Yarn](https://yarnpkg.com/) v1.x - package manager, similar to NPM
PASS Docker is Open Source software released under the [Apache 2.0 license](LICENSE).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be PASS Acceptance Testing instead of PASS Docker

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

README.md Outdated
@@ -1,14 +1,15 @@
## Description
# PASS Acceptance Testing ![PASS Acceptance Testing](https://github.com/eclipse-pass/pass-acceptance-testing/actions/workflows/release.yml)
Copy link
Contributor

Choose a reason for hiding this comment

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

Forgot the /badge.svg at the end of the badge url.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

README.md Outdated
@@ -1,14 +1,15 @@
## Description
# PASS Acceptance Testing ![PASS Acceptance Testing](https://github.com/eclipse-pass/pass-acceptance-testing/actions/workflows/release.yml/badge.svg)
Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, badge should be for the test.yml workflow, this is the workflow that is more often used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

Copy link
Contributor

@rpoet-jh rpoet-jh left a comment

Choose a reason for hiding this comment

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

Looks good.

Copy link
Contributor

@markpatton markpatton left a comment

Choose a reason for hiding this comment

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

Looks good.

@tsande16 tsande16 merged commit 4ce4abe into main Nov 20, 2024
2 checks passed
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.

3 participants