Skip to content

docs: update hugo version and add windows notes for local preview #6910

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.

Sign up for GitHub

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

Merged
mohammedfirdouss merged 1 commit into from
Jul 14, 2026
Merged

docs: update hugo version and add windows notes for local preview #6910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@ If you find any issues related to the docs, we're happy to accept your help.
# How to run the website locally

## Prerequisite

- [Hugo 0.92.1+extended](https://gohugo.io/)
- [Hugo 0.148.2+extended](https://gohugo.io/)

## Commands

Run `make run/site` at the root directory of the repository and then access http://localhost:1313

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```
7 changes: 7 additions & 0 deletions docs/content/en/docs-dev/contribution-guidelines/contributing-blogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ Your content here...
```
Then visit `http://localhost:1313/blog/` to see your post.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

6. **Commit and push** your changes:
```bash
git add .
Expand Down
9 changes: 8 additions & 1 deletion docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,20 @@ The content files are written in Markdown and live inside `/docs/content/en/`. Y

To preview your changes as you work, you must run the documentation website on your local machine.

1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.148.2 or higher)](https://gohugo.io/getting-started/installing/) installed.
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
```bash
make run/site
```
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

## How to submit your changes (The PR Process)

1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
Expand Down
7 changes: 7 additions & 0 deletions docs/content/en/docs-v0.56.x/contribution-guidelines/contributing-blogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ Your content here...
```
Then visit `http://localhost:1313/blog/` to see your post.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

6. **Commit and push** your changes:
```bash
git add .
Expand Down
9 changes: 8 additions & 1 deletion docs/content/en/docs-v0.56.x/contribution-guidelines/contributing-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,20 @@ The content files are written in Markdown and live inside `/docs/content/en/`. Y

To preview your changes as you work, you must run the documentation website on your local machine.

1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.148.2 or higher)](https://gohugo.io/getting-started/installing/) installed.
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
```bash
make run/site
```
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

## How to submit your changes (The PR Process)

1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
Expand Down
7 changes: 7 additions & 0 deletions docs/content/en/docs-v0.57.x/contribution-guidelines/contributing-blogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ Your content here...
```
Then visit `http://localhost:1313/blog/` to see your post.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

6. **Commit and push** your changes:
```bash
git add .
Expand Down
9 changes: 8 additions & 1 deletion docs/content/en/docs-v0.57.x/contribution-guidelines/contributing-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,20 @@ The content files are written in Markdown and live inside `/docs/content/en/`. Y

To preview your changes as you work, you must run the documentation website on your local machine.

1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.148.2 or higher)](https://gohugo.io/getting-started/installing/) installed.
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
```bash
make run/site
```
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

## How to submit your changes (The PR Process)

1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
Expand Down
7 changes: 7 additions & 0 deletions docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-blogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ Your content here...
```
Then visit `http://localhost:1313/blog/` to see your post.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

6. **Commit and push** your changes:
```bash
git add .
Expand Down
9 changes: 8 additions & 1 deletion docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,20 @@ The content files are written in Markdown and live inside `/docs/content/en/`. Y

To preview your changes as you work, you must run the documentation website on your local machine.

1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed.
1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.148.2 or higher)](https://gohugo.io/getting-started/installing/) installed.
2. **Run the Server:** From the root of the `pipecd` repository, run the following command:
```bash
make run/site
```
3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site.

> **Note for Windows users:**
> The `make run/site` command uses `make` and `grep`, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:
> ```powershell
> $env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
> hugo server --source=docs
> ```

## How to submit your changes (The PR Process)

1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`).
Expand Down
Loading