Update README.md and CONTRIBUTING.md #1081
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add brief summary and add URLS pointing to doc site.
This was referenced Nov 15, 2024
rpoet-jh
reviewed
Nov 20, 2024
| * [PASS UI](https://github.com/eclipse-pass/pass-ui) | ||
| * [PASS Support](https://github.com/eclipse-pass/pass-support) | ||
| * [PASS Acceptance Testing](https://github.com/eclipse-pass) | ||
| * [PASS Docker](https://github.com/eclipse-pass/pass-docker) |
There was a problem hiding this comment.
Should we include the PASS Documentation repo too?
rpoet-jh
reviewed
Nov 20, 2024
| ## Purpose | ||
| * [Eclipse PASS Website](https://eclipse-pass.org/index.html) | ||
| * [PASS Documentation](https://docs.eclipse-pass.org/) | ||
| * [PASS JHU User Guide](https://pass.jhu.edu/guide/) |
There was a problem hiding this comment.
I'm wondering if we should include a link to the CONTRIBUTING.md file here?
There was a problem hiding this comment.
The contributing file directly links to the contributing page on docs.eclipse-pass.org. Perhaps we just directly link to that and save the user a click?
rpoet-jh
reviewed
Nov 20, 2024
README.md
Outdated
| * [PASS Core](https://github.com/eclipse-pass/pass-core) | ||
| * [PASS UI](https://github.com/eclipse-pass/pass-ui) | ||
| * [PASS Support](https://github.com/eclipse-pass/pass-support) | ||
| * [PASS Acceptance Testing](https://github.com/eclipse-pass) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR will cleanup old documentation within the main repository. It updates the top level README with a brief summary and adds URLS pointing to the new documentation site. In addition the CONTRIBUTING.md will be updated to have a brief summary and add a URL pointing to the user docs contributing page. Once merged this will close #1035.
Summary of changes: