vmware-tanzu / vmware-tanzu/vm-operator
doc: Update docs/start/contrib/suggest-change.md
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 134
- Forks
- 83
- Avg merge
- 4d 18m
- Merged PRs (30d)
- 73
Description
This ticket tracks updating ./docs/start/contrib/suggest-change.md. Please refer to https://vm-operator.rtfd.io/en/latest/ref/proj/docs/#project-docs for guidelines on writing VM Operator project documentation.
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 reading docs/start/contrib/suggest-change.md and the VM Operator project documentation guidelines at the linked reference page. Compare the document with those guidelines and identify the required updates. Done means the file is updated to follow the project documentation guidance.
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
- Needs clarification
- Newbie friendliness
- 35/100