doc-tech

Technical documentation for services made available by geo.admin.ch.

Branch	CI Status	Deployed version
master		https://sys-docs.int.bgdi.ch/

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. Run make setup to locally install all the necessary packages.
3. Run make serve and open http://localhost:5173/ in your web browser.

Development

This project uses the prettier package for formatting.

To check formatting:

make format-check

To format your files:

make format

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:

   ---
   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:

   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 file:

   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 file:

   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.