docs: add a Security section (rehome release verification guide)

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,208 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
65/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia da docs/source/index.rst per vedere come è strutturato il toctree con didascalia, poi guarda RELEASE_VERIFICATION.md nella root e SECURITY.md, che vi rimanda. Crea una sezione di sicurezza in docs/source/ con un proprio toctree, sposta lì la guida alla verifica e fai in modo che il link in SECURITY.md punti alla pagina renderizzata. È completato quando la pagina viene generata sotto la nuova intestazione Security e il link si risolve; i contenuti extra menzionati nell'issue sono facoltativi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Context

In PR #1206 (PR-F4) we added docs/source/release-verification.md and temporarily wired it into the top-level docs/source/index.rst toctree. That placement is structurally wrong — it sat as a peer of the entire graphistry API module, when the content is meta/supply-chain/security.

Until a proper Security section exists in the docs, we are removing the page from readthedocs. For now the verification guide lives at repo root as RELEASE_VERIFICATION.md, linked from SECURITY.md.

Goal

Add a dedicated Security section to the Sphinx docs with its own captioned toctree so security-facing, non-API content (release verification, disclosure policy pointers, supply-chain evidence guidance, etc.) has a natural home.

Scope

  • Introduce a security/ folder under docs/source/ (or an equivalent grouping) with its own captioned toctree in index.rst
  • Rehome RELEASE_VERIFICATION.md into that section
  • Update SECURITY.md to link to the rendered docs page instead of the repo-root markdown file
  • Consider what else belongs there (disclosure process, supported versions, threat model snippets if any)

Out of scope

  • Changing the publish workflow or release evidence model (PR-F3/F4 already covered that)

Related

  • PR #1206 — original addition of the verification guide
  • Umbrella #1130 — trusted-release hardening
Lingua principale
Python
Stelle
2.6k
Fork
229
Merge medio
1g 5h
PR unite (30g)
100

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di graphistry/pygraphistry

Tutte le issue di graphistry/pygraphistry

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.