PlasmaPy / PlasmaPy/plasmapy.github.io
Link to changelogs in docs instead of doing blog posts on each release
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
It's been pretty common for us me to forget to do the blog posts for the releases. If we have a feature release cadence of ∼3–4 months, we would end up needing to do this pretty often. The blog posts from the releases often repeat information from the changelog. I'm thinking that instead of having blog posts on each release, we should link to the changelog index page such that we won't need to update the webpage with each release.
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 locating the release blog posts and the changelog index page in the website. Confirm where release links are maintained, then update the relevant page so it points to the changelog index instead of requiring a blog post for each release. Done means the release documentation clearly links to the changelog index and no per-release blog update is needed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100