From 737eea904cda2d929ac1bd2a7aab23033f0d2eef Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 8 Oct 2025 15:05:28 +0200 Subject: [PATCH] Add Getting Started page --- README.md | 2 +- docs/gettingStarted.md | 16 ++++++++++++++++ mkdocs.yml | 6 ++++++ 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/gettingStarted.md diff --git a/README.md b/README.md index b520379..6017b36 100644 --- a/README.md +++ b/README.md @@ -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 . ## Style Guide diff --git a/docs/gettingStarted.md b/docs/gettingStarted.md new file mode 100644 index 0000000..0ed1192 --- /dev/null +++ b/docs/gettingStarted.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 38505bc..441a0db 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 \ No newline at end of file -- 2.49.1