From 1e8fa94c2ede2e15d250b88b923f580d82c740a1 Mon Sep 17 00:00:00 2001 From: pat-s Date: Fri, 13 Dec 2024 00:35:39 +0100 Subject: [PATCH] chore: docs --- docs/docs/92-development/01-getting-started.md | 4 ++-- docs/docs/92-development/04-docs.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/docs/92-development/01-getting-started.md b/docs/docs/92-development/01-getting-started.md index 92af0fe4d..2c93526ad 100644 --- a/docs/docs/92-development/01-getting-started.md +++ b/docs/docs/92-development/01-getting-started.md @@ -32,12 +32,12 @@ Install make on: - [Windows](https://stackoverflow.com/a/32127632/8461267) - Mac OS: `brew install make` -### Install Node.js & `pnpm` +### Install Node.js & `bun` Install [Node.js (>=20)](https://nodejs.org/en/download/package-manager) if you want to build Woodpecker's UI or documentation. For dependency installation (`node_modules`) of UI and documentation of Woodpecker the package manager pnpm is used. -[This guide](https://pnpm.io/installation) describes the installation of `pnpm`. +[This guide](https://bun.sh/docs/installation) describes the installation of `bun`. ### Install `pre-commit` (optional) diff --git a/docs/docs/92-development/04-docs.md b/docs/docs/92-development/04-docs.md index 55ccb5b7d..368d9225b 100644 --- a/docs/docs/92-development/04-docs.md +++ b/docs/docs/92-development/04-docs.md @@ -2,19 +2,19 @@ The documentation is using docusaurus as framework. You can learn more about it from its [official documentation](https://docusaurus.io/docs/). -If you only want to change some text it probably is enough if you just search for the corresponding [Markdown](https://www.markdownguide.org/basic-syntax/) file inside the `docs/docs/` folder and adjust it. If you want to change larger parts and test the rendered documentation you can run docusaurus locally. Similarly to the UI you need to install [Node.js and pnpm](./01-getting-started.md#install-nodejs--pnpm). After that you can run and build docusaurus locally by using the following commands: +If you only want to change some text it probably is enough if you just search for the corresponding [Markdown](https://www.markdownguide.org/basic-syntax/) file inside the `docs/docs/` folder and adjust it. If you want to change larger parts and test the rendered documentation you can run docusaurus locally. Similarly to the UI you need to install [Node.js and bun](./01-getting-started.md#install-nodejs--pnpm). After that you can run and build docusaurus locally by using the following commands: ```bash cd docs/ -pnpm install +bun install # build plugins used by the docs -pnpm build:woodpecker-plugins +bun build:woodpecker-plugins # start docs with hot-reloading, so you can change the docs and directly see the changes in the browser without reloading it manually -pnpm start +bun start # or build the docs to deploy it to some static page hosting -pnpm build +bun run build ```