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

Documentation Site - Staging Previews

Aperta
#116 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python

Direzione di ricerca

La issue non indica file, test o punti di ingresso del workflow. Inizia individuando la configurazione di build e deployment del sito della documentazione e la configurazione del workflow PR del repository. L'attività è completata quando una pull request può produrre un'anteprima di staging utilizzabile, oppure quando un maintainer può effettuare il deploy di un branch specificato sul server di anteprima condiviso.

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

Descrizione

Right now when someone submits a PR that contains updated docstrings or changes to the documentation site, we need to pull down the code and run the documentation site locally to preview the changes.

However it would be nice to implement an automated workflow whereby on each PR we are able to view the updated documentation site on a PR-specific staging server.

Alternatively, if having separate PR-specific servers isn't feasible or practical, we can have a repo maintainer manually run a command to deploy the documentation site from a given branch to a single staging preview server. This should be fine because most often we would only be concerned with previewing one PR at a time.

Lingua principale
Python
Stelle
132
Fork
60
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

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 google/sbsim

Tutte le issue di google/sbsim

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.