[DOC] Automate publishing documentation with github workflow
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 667
- Forks
- 120
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 4
Description
Automate the publishing of documentation to keep it upto date.
https://github.com/NVIDIA/cuCollections/pull/177#issuecomment-1160655675
main branch is not updated in long time (July 16, 2020)
dev branch is updated frequently. There are no releases or tags.
So decide when to publish the documentation and which branch.
Describe the solution you'd like
Similar to thrust, add a GitHub workflow to generate and publish documentation to gh-pages
https://github.com/NVIDIA/thrust/blob/main/.github/workflows/deploy-documentation-github-pages.yml
Contributor guide
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.
Research direction
Start by reviewing the referenced Thrust workflow at .github/workflows/deploy-documentation-github-pages.yml and the existing documentation generation setup in cuCollections. Decide which branch and publishing trigger reflect the repository's update pattern, then add a workflow that publishes generated documentation to gh-pages and verify the deployment path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100