NASA-IMPACT / NASA-IMPACT/veda-docs
Create a changelog for major user facing changes to the VEDA Hub
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 10
- Forks
- 16
- Avg merge
- 2d 31m
- Merged PRs (30d)
- 4
Description
As discussed in slack, we should create a changelog for major user facing changes to the VEDA Hub. For example, the recent addition of deploying dynamic image building. This is to promote a positive user experience by avoiding surprises and publicizing cool new features. Possibly we could automate some detection of new features by monitoring the VEDA configuration within 2i2c/infrastructure, but this would likely require some manual work as well. I think this would fit in the scientific computing section of the docs.
cc @wildintellect
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.
Research direction
Start in the scientific computing section of the VEDA docs and review the recent dynamic image building change as the example entry. Define how major user-facing VEDA Hub changes will be recorded, including any needed manual review; done means the changelog is available to users and documents notable changes without surprises.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100