Skip to content

Commit 5ee7d09

Browse files
docs: add 'Contribute to PipeCD Blogs' guide
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
1 parent 8f30b15 commit 5ee7d09

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Contribute to PipeCD Blogs"
3+
linkTitle: "Contribute to PipeCD Blogs"
4+
description: >
5+
This page describes how to contribute to the PipeCD Documentation.
6+
---
7+
8+
Welcome! We are so happy you're interested in helping improve our documentation. Your contributions make the project better for everyone.
9+
10+
This guide explains how you can contribute to the PipeCD Documentation, which resides on our official website, https://pipecd.dev.
11+
12+
## Where to find the docs
13+
14+
Our documentation is located in the `/docs` folder within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd).
15+
16+
The content files are written in Markdown and live inside `/docs/content/en/`. You'll notice two types of documentation folders:
17+
18+
* `/docs-dev/`: This is for documentation related to unreleased, in-development features.
19+
* `/docs-v0.x.x/` (and `/docs-v1.0.x/`): These folders contain the documentation for specific released versions of PipeCD.
20+
21+
## How to build the docs locally
22+
23+
To preview your changes as you work, you must run the documentation website on your local machine.
24+
25+
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
26+
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
27+
```bash
28+
make run/site
29+
```
30+
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.
31+
32+
## How to submit your changes (The PR Process)
33+
34+
1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
35+
2. **Make Your Changes:** Edit the necessary documentation files. If you are fixing an issue in the current documentation, remember to edit the file in both the `/docs-dev/` and the latest `/docs-vx.y.z/` folders.
36+
3. **Commit and Push:** Commit your changes with a clear message and push your branch to your fork.
37+
4. **Open a Pull Request:** Go to the PipeCD repository and open a Pull Request. In the description, please link to the issue you are fixing (e.g., `Addresses #6124`).
38+
5. **Review:** A maintainer will review your PR, provide feedback, and merge it.
39+
40+
Thank you for contributing!
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Contribute to PipeCD Blogs"
3+
linkTitle: "Contribute to PipeCD Blogs"
4+
description: >
5+
This page describes how to contribute to the PipeCD Documentation.
6+
---
7+
8+
Welcome! We are so happy you're interested in helping improve our documentation. Your contributions make the project better for everyone.
9+
10+
This guide explains how you can contribute to the PipeCD Documentation, which resides on our official website, https://pipecd.dev.
11+
12+
## Where to find the docs
13+
14+
Our documentation is located in the `/docs` folder within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd).
15+
16+
The content files are written in Markdown and live inside `/docs/content/en/`. You'll notice two types of documentation folders:
17+
18+
* `/docs-dev/`: This is for documentation related to unreleased, in-development features.
19+
* `/docs-v0.x.x/` (and `/docs-v1.0.x/`): These folders contain the documentation for specific released versions of PipeCD.
20+
21+
## How to build the docs locally
22+
23+
To preview your changes as you work, you must run the documentation website on your local machine.
24+
25+
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
26+
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
27+
```bash
28+
make run/site
29+
```
30+
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.
31+
32+
## How to submit your changes (The PR Process)
33+
34+
1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
35+
2. **Make Your Changes:** Edit the necessary documentation files. If you are fixing an issue in the current documentation, remember to edit the file in both the `/docs-dev/` and the latest `/docs-vx.y.z/` folders.
36+
3. **Commit and Push:** Commit your changes with a clear message and push your branch to your fork.
37+
4. **Open a Pull Request:** Go to the PipeCD repository and open a Pull Request. In the description, please link to the issue you are fixing (e.g., `Addresses #6124`).
38+
5. **Review:** A maintainer will review your PR, provide feedback, and merge it.
39+
40+
Thank you for contributing!

0 commit comments

Comments
 (0)