I created a comprehensive guide for contributing blog posts to PipeCD, enabling community members to share their experiences and knowledge through the project's blog.
What is PipeCD?
PipeCD is a CNCF Sandbox GitOps continuous deployment tool. Community blog posts help share real-world usage patterns, tutorials, and best practices with the broader ecosystem.
The Problem
Issue #6124 identified the need for blog contribution guidelines:
- No clear process for submitting blog posts
- Unclear formatting and style requirements
- Missing guidance on acceptable content
- Community members unsure how to share their PipeCD stories
My Solution
I created contributing-blogs.md with clear guidelines:
Content Guidelines
- Types of blog posts welcome (tutorials, case studies, announcements)
- Target audience and tone expectations
- Technical depth and clarity standards
- Content that aligns with PipeCD's mission
Format Requirements
- Markdown formatting standards
- Required frontmatter fields (title, date, author, summary)
- Image and asset guidelines
- Code snippet formatting
Submission Process
- How to propose a blog post topic
- Review and approval workflow
- Editorial feedback process
- Publication timeline expectations
Documentation Restructure
- Renamed "Contributor Guide" section to "Contribute" for better organization
- Applied changes to both docs-dev and docs-v1.0.x
- Created consistent structure with other contribution guides
Impact
- Community Voice: Members can now share their PipeCD experiences
- Knowledge Sharing: Real-world use cases and patterns documented
- SEO & Visibility: More content helps PipeCD reach broader audience
- Clear Process: Removes uncertainty around blog submissions
This completed the contributor documentation initiative (issue #6124) alongside guides for code contributions and plugins.
Review Process
Reviewed by maintainers Warashi and ffjlabo, with feedback to ensure the guidelines were clear and actionable. Merged by khanhtc1202.
Links: Pull Request #6396 • Issue #6124 • Repository