Proposal: Automating Documentation Publishing w/ GitHub Actions

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

Nessuno ha ancora preso questa issue.

  • #3 di @bitsalv — chiusa senza merge

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
github-actions, markdown
Ambito
ci-cd, devops, documentation

Direzione di ricerca

The issue does not name files, tests, or an existing workflow. Start by inspecting the repository's current documentation setup and the proposed GitHub Actions and GitHub Pages flow; done means the publishing design is agreed and the workflow is implemented and verified.

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

Descrizione

documentation enhancement question

Hi everyone,

I’d like to propose an enhancement to our documentation publishing workflow using GitHub Actions.

The main goal is to keep our documentation repository clean and focused solely on the Markdown files, while ensuring that any updates to the documentation automatically trigger an update to our site.

This approach works seamlessly with various static site generators, whether we decide to use MkDocs, VuePress or any other tool. By leveraging GitHub Actions, we can automatically rebuild and deploy the site with GitHub Pages every time a change is made. This means that contributors can simply make modifications to the Markdown files, and once their pull request is merged, the site will automatically update to reflect those changes.

If anyone has experience with this type of setup, I’d appreciate your input!

Thanks 🙏

Lingua principale
CSS
Stelle
2
Fork
1
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 edge-mining/edge-mining.github.io

Tutte le issue di edge-mining/edge-mining.github.io

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.