cr8tor/mkdocs.yml at main · SETT-Centre-Data-and-AI/cr8tor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
site_name: CR8TOR - 5-Safes Compliant Data Orchestration
site_url: https://lsc-sde-crates.github.io/cr8tor/
repo_url: https://github.com/lsc-sde-crates/cr8tor
repo_name: GitHub
site_description: >
  CR8TOR is a data orchestration tool that is 5-Safes compliant.
  It is designed to help Secure Data Environment operators to manage the
  ingress of curated datasets from a data warehouse or lake hoouse
  into a ressearch workspace.
site_author: https://github.com/lsc-sde-crates
nav:
  - Home: index.md
  - User Guide:
    - Create New DAR Project: user-guide/create-new-dar-project.md
    - Update DAR files: user-guide/update-resources-files.md
    - Orchestrate DAR: user-guide/orchestrate-dar.md
    - Approve DAR: user-guide/approve-dar.md
    - Environments: user-guide/environments.md
    - Troubleshooting: user-guide/troubleshooting.md
  - Developer Guide:
    - Orchestration layer setup: developer-guide/orchestration-layer-setup.md
    - Source setup: developer-guide/source-setup.md
  - Cr8tor CLI App:
    - CLI Commands: cr8tor-cli/commands.md
    - Development: cr8tor-cli/development.md
    - Example Usage: cr8tor-cli/example_usage.md
    - Branching Strategy: cr8tor-cli/branching-strategy.md
  - Cr8tor Publisher App:
    - Overview: cr8tor-publisher/overview.md
    - Approval Service: cr8tor-publisher/approval-service.md
    - Metadata Service: cr8tor-publisher/metadata-service.md
    - Publish Service: cr8tor-publisher/publish-service.md
  - CookieCutter Template:
    - Overview: cr8tor-cookiecutter/overview.md
    - Branching Strategy: cr8tor-cookiecutter/branching-strategy.md
  - LSC SDE:
    - Infrastructure: lscsde/infrastructure.md
    - Azure Data Share: lscsde/azuredatashare.md
    - Deploy to Kubernetes: lscsde/deployment-to-kubernetes.md

 # - Schema Reference: schema_reference.md
theme:
  name: material
  logo: logo.png
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - content.code.copy
    - navigation.expand
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - toc.follow
    # - toc.integrate
plugins:
  - search
  - glightbox:
       width: 100%
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - griffe_pydantic:
                  schema: true
  - autorefs

watch:
  - src/cr8tor
markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          # format: !!python/name:pymdownx.superfences.fence_code_format