Skip to content

Update "Setup your docs environment" instructions to match current Hugo Modules layout #1965

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
Reshrahim merged 2 commits into from
Jul 17, 2026
Merged

Update "Setup your docs environment" instructions to match current Hugo Modules layout #1965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83dd378
Initial plan
Copilot Jul 17, 2026
745a2e4
Update docs setup instructions to match current Hugo Modules layout
Copilot Jul 17, 2026
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
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The easiest way to get up and running with a docs environment is a GitHub codesp
1. Open codespace
1. Ensure postCreate script has completed (takes ~2 minutes)
1. Run `cd docs` to change into the docs directory
1. Run `npm run dev` to run a docs server
1. Run `npm start` to run a docs server
1. Click the `localhost:1313` link in your terminal to open the Codespace tunnel to the page

## Local machine
Expand Down Expand Up @@ -44,7 +44,7 @@ The easiest way to get up and running with a docs environment is a GitHub codesp
1. Run:

```sh
npm run dev
npm start
```

1. Navigate to `http://localhost:1313/`
Expand Down
21 changes: 7 additions & 14 deletions docs/content/contributing/contributing-docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,34 +56,27 @@ The easiest way to get up and running is with a GitHub Codespace. This gives you
popd
```

1. Update submodules:
1. Change into the docs site directory:

```sh
cd docs
git submodule update --init --recursive
cd docs/docs
```

1. Install npm packages:

```sh
npm install
npm ci
```

1. Initialize the docsy theme:

```sh
cd themes/docsy
npm install
cd ..
```
> The [Docsy theme](https://www.docsy.dev/) is pulled in automatically as a [Hugo Module](https://gohugo.io/hugo-modules/), so there is no separate theme initialization step.

**Run local server**

1. Make sure you're still in the `docs` directory
1. Make sure you're still in the `docs/docs` directory
1. Run

```sh
hugo server
npm start
```

1. Navigate to `http://localhost:1313/`
Expand Down Expand Up @@ -609,7 +602,7 @@ For the following steps, treat `v1.0` as the current release and `edge` as the p
1. Make sure included files look accurate. Inspect any merge conflicts in VS Code. Remove configuration changes or version information that does not need to be merged. Examples of files that usually shouldn't be merged:
- docs/config.toml
- docs/layouts/partials/hooks/body-end.html
- docsy sub-module
- docsy Hugo Module version (docs/go.mod and docs/go.sum)
1. Commit the staged changes and push to the upmerge branch (`upmerge_MM-DD`).
1. Open a PR from the upmerge branch to the upcoming release branch (`edge`).
1. Review the PR and double check that no unintended changes were pushed to the upmerge branch.
Expand Down
Loading