Add Getting Started page
All checks were successful
Lint markdown files / run-markdownlint (pull_request) Successful in 3s
Build and deploy documentation / build-and-deploy-docs (push) Successful in 7s

This commit was merged in pull request #4.
This commit is contained in:
Spencer Bliven
2025-10-08 15:05:28 +02:00
parent 827abd6f9b
commit 737eea904c
3 changed files with 23 additions and 1 deletions

View File

@@ -9,7 +9,7 @@ Documentation](https://data-catalog-services.pages.psi.ch/)
docker compose up -d
```
to spin up a local environment. Preview available on `localhost:8000`.
to spin up a local environment. Preview available on <http://localhost:8000>.
## Style Guide

16
docs/gettingStarted.md Normal file
View File

@@ -0,0 +1,16 @@
---
title: Getting Started
description: Resources to quickly get started using the PSI Data Catalog
---
Please see the following resources to get started using the PSI Data Catalog:
- The comprehensive **[Ingestor Manual]({{relative_url ingestorManual.md}})**.
- A 2019 presentation [Data Catalog for Scientific Data: How to get
started](/assets/presentation/SciCatGettingStartedSLSSummary.pdf), targeted towards
SLS users (_note: some commands are now outdated._)
- [CLS Data Catalog
Documentation](https://intranet.psi.ch/en/cls/data-catalog-and-archive) targeted
towards life science users
- The [OpenEM](https://www.openem.ch/documentation) project documentation, which uses
the catalog for electron microscopy data.

View File

@@ -25,6 +25,7 @@ theme:
#- navigation.tabs
- toc.follow
# - toc.integrate
- navigation.footer
palette:
- media: "(prefers-color-scheme)"
toggle:
@@ -44,3 +45,8 @@ theme:
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
nav:
- index.md
- gettingStarted.md
- ingestorManual.md