Update the diagrams on the concepts page to better clarify repositories are typed
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: @gerrod3 (gerrod)
Redmine Issue: 8826, https://pulp.plan.io/issues/8826
Follow up issue after fixing https://pulp.plan.io/issues/6990
@gerrod3 , to answer your question, I'd change diagrams as well. The clarification that you added helps, however diagrams are very misleading.
I filed that issue based on user feedback who wanted to put different content types (from different plugins) into one repo and was surprised that they couldn't and their understanding came directly from interpreting the diagrams:
RPM and Ansible content units are created in one diagram
in the next diagram content unit 1 and 2 are added to the same repo (even though technically it's not written that those content units are from different plugins, the previous diagram strongly suggests that)
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 at the concepts page and review the diagrams in light of Redmine issue 8826 and the referenced follow-up to issue 6990. Update the diagrams so they clearly show repositories are typed and do not imply that content units from different plugins can share one repository; confirm the surrounding explanation remains consistent.
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