-
Notifications
You must be signed in to change notification settings - Fork 208
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
Closed
shivansh-gohem
wants to merge
2
commits into
pipe-cd:master
from
shivansh-gohem:shivansh-blogs-guide
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
83 changes: 83 additions & 0 deletions
83
docs/content/en/docs-dev/contribution-guidelines/contributing-blogs.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| title: "Contribute to PipeCD Blogs" | ||
| linkTitle: "Contribute to PipeCD Blogs" | ||
| description: > | ||
| This page describes how to submit and contribute blog posts to the PipeCD website. | ||
| --- | ||
|
|
||
|
|
||
| Welcome! We are happy you want to share your knowledge with the PipeCD community. | ||
|
|
||
|
|
||
| This guide explains how you can submit a blog post to the PipeCD website. | ||
|
|
||
|
|
||
| ## Where to find the blogs | ||
|
|
||
|
|
||
| Our blog posts are located in the `/docs/content/en/blog/` folder within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd). | ||
|
|
||
|
|
||
| ## How to add a new blog post | ||
|
|
||
|
|
||
| 1. **Create a file:** Create a new Markdown file in the `docs/content/en/blog/` directory. The filename should use kebab-case (e.g., `my-new-feature.md`). | ||
|
|
||
|
|
||
| 2. **Add Frontmatter:** Every blog post requires a header (frontmatter) at the top of the file. Copy and customize this template: | ||
| ```yaml | ||
| --- | ||
| date: 2023-10-27 | ||
| title: "Your Blog Post Title" | ||
| linkTitle: "Your Blog Post Title" | ||
| author: Your Name ([@your-github-username](https://github.com/your-github-username)) | ||
| categories: ["Tutorial"] | ||
| tags: ["Kubernetes", "PipeCD"] | ||
| --- | ||
| ``` | ||
| 3. **Write your content:** Write your article in standard Markdown below the frontmatter. | ||
|
|
||
|
|
||
| ## How to preview your blog | ||
|
|
||
|
|
||
| 1. **Run the server:** From the root of the repository, run: | ||
| ```bash | ||
| make run/site | ||
| ``` | ||
| 2. **Preview:** Open `http://localhost:1313/blog/` in your browser. | ||
|
|
||
|
|
||
| ## How to submit (The PR Process) | ||
|
|
||
|
|
||
| 1. **Create a branch:** from the master branch, create a new branch for your post: | ||
| ```bash | ||
| git checkout -b blog/my-new-post | ||
| ``` | ||
| 2. **Commit and push:** Commit your changes and push your new file to your fork. | ||
|
|
||
|
|
||
| 3. **Open a Pull Request:** Submit your PR to the PipeCD repository. | ||
|
|
||
|
|
||
| ## What happens next? | ||
|
|
||
|
|
||
| After you submit your pull request: | ||
|
|
||
|
|
||
| - **Review:** Maintainers will review your post. They might suggest changes or ask clarifying questions. | ||
| - **Update:** Address any feedback by pushing new commits to your branch. | ||
| - **Merge:** Once approved, a maintainer will merge your PR. Your post will appear on the website shortly after. | ||
|
|
||
|
|
||
| ## Need help? | ||
|
|
||
|
|
||
| If you have questions or need ideas for blog posts, join our community: | ||
|
|
||
|
|
||
| - **Slack:** Join the `#blog` channel on our [PipeCD Slack workspace](https://pipecd.dev/slack). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not the PipeCD Slack. The correct slack link is in the README.md |
||
| - **Community Meeting:** Join our community meeting (held bi-weekly on Wednesdays) to discuss your ideas directly with the maintainers. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Where are the next steps? We need more info, for example, that it would be reviewed by the maintainers, approved, and then merged.
Also mention about slack channel and community meets is required.