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

Create custom domain for Read the Docs site

Aperta
#1,563 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando l’issue 84 e la guida di Read the Docs sui domini personalizzati collegata nell’issue. Determina se il sito RTD può usare docs.dandiarchive.org con un percorso /api/client o /client, quindi conferma le credenziali dell’account e la configurazione necessarie. Il lavoro è completato quando il sito RTD di DANDI Client è raggiungibile all’URL personalizzato concordato.

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

Descrizione

Issue description

Given the recent updates to the website routes (see https://github.com/dandi/dandi.github.io/issues/84) and particularly the renaming of the DANDI Handbook to docs.dandiarchive.org, as @yarikoptic points out it is confusing that we have a dandi RTD site for the DANDI Client.

Possible solution

I propose that we create a custom domain for the RTD site and use docs.dandiarchive.org/api/client or docs.dandiarchive.org/client. RTD allows for custom domains but we will need to investigate further if we can use a custom domain that also includes a path (e.g. /api/client).

If we agree on this being the solution, I would be happy to work on this. I will just need the credentials for the dandi RTD account.

Lingua principale
Python
Stelle
29
Fork
37
Merge medio
1g 5h
PR unite (30g)
20

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 dandi/dandi-cli

Tutte le issue di dandi/dandi-cli

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.