diff --git a/docs/README.md b/docs/README.md index 0ad21fccf..6dadc78db 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 @@ -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/` diff --git a/docs/content/contributing/contributing-docs/index.md b/docs/content/contributing/contributing-docs/index.md index cde461d18..06497c9f8 100644 --- a/docs/content/contributing/contributing-docs/index.md +++ b/docs/content/contributing/contributing-docs/index.md @@ -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/` @@ -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.