ansible-community / ansible-community/github-docs-build
The instructions on using GitHub Pages to publish docs are outdated and will stop working on June 30th
- Dominant language
- Jinja
- Stars
- 13
- Forks
- 10
- Avg merge
- 10h 14m
- Merged PRs (30d)
- 1
Description
The way setting up GH pages publishing is described on https://github.com/ansible-community/github-docs-build/wiki/Getting-started-with-GitHub-Pages#enabling-pages is outdated and will stop working on June 30th, according to https://www.josephguadagno.net/2024/04/03/migrate-to-github-actions-from-pages-legacy-worker. Despite the mention of Jekyll all over that blog post this also affects publishing raw HTML pages (as used by the shared workflows from this repo).
Fixing this is probably quite easy, you simply need to add a workflow to the `main` branch that handles pushes to the `gh-pages` branch and publishes them (look for `Static HTML Workflow Template` in the blog post). I'll try this out later or tomorrow and will report back here how it went.
Ref: https://github.com/ansible-community/ansible-build-data/issues/416
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the wiki section “Enabling Pages” and the repository’s existing shared workflows, then compare the setup with the linked “Static HTML Workflow Template.” Update the instructions and add the main-branch workflow for pushes to gh-pages; done means raw HTML documentation publishing works after the legacy Pages worker change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100