Add memory/performance tips to the plugin writer's guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: @goosemania (ttereshc)
Redmine Issue: 5858, https://pulp.plan.io/issues/5858
Motivation
There were memory and run time improvements made to the pulpcore and pulp_rpm. It's likely that other existing plugins and the newly created ones will eventually reach the point when they are not performant enough. To make it easier for plugin writers and to reduce investigation time in the future, let's add a section to the docs where common sources of performance issues and solutions to them are gathered.
Solution
Create a page and make a new menu item "Performance" for the plugin writers' guide.
Share the best practices and what was learnt during the recent memory/performance investigation and how to avoid such problems.
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 writer's guide linked in the issue and review the recent pulpcore and pulp_rpm memory and runtime investigations. Done means the guide has a new Performance page and a corresponding menu item containing the gathered performance best practices and lessons learned.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, performance
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100