Overview: Create a dependency diagram using pipforester and pipdeptree
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Description
Newbies to Plone have a tough time navigating between all the various packages that make up Plone.
A Python dependency diagram would be helpful for the Python parts. We'll use https://pypi.org/project/pipforester/ which depends on https://pypi.org/project/pipdeptree/.
Humans can fill in any important bits, such as "To edit breadcrumbs or other bits and pieces of a layout in Plone core, then visit plone.app.layout."
For Volto, do we already have a tool that can do this? A quick search turned up https://github.com/sverweij/dependency-cruiser
The appropriate place for this graph and any associated narrative would be in a new section in Overview.
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 Overview section at https://6.docs.plone.org/overview/index.html and assess pipforester with pipdeptree for the Python dependency graph. Check whether dependency-cruiser can cover Volto, then add the graph and explanatory narrative in a new Overview section; done means both relevant dependency relationships and helpful navigation notes are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100