From 87fe4c0bed115a7f7be6c244de058fce3e5e5ae2 Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 8 Oct 2025 15:36:48 +0200 Subject: [PATCH 1/3] Use strict mode --- .gitea/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitea/workflows/deploy.yml b/.gitea/workflows/deploy.yml index 64fe7d2..f96d024 100644 --- a/.gitea/workflows/deploy.yml +++ b/.gitea/workflows/deploy.yml @@ -20,7 +20,7 @@ jobs: - name: Install mkdocs-material run: pip install mkdocs-material=="9.*" - name: Build documentation - run: mkdocs build + run: mkdocs build -s - name: Deploy documentation # the default mkdocs build output directory `/site` is gitignored # so it's safe to `git rm -rf .` -- 2.49.1 From ea3f525e84a7cffe3165e0120c0cbb51d03091cf Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 8 Oct 2025 15:44:20 +0200 Subject: [PATCH 2/3] Run build on PRs --- .gitea/workflows/deploy.yml | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/.gitea/workflows/deploy.yml b/.gitea/workflows/deploy.yml index f96d024..ad63bd3 100644 --- a/.gitea/workflows/deploy.yml +++ b/.gitea/workflows/deploy.yml @@ -4,9 +4,29 @@ on: push: branches: - main + pull_request: workflow_dispatch: + jobs: - build-and-deploy-docs: + build-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure git credentials + run: | + git config --global user.name "Gitea Actions" + git config --global user.email "actions@gitea.local" + - uses: actions/setup-python@v5 + with: + python-version: "3" + - name: Install mkdocs-material + run: pip install mkdocs-material=="9.*" + - name: Build documentation + run: mkdocs build -s + + deploy-docs: + needs: build-docs + if: github.event_name == 'push' && github.ref == 'refs/heads/main' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -22,8 +42,6 @@ jobs: - name: Build documentation run: mkdocs build -s - name: Deploy documentation - # the default mkdocs build output directory `/site` is gitignored - # so it's safe to `git rm -rf .` run: | git checkout --orphan gitea-pages git rm -rf . -- 2.49.1 From 4cca0771d1e7130b181878286df99b889c081e90 Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 8 Oct 2025 15:45:50 +0200 Subject: [PATCH 3/3] Fix broken links --- docs/gettingStarted.md | 4 ++-- docs/ingestorManual.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/gettingStarted.md b/docs/gettingStarted.md index 0ed1192..3e8eaee 100644 --- a/docs/gettingStarted.md +++ b/docs/gettingStarted.md @@ -5,9 +5,9 @@ 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}})**. +- The comprehensive **[Ingestor Manual](ingestorManual.md)**. - A 2019 presentation [Data Catalog for Scientific Data: How to get - started](/assets/presentation/SciCatGettingStartedSLSSummary.pdf), targeted towards + started](assets/presentations/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 diff --git a/docs/ingestorManual.md b/docs/ingestorManual.md index 5dd8a60..66432a5 100644 --- a/docs/ingestorManual.md +++ b/docs/ingestorManual.md @@ -611,7 +611,7 @@ enter your PSI credentials. Functional accounts are not supported. The first step is always to select the pgroup. If there is no proposal assigned to this account, you will have to specify the information about the PI manually. -![img](./screenshots/proposal_found.png "Pgroup selection") +![Pgroup selection](assets/images/screenshots/proposal_found.png "Pgroup selection") ### Archiving @@ -655,20 +655,20 @@ You publish data in the following way: go to , login and select all the datasets, that you want to publish under a new DOI. -![img](./screenshots/PublishingData1.png "Selecting Datasets to be published") +![Selecting Datasets to be published](assets/images//screenshots/PublishingData1.png "Selecting Datasets to be published") Then you add these datasest a a "shopping cart" by using the "add to Cart" button. You can repeat this often as needed. Once finished with the selection you can "check out" the cart (click on the cart in the top bar) and pick the "Publish" action. -![img](./screenshots/PublishingData2.png "Check out cart") +![Check out cart](assets/images//screenshots/PublishingData2.png "Check out cart") This opens a form with prefilled information derived from the connected proposal data. This data can then be edited by the user and finally saved. -![img](./screenshots/PublishingData3.png "Defining metadata of published data") +![Defining metadata of published data](assets/images//screenshots/PublishingData3.png "Defining metadata of published data") This defines the data as to be published and makes it known to the data catalog, but the corresponding DOI is not yet made globally -- 2.49.1