Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Auth: documentation on how to get started is too hard to find

Aperta Adatta ai principianti
#579 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
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla

Direzione di ricerca

Inizia da platform/src/auth/readme.md e dal link del README per comprendere le indicazioni attuali sull’autenticazione e dove gli utenti dovrebbero trovarle. Riorganizza la documentazione in modo che la configurazione dell’autenticazione della piattaforma locale sia chiaramente evidenziata e facile da seguire, mantenendo separati i dettagli di implementazione; il lavoro è completo quando un utente riesce a trovare facilmente i passaggi di configurazione per collegare Lightning locale ad Apollo locale.

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

Descrizione

When running apollo locally and calling it with curl or the CLI, no auth stuff is needed.

But if you're connecting a local lightning to your local apollo, you DO need to set up auth.

At the moment the instructions for auth are buried in platform/src/auth/readme.md which is just the worst place. It is linked to from teh readme, so that helps a bit.

But then - the auth docs are full of implementation detail about the hows and whys. The actual "here's how you get set up" bit is lost in a section called "the client CLI", which doesn't feel like the place I'd look for docs on how to configure my local platform.

So basically we need a redo on the docs, with basic setup steps clear and easy to find and follow.

Lingua principale
Jupyter Notebook
Stelle
5
Fork
9
Merge medio
3g 2h
PR unite (30g)
13

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 OpenFn/apollo

Tutte le issue di OpenFn/apollo

Issue simili

Altre issue su Security

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.