Use strict mode (#5)
Build with strict mode. In particular, this causes the build to fail on invalid links. Co-authored-by: Spencer Bliven <spencer.bliven@gmail.com> Reviewed-on: #5
This commit was merged in pull request #5.
This commit is contained in:
@@ -4,9 +4,11 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build-and-deploy-docs:
|
||||
build-docs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
@@ -20,10 +22,26 @@ jobs:
|
||||
- name: Install mkdocs-material
|
||||
run: pip install mkdocs-material=="9.*"
|
||||
- name: Build documentation
|
||||
run: mkdocs build
|
||||
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
|
||||
- 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
|
||||
- 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 .
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
### Archiving
|
||||
|
||||
@@ -655,20 +655,20 @@ You publish data in the following way: go to <https://discovery.psi.ch> ,
|
||||
login and select all the datasets, that you want to publish under a
|
||||
new DOI.
|
||||
|
||||

|
||||

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

|
||||

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

|
||||

|
||||
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user