Document how to validate data in plugin writer guide
Open
Nobody has claimed this yet.
Documentation
Task
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: @bmbouter (bmbouter)
Redmine Issue: 5828, https://pulp.plan.io/issues/5828
Basically we should document this email in our plugin writers guide:
https://www.redhat.com/archives/pulp-dev/2019-December/msg00018.html
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 with the plugin writers guide and the linked December 2019 pulp-dev email about validating data. Identify the guide section where validation belongs, then document the email's guidance there. Done means the guide explains how plugin writers should validate data and links or reflects the referenced discussion.
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