https://github.com/geoadmin/doc-tech
Technical Documentation for geoadmin
https://github.com/geoadmin/doc-tech
managed-by-tf
Last synced: 4 months ago
JSON representation
Technical Documentation for geoadmin
- Host: GitHub
- URL: https://github.com/geoadmin/doc-tech
- Owner: geoadmin
- Created: 2025-04-03T13:55:08.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2026-02-12T12:53:26.000Z (4 months ago)
- Last Synced: 2026-02-12T19:26:41.697Z (4 months ago)
- Topics: managed-by-tf
- Language: TypeScript
- Homepage:
- Size: 6.6 MB
- Stars: 2
- Watchers: 9
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# doc-tech
Technical documentation for services made available by geo.admin.ch.
| Branch | CI Status | Deployed version |
|-------------| ---------- | ---------------- |
| master |  | |
## Getting Started
To build and run the site locally:
1. Make sure Node.js v22 or higher is installed (`node -v`). If you have `nvm` installed you should have automatically the correct version due to `.nvmrc`
2. Optional: Activate a suitable Node version, e.g. with `nvm use stable`
ℹ️ Use `nvm list` to see all available Node versions
3. Run `npm install` to locally install all the necessary packages
4. Run `npm run docs:dev` and visit http://localhost:5173/ in your web browser
## Development
This project uses the [prettier](https://prettier.io/) package for formatting.
You can automatically run prettier with these commands:
1. `npm run format`
2. `npm run format:check`
## How to Add a Release Note
To add a release note, follow these steps:
1. Navigate to the `.releases/` folder in the project directory.
2. Create a new file with the following naming convention: `YYYYMMDD.md` (e.g., `20250514.md`).
3. Add the following header to the file:
```markdown
---
title: YYYYMMDD
date: Day, Month DDth YYYY
---
```
Replace `YYYYMMDD` with the release date, and update the `date` field with the full date in a human-readable format.
4. Add the markdown content for the release note below the header.
5. (Optional) If you do not want the release note to appear in the sidebar menu, add the following variable to the header:
```markdown
ignoreSideBar: true
```
6. Save the file and commit your changes.
## How to Edit the Status Banner
1. To edit the status banner, use the following variables located in the [`status-page.md`](./page/status-page.md) file:
```YAML
previewType: "info"
previewTitle: "Issues in services"
previewContent: "Our systems are experiencing issues"
```
2. Update the `previewType` variable (`info` or `warning`) to control the color and the position in the page :
- `info`: bottom of the page, just text without backgound color
- `warning`: top of the page, yellow banner
- `danger`: top of the page, red banner
3. Save the file and commit your changes.
## How to Edit the End-of-Life Preview
1. To edit the End-of-Life preview, use the following variables located in the [`end-of-life.md`](./page/end-of-life.md) file:
```YAML
previewTitle: "Decomissioning of legacy vectortile styles / tiles"
previewContent: "Old styles for Light Base Map and Imagery Base Map no longer available from January 2025"
```
2. Save the file and commit your changes.