Restructure README and add per-audience setup + security docs#57
Merged
Conversation
- README rewritten with a "Pick your path" router and a 5-step local install; links out to the new remote-hpc / operating-an-endpoint / SECURITY pages instead of mixing all audiences into one file. - SECURITY.md: threat model split into local, remote-as-user, and remote-as-operator with concrete payload-on-disk impact and a hardening checklist (chmod, MEP allowlist, high-assurance auth, service-account migration). - docs/remote-hpc.md: step-by-step for users who already have an HPC account and need to connect to an existing Globus Compute endpoint, with prereqs pinned at the top and a troubleshooting table. - docs/operating-an-endpoint.md: step-by-step for the person standing up the endpoint, including a service-account request template, Slurm/PBS configs, the MEP allowlist path, and day-2 ops.
Sphinx -W build couldn't resolve ../SECURITY or ../README because those files are outside the docs/ source root. Switched repo-root cross-refs to absolute GitHub URLs, which render correctly both on GitHub and in the Sphinx HTML output. Also added the two new pages to the User Guide toctree.
This file contains hidden or 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
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.
Summary
Why
Today users have to read 7+ overlapping files to figure out which path applies to them, and security guidance is scattered. This PR establishes three front doors keyed to who the reader is, leaves the existing site-specific quickstarts (chrysalis/improv/ucar) in place, and gives sysadmins a single page to send to support.
Test plan
Notes