-
Notifications
You must be signed in to change notification settings - Fork 201
docs: add 'Contribute to PipeCD Blogs' guide #6353
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
| title: "Contribute to PipeCD Blogs" | ||
| linkTitle: "Contribute to PipeCD Blogs" | ||
| description: > | ||
| A guide for how to submit and contribute blog posts to the PipeCD website. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| A guide for how to submit and contribute blog posts to the PipeCD website. | |
| This page explains how you can submit a blog post to the PipeCD website. |
| weight: 4 | ||
| --- | ||
|
|
||
| PipeCD accepts technical articles and community updates for publication on the official website. This guide outlines the structure and process for submitting a new blog post. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reformat and include "where" we have our existing blogs. Refer to that website page.
| author: Your Name ([@your-github-username](https://github.com/your-github-username)) | ||
| categories: ["Announcement", "Tutorial", "Community"] # Choose one or more | ||
| tags: ["New Feature", "Tutorial", "Kubernetes"] # Use specific tags | ||
| --- No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current information is good, but vague. We need more info, for example:
-
You have to raise a PR on GitHub to get your blog approved by the maintainers and added to the site.
-
What kinds of content we accept? (Short Ans: Anything related to PipeCD, CI/CD and CNCF)
-
A link to markdown rules might be a good to have
|
@shivansh-gohem, why dont you try contributing to the blog before you close this PR? This way, you will know exactly what to put in into this PR 👀 I dont know how much you are familiar with PipeCD or CI/CD in general, but if you are not, let's get you started. Have you joined the PiepCD slack channel yet? |
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
c652eb7 to
5ee7d09
Compare
|
Hi @eeshaanSA, Thanks again for the patience and detailed guidance. I've completed all the remaining tasks: Code Status: I've applied the final changes (including the simplified description and the linkTitle fix) and pushed the update. Slack: I've successfully joined the #pipecd Slack channel. I must admit, while I'm enthusiastic about contributing, my knowledge of CI/CD and PipeCD's internals is still small. I understand the documentation process well now, but I could really use some help on the technical side of the project. I'm ready to tackle the blog post next, but I'm looking for guidance on a specific topic that would be valuable to the community. Could you guide me on a topic or suggest a focus area for my first blog post that would best showcase PipeCD? Thanks for getting me started! |
|
@shivansh-gohem, I cant see you on the slack channel yet. 👀 And I can see from your other PRs that you were successful in setting up a local build of PipeCD and even deployed a sample k8s application. I think it would be great to have a blog/guide on how to setup PipeCD locally. What do you think? |
Hi @eeshaanSA and @khanhtc1202,
Following up on my previous PR, this tackles the 'Contribute to PipeCD Blogs' section of Epic #6124, as requested.
This PR adds the new guide, which includes:
date,author,categories, etc.).This completes the second major section of the overall Contributing Epic.
Thanks for the review!