jarvis-at-skic
9ad62a2ed6
Build and publish Eldorado documentation / build (pull_request) Successful in 29s
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
---
|
||
title: How to update and publish the site
|
||
description: Preview documentation changes, validate them, and publish through Gitea Actions.
|
||
slug: /maintain
|
||
---
|
||
|
||
## What you need
|
||
|
||
Node.js 22 or later, pnpm 10.15.1, and write access to the private [documentation repository](https://gitea.lego-cloud.eu/eldorado-v1/documentation).
|
||
|
||
## Preview locally
|
||
|
||
```sh
|
||
pnpm install --frozen-lockfile
|
||
pnpm start
|
||
```
|
||
|
||
Open the development server address printed in the terminal. The site uses the `/eldorado-v1/documentation/` base path.
|
||
|
||
## Add or change a page
|
||
|
||
Edit Markdown in `docs/`. Include `title` and `description` frontmatter and add the page ID to `sidebars.ts`. Keep the documentation’s future scope open until it is agreed.
|
||
|
||
## Validate the change
|
||
|
||
```sh
|
||
pnpm verify
|
||
pnpm typecheck
|
||
pnpm build
|
||
pnpm verify:build
|
||
```
|
||
|
||
The build fails on broken internal links. The built-output checks verify routes, locally bundled fonts, search content, and the expected site base path.
|
||
|
||
## Publish
|
||
|
||
Open a pull request for subsequent changes. Gitea Actions validates pull requests without publishing. Once a change is merged to `main`, the workflow builds and copies the site to the persistent Pages mount at `/gondor-v1-gitea-pages/eldorado-v1/documentation/`.
|
||
|
||
Check the Actions result for that exact commit, then open [the published site](https://pages.apps.lego-cloud.eu/eldorado-v1/documentation/). Pages access follows the platform’s existing authentication policy; a sign-in redirect is not a failed build.
|