Update README #137
Update README #137
Conversation
README.md
Outdated
| submissions to downstream repositories such as PubMed Central and institutional repositories. Notification Services | ||
| provide alerts and updates to relevant stakeholders based on submission workflows and events. | ||
|
|
||
| You can find further documentation and details about the [Data Loaders](https://docs.eclipse-pass.org/developer-documentation/data-loaders), |
There was a problem hiding this comment.
What do you think about having a Guides section like on the Spring Boot README? https://github.com/spring-projects/spring-boot?tab=readme-ov-file#guides. I see it very similar where each of the links to our docs could be a bullet point.
Also, I think there should be a License section (something I see in almost every README). Something like https://github.com/spring-projects/spring-boot?tab=readme-ov-file#license
There was a problem hiding this comment.
These are some good points. I'm getting some feedback on others PRs, so I'm going to compile these and we can talk about them at our PASS Status meeting.
README.md
Outdated
|
|
||
| The pass-support repository contains components which sit outside pass-core. | ||
|
|
||
| # PASS Support |
There was a problem hiding this comment.
I think it would also be good to add a badge next to the PASS Support for the status of the Publish SNAPSHOT workflow. The URL would be https://github.com/eclipse-pass/pass-support/actions/workflows/snapshot.yml/badge.svg, see https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge.
README.md
Outdated
| The pass-support repository contains components which sit outside pass-core. | ||
| PASS Support contains ancillary components that assist in the submission process and is composed of the Data Loaders, | ||
| Notification Services, and Deposit Services. The Data Loaders handle data ingestion from external systems like PubMed | ||
| Central, NIH, FIBI (JHU Grant Management System), transforming grant, journal, and manuscript submission data into a |
There was a problem hiding this comment.
I would change FIBI (JHU Grant Management System) to Grant Management System to keep it generic.
This PR will cleanup old documentation within the pass-support 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.