E4S-Project / E4S-Project/E4S-Project.github.io

Create a "Join" page to provide instructions for how a package can join E4S

Open
#9 3 comments 0 reactions 3 assignees View on GitHub

@wspear is already working on this.

Since Dec 22, 2020.

Dominant language
HTML
Stars
6
Forks
9
PR merge metrics
No merged PRs in 30d

Description

We need a page on e4s-project.github.io that describes how a product can join E4S. The page should also have a Join button at the top of pages, perhaps between "Contact Us" and "FAQ" or perhaps we could refactor one of the top buttons (such as "Contact Us") to include a link to the Join page.

The Join page should have the following information:

Pre-requisite: Justification for being included. The product must have some value or strong potential value to the HPC community. In other words, it must make sense for the product to belong to E4S. Note: It probably makes sense to have this pre-requisite be a new E4S community policy. See issue #8.

Level 0: Be listed in the E4S Spack installation script and be buildable in all E4S target environments. The list of Spack recipes for E4S is here: https://github.com/UO-OACISS/e4s/tree/master/e4s-facility-environments/uoregon.

Level 1: Be present in the DocPortal: https://e4s-project.github.io/DocPortal.html. To achieve this, we need a URL to your main repo to add to this list: https://github.com/E4S-Project/E4S-Documenter/blob/master/data/e4s_products.yaml.

Level 3: Satisfy all E4S community policies: https://e4s-project.github.io/policies.html. Full satisfaction is not required at this time. We are still establishing a process. Note that derived requirements from E4S member packages are not required to satisfy community policies as long as they do destabilize E4S builds or portability.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.