Links and references that genuinely helped me
These are links and references that genuinely helped me understand open source workflows and write better docs.
A practical first PR guide. Perfect for beginners who want hands-on help.
The best book I've read on how open source projects actually work. Free online version available.
Clear way to think about doc types: tutorials vs how-to vs reference. Changed how I structure docs.
Simple, practical guide. Good commit messages matter more than most people think.
Well-structured Kubernetes policy documentation. Good reference for how to document cloud-native tools.
Multi-cluster cloud native management documentation. Great examples of complex architecture docs.
Continuous deployment documentation. Versioned docs are linked from here.
Still the most useful resource when you know what to ask. Problem-solving at scale.
Not just code hosting. GitHub's issue templates, PR reviews, and Actions are all documentation of best practices.
Every project has different standards. Read 3-5 CONTRIBUTING.md files to understand patterns.
Look at recently merged PRs in projects you want to contribute to. They show you what maintainers accept.
Someone may have already discussed the problem. It saves time and shows you understand the project.
Before writing code, ask: "Should this be done this way?" Maintainers appreciate the heads-up.
Write down what confused you. That confusion is often a docs gap—and fixing it is a great first PR.
Interact in issues and discussions. It makes PR reviews easier and more constructive.
If you have a resource you think should be here, feel free to open a PR on GitHub.