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 and CONTRIBUTING.md #1081

Merged
merged 7 commits into from
Nov 20, 2024
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
28 changes: 7 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
## Contributing to Eclipse PASS
# Contributing to Eclipse PASS

### Kicking the Tires
We’re thrilled to have you here! Whether you're interested in contributing code, reporting bugs, enhancing
documentation, or simply exploring what PASS has to offer, your involvement is valuable and appreciated. PASS is a
collaborative effort aimed at simplifying public access compliance for researchers, institutions, and funders, and we’re
always looking for passionate contributors to help us grow and improve.

Thanks for looking at Eclipse PASS! Whether you are interested in simply improving the existing code base, or maybe even thinking about forking the project for use at your institution, it's a good idea to have a look at a running test instance and exercise the workflows. The easiest way to do this is to simply check out our [demo instance](https://demo.eclipse-pass.org/).

### Reporting a bug

If you've run across a bug in the Eclipse PASS application, letting us know about it is an important, and easy, way to contribute. First, check to see if there's an existing issue for what you're observing by performing a search in the [issues list](https://github.com/eclipse-pass/main/issues). If you've discovered a new bug, create a new issue to tell us about it. You will need to create a GitHub account to do this, if you don't have one already.

When creating an issue, please provide a concise description of the potential problem, the steps needed to reproduce it, and a description of how the behavior differs from what you need or expect. It is also important to give details about your environment, such as the OS, build environment (Java and Maven versions), etc. [Look here for additional tips to create a truly helpful bug report](https://qawerk.com/blog/how-to-write-a-good-bug-report-best-practices/).

### Contributing code or documentation

There is always a need for fixing bugs and we are continually looking to add new features. Contributions furthering these efforts are always welcome. It may be that you simply notice something that doesn't seem to work quite right. If so, you can check the GitHub issues to see if an issue has already been opened. If so, you might comment on the issue if you have new information which might be helpful. If there is no existing issue, you might consider creating one (see above). The same process holds for exploring the addition of a new feature or updating documentation.

If you are ready to contribute to the code base, you will need an account on GitHub. Further, since PASS is an Eclipse Foundation project, contributors will need to [create an Eclipse account](https://accounts.eclipse.org/) and sign a [contributor agreement](https://www.eclipse.org/legal/ECA.php). To keep things simple, the email address you use to sign up for the Eclipse account should be the same as the one you use for your GitHub account.

To make changes to code or documentation, you'll start by forking the GitHub repository you'd like to change into your own GitHub account. Once you have your own copy of the repository, create a Git branch for your work. Please name the branch based on the ID of the ticket associated with the issue. You'll then be able to make changes, perform Git commits, and push those changes to your copy of the repository. Once your work is done, you'll need to create a Pull Request to let us know about your changes. [You'll find a more complete overview of this process here](https://opensource.com/article/19/7/create-pull-request-github).

### More Info

You'll find a lot more documentation about this project in the [docs directory](https://github.com/eclipse-pass/main/tree/main/docs). There is a lot of information of contributing to Eclipse projects in general in the [Eclipse handbook](https://www.eclipse.org/projects/handbook/#contributing-contributors).
If you're interested in joining us on this journey please take a look at our [contributing page](https://docs.eclipse-pass.org/welcome-guide/contributing-to-pass)
on our documentation site!
56 changes: 25 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,34 @@
# Eclipse Public Access Submission System (PASS)
# Eclipse Public Access Submission System (PASS) ![Pass Main](https://github.com/eclipse-pass/main/actions/workflows/pass-complete-release.yml/badge.svg)

## Introduction
The Public Access Submission System (PASS) is a comprehensive platform designed to help researchers comply with the
access policies mandated by their funders and institutions.

The Public Access Submission System (PASS) is a platform to assist researchers in complying with the access policies of their funders and institutions.
Navigating the complex landscape of public access requirements can be challenging, as policies vary significantly across
federal agencies, each with its own unique compliance process. These differing requirements often place an
administrative burden on researchers and institutions, particularly when research is funded by multiple agencies, making
compliance a complex and time-consuming task.

While many federal agencies have policies that require research results to be made publicly accessible, the requirements to comply with these vary greatly from one agency to another. These heterogeneous processes for compliance have become burdensome for researchers and their institutions. For research that is funded by multiple agencies, it can be especially complicated to ensure compliance with each funder’s access policy.
In addition, many universities have adopted their own open access policies, which further mandate that research outputs
be publicly accessible. This overlap means that a single publication can fall under multiple policies, each with
distinct workflows and submission criteria. PASS simplifies this process by consolidating and streamlining the
submission workflows, enabling researchers to efficiently meet the diverse compliance requirements.

Meanwhile, many universities have implemented an open access policy, which also requires research outputs to be made publicly accessible. As a result, each publication can be subject to multiple policies each with its own workflow and requirements.
## Documentation

## 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/)
* [Contributing to PASS](https://docs.eclipse-pass.org/welcome-guide/contributing-to-pass)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if we should include a link to the CONTRIBUTING.md file here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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?

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.


The PASS platform offers a unified approach for compliance, allowing researchers to fulfil the access policies of their institutions and funders through a single website.
## Repositories

PASS aims to:
* [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/pass-acceptance-testing)
* [PASS Docker](https://github.com/eclipse-pass/pass-docker)
* [PASS Documentation](https://github.com/eclipse-pass/pass-documentation)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we include the PASS Documentation repo too?

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.


Provide seamless functionality for submitting/collecting accepted manuscripts and metadata relevant to one or more agencies’ sponsored research and/or relevant to the researcher’s institution.

Provide interfaces (e.g., APIs, SWORD, email-driven-workflows) for researchers, institutional administrators and agencies to access, collaborate on, submit, be notified about, and perhaps format accepted manuscripts and metadata.

Deposit manuscripts and metadata in the repositories specified by the policies to which the author is subject, and/or additional repositories requested by the author.

## History

PASS was created by the Sheridan Libraries at Johns Hopkins University, in collaboration with the Harvard University Office for Scholarly Communication, the MIT Libraries, and with inspiration from Jeff Spies, formerly of the Center for Open Science.

## Current Status

PASS is currently in the [Incubation phase as an Eclipse Foundation project](https://projects.eclipse.org/projects/technology.pass). Code for the project can be found in the [eclipse-pass](https://github.com/eclipse-pass) GitHub organization.

# Documentation

All documentation should be written within this [main repo](https://github.com/eclipse-pass/main),
or referenced here. For example, please include links (with a small description) to
any relevant websites, external references, and other cloud storages (e.g. Google Docs).

* [Developer documentation](docs/dev)
* [Deployment and Infrastructure](docs/infra)
* [User documentation](docs/user)
## License

PASS is Open Source software released under the [Apache 2.0 license](LICENSE).
21 changes: 0 additions & 21 deletions docs/README.md

This file was deleted.

Binary file removed docs/assets/architecture.key
Binary file not shown.
Binary file removed docs/assets/architecture.sketch
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/assets/bitwarden/ui.png
Binary file not shown.
Binary file removed docs/assets/bitwarden/ui_get_id.png
Binary file not shown.
Binary file removed docs/assets/demo/deploy_actions.png
Binary file not shown.
Binary file removed docs/assets/demo/passdocker_actions.png
Binary file not shown.
Binary file removed docs/assets/demo/run_workflow.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/assets/eclipsesync/sitesucker.png
Binary file not shown.
Binary file removed docs/assets/emberjs_app.png
Binary file not shown.
Binary file removed docs/assets/github/create_self_runner_code.png
Binary file not shown.
Binary file removed docs/assets/github/github_settings_runners.png
Binary file not shown.
Binary file removed docs/assets/github/passdemo_runner.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/assets/github/releases/main-release-page.png
Binary file not shown.
Binary file removed docs/assets/github/ui_get_org_id.png
Binary file not shown.
Binary file removed docs/assets/html_app_nginx.png
Binary file not shown.
Binary file removed docs/assets/java_project_hierarchy.png
Binary file not shown.
Binary file removed docs/assets/otterdog/dashboard.png
Binary file not shown.
Binary file removed docs/assets/otterdog/otterdog_sample_pr.png
Binary file not shown.
Binary file removed docs/assets/otterdog/playground.png
Binary file not shown.
Binary file removed docs/assets/passapp/dashboard.png
Binary file not shown.
Binary file removed docs/assets/passapp/login_nih-user_moo.png
Binary file not shown.
Binary file removed docs/assets/passapp/welcome_screen.png
Binary file not shown.
Binary file removed docs/assets/passdev.png
Binary file not shown.
Binary file removed docs/assets/pipeline/pipeline_app.png
Diff not rendered.
Binary file removed docs/assets/pipeline/pipeline_project.png
Diff not rendered.
37 changes: 0 additions & 37 deletions docs/dev/README.md

This file was deleted.

89 changes: 0 additions & 89 deletions docs/dev/authentication-authorization.md

This file was deleted.

Loading
Loading