realpython / realpython/python-guide
Lighten the part about Puppet and Chef
Open
Nobody has claimed this yet.
- Dominant language
- Batchfile
- Stars
- 29.8k
- Forks
- 5.9k
- PR merge metrics
- No merged PRs in 30d
Description
These tools although useful have too much content in the guide (chef part and puppet part) for related topics (not Python based).
It should not as stated by the style guide http://docs.python-guide.org/en/latest/notes/styleguide/#relevancy
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 linked Chef and Puppet sections in scenarios/admin.html, then compare their content with the guide's relevancy style guidance. Lighten or remove material that is not Python-focused while retaining useful context, and confirm both sections better follow the linked style rule.
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
- 45/100