From 35f57f4d810fabe777d4b37ed6633b032d29da80 Mon Sep 17 00:00:00 2001 From: minottic Date: Wed, 19 Nov 2025 15:48:48 +0100 Subject: [PATCH] feat: add upgrade page --- docs/202601Upgrade.md | 35 +++++++++++++++++++++++++++++++++++ docs/index.md | 5 +++++ 2 files changed, 40 insertions(+) create mode 100644 docs/202601Upgrade.md diff --git a/docs/202601Upgrade.md b/docs/202601Upgrade.md new file mode 100644 index 0000000..b2a28f3 --- /dev/null +++ b/docs/202601Upgrade.md @@ -0,0 +1,35 @@ +--- +title: 2026/01 upgrade +--- +# 2026/01 upgrade + +From the 5th of January to the 15th of January there will be a major upgrade of the data catalog infrastructure (SciCat - [https://discovery.psi.ch](https://discovery.psi.ch) and [https://dacat.psi.ch](https://dacat.psi.ch)) + +During this period, data archiving and retrieval will not be possible. + +## Required changes + +After the upgrade, few changes will be required: + +### CLI changes + +If you are using pmodules, no changes are required, otherwise: + +1. please download the latest released CLI version (>=v3.0.0) by following the [download instructions](https://github.com/paulscherrerinstitute/scicat-cli?tab=readme-ov-file#manual-deployment-and-upgrade). +2. Modify your ingestion scripts, following the [v3 instructions](https://github.com/paulscherrerinstitute/scicat-cli?tab=readme-ov-file#v3-changes); +3. or download the [backwards compatible scripts](https://github.com/paulscherrerinstitute/scicat-cli?tab=readme-ov-file#backwards-compatibility-with-v2) (linux only). Please note these scripts will later be discontinued (~ Q2 2026). + +### API changes + +Some APIs have been updated. This affects you only if you interact directly with the SciCat APIs. + +1. You can already find and compare the new API specifications from our [QA environment](https://dacat-qa.psi.ch/explorer). +2. Authorization update: API authorization now requires passing your token in the Authorization header, prefixed with Bearer, i.e. Bearer . +3. Login endpoint: API login is now available at "/auth/login" rather than "users/login". + +### Recieving updates notifications + +To receive notifications on updates, please subscribe to the [scicat mailing list](https://psilists.ethz.ch/sympa/info/scicat). + +If you have questions, don't hesitate to contact us at [scicat-help@lists.psi.ch](mailto:scicat-help@lists.psi.ch). + diff --git a/docs/index.md b/docs/index.md index 5f72d10..c53de9b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,10 @@ --- title: Home --- +# :warning: Planned upgrade 2026/01 :warning: + +Please note that there will be a major upgrade that requires client changes. For details, please refer to the [upgrade page](./202601Upgrade.md). + # PSI Data Catalog Documentation The PSI Data Catalog is the preferred way to archive and publish research data from the @@ -11,3 +15,4 @@ principles](https://force11.org/info/the-fair-data-principles/). - Browse the Data Catalog at [discovery.psi.ch](https://discovery.psi.ch) - See published datasets at [doi.psi.ch](https://doi.psi.ch) - Read the [Ingestor Manual](ingestorManual.md) to get started adding your datasets +