Proposal: Automating Documentation Publishing w/ GitHub Actions
Nobody has claimed this yet.
- #3 by @bitsalv — closed without merging
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github-actions, markdown
- Domain
- ci-cd, devops, documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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 🙏
- Dominant language
- CSS
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from edge-mining/edge-mining.github.io
-
enhancement help wanted
edge-mining/edge-mining.github.io#4 · 2 assignees ·
All issues in edge-mining/edge-mining.github.io
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
repo:raw-data
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
hotosm/raw-data-api#316 · 1 comment ·
-
agentic-workflows cascade-suspected
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
willow
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
openedx/openedx-authz#460 ·