mkdocs.yml

#
# Copyright (C) 2022 DANS - Data Archiving and Networked Services (info@dans.knaw.nl)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

site_name: dans-datastation-architecture
theme:
  name: readthedocs

repo_name: DANS-KNAW/dans-datastation-architecture
repo_url: https://github.com/DANS-KNAW/dans-datastation-architecture

nav:
  - About: index.md
  - Architecture:
      - Core Services: core-services.md
      - Data Station: datastation.md
  - Configurations:
      - Overview: configurations.md
      - DataverseNL: dataversenl.md
      - Vault as a Service: vaas.md
  - External interfaces:
      - Overview: external-interfaces.md
      - SWORD: sword.md
      - Data Vault Storage Root: data-vault-storage-root.md
      - Large Object Store: lob-store.md
  - Internal interfaces:
      - Overview: internal-interfaces.md
      - Deposit Directory: deposit-directory.md
  - Components:
      - Overview: components.md
      - Dataverse: dataverse.md
      - DANS Microservices & Tools: dans-microservices.md
      - DANS Libraries: dans-libraries.md
      - Skosmos: skosmos.md
      - NBN Resolver (KB): nbn-resolver.md
      - Object Store (SURF): object-store.md
      - Data Archive (SURF): data-archive.md
  - Data flow:
      - Data Vault pipeline: vault-pipeline.md
  - Development:
      - Overview: dev.md
      - Common practices: dev-common-practices.md
      - Build status: status.md
plugins:
  - markdownextradata
  - search

extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/lightbox2/2.11.3/css/lightbox.min.css
  - stylesheets/extra.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/lightbox2/2.11.3/js/lightbox-plus-jquery.min.js
  - javascripts/extra.js

extra:
  data_archive: https://www.surf.nl/en/services/data-archive
  dmftar: https://servicedesk.surf.nl/wiki/display/WIKI/Data+Archive%3A+Packaging+with+dmftar
  dans_website: https://dans.knaw.nl/
  dataverse_org: https://dataverse.org/
  dataverse_docs: https://guides.dataverse.org/en/latest/
  dataverse_user_guide: https://guides.dataverse.org/en/latest/user/index.html
  dataverse_api_guide: https://guides.dataverse.org/en/latest/api/index.html
  dataversenl_url: https://dataverse.nl/
  ds_archaeology: https://archaeology.datastations.nl/
  ds_ssh: https://ssh.datastations.nl/
  ds_ls: https://lifesciences.datastations.nl/
  ds_pts: https://phys-techsciences.datastations.nl/
  skosmos_url: https://skosmos.org/
  dans_bagit_profile: https://doi.org/10.17026/DANS-Z52-YBFE
  sword2_url: https://sword.cottagelabs.com/previous-versions-of-sword/sword-v2/sword-v2-specifications/
  easy_url: https://easy.dans.knaw.nl/ui/home
  sword2_examples: https://github.com/DANS-KNAW/dd-dans-sword2-examples
  sword2_examples_docs: https://dans-knaw.github.io/dd-dans-sword2-examples/
  core_trust_seal_url: https://www.coretrustseal.org/about/
  ocfl_url: https://ocfl.io/
  ocfl_java_url: https://github.com/OCFL/ocfl-java
  bagit_specs: https://www.rfc-editor.org/rfc/rfc8493.html
  dans_layer_store_lib: https://dans-knaw.github.io/dans-layer-store-lib/
  bagpack_specs: http://doi.org/10.15497/RDA00025
  easy: https://dans.knaw.nl/en/data-services/easy/
  koninklijke_bibliotheek_url: https://www.kb.nl/en
  jackson_url: https://github.com/FasterXML/jackson-docs
  jpa_url: https://www.oracle.com/java/technologies/persistence-jsp.html
  dans_ocfl_extensions: https://github.com/DANS-KNAW/dans-ocfl-extensions
  dans_bagpack_profile: https://dans-knaw.github.io/dans-bagpack-profile/
  vault_metadata_block: https://docs.google.com/spreadsheets/d/1M0mefIC3VoXgQr-N_HlZlA6FAi_A_FAzbfCzngEEi3o/edit?gid=9637200#gid=9637200&range=A1
  data_archive_url: https://www.surf.nl/diensten/opslag-datamanagement/data-archive
  surf_url: https://www.surf.nl/en
  ghm_registration_service_url: https://persistent-identifier.nl/gmh-registration-service/api/v1/openapi.yaml
  dans_dev_scripts_repo: https://github.com/DANS-KNAW/dans-dev-scripts
  surf_object_store: https://www.surf.nl/en/services/storage-data-management/object-store
  object_version_properties: https://dans-knaw.github.io/dans-ocfl-extensions/object-version-properties/object-version-properties/
  property_registry: https://dans-knaw.github.io/dans-ocfl-extensions/property-registry/property-registry/
  packaging_format_registry: https://dans-knaw.github.io/dans-ocfl-extensions/packaging-format-registry/packaging-format-registry/

markdown_extensions:
  - attr_list
  - admonition
  - codehilite:
      guess_lang: False
      use_pygments: False
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true