documentation/mkdocs-resources.yml at main · mat3ra/documentation · 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# Platform Resources — infrastructure, storage, and compute resources.
# Covers clusters, login nodes, resource management, and data storage.
# Deploy to: docs.mat3ra.com/resources/

INHERIT: mkdocs-base.yml

docs_dir: !!python/object/apply:os.getenv ["DOCS_DIR", "lang/en/docs"]

# Exclude pages that belong to other sites.
exclude_docs: |
  accounts/
  benchmarks/
  cli/
  collaboration/
  data/
  data-structured/
  entities-general/
  getting-started/
  jobs/
  /jobs-cli/
  jobs-designer/
  jupyterlite/
  materials/
  materials-designer/
  methods/
  methods-directory/
  models/
  models-directory/
  other/
  pricing/
  properties/
  properties-directory/
  remote-connection/
  rest-api/
  security/
  site-policy/
  software/
  software-directory/
  tutorials/
  ui/
  workflow-designer/
  workflows/
  migrating-to-new-platform.md

  # Interface-only pages in shared dirs
  data-in-objectstorage/actions/
  data-in-objectstorage/ui/

  # Other sites' homepages
  index.md
  index-guide.md
  index-interface.md
  index-concepts.md
  index-dev.md
  index-developers.md
  index-cli.md
  index-standards.md

  # Data Standards site pages
  models/data.md
  methods/data.md
  software/data.md
  models-directory/dft/data.md
  models-directory/machine-learning/data.md
  methods-directory/pseudopotential/data.md
  methods-directory/linear-regression/data.md
  materials/data.md
  jobs/data.md

validation:
  nav:
    omitted_files: info
    not_found: warn
  links:
    absolute_links: info

site_name: "Platform Resources"
site_url: https://docs.mat3ra.com/resources
site_description: "Compute clusters, storage systems, and resource management for the Mat3ra platform."
dev_addr: "localhost:8005"

theme:
  features:
    - announce.dismiss
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.top
    - search.highlight
    - search.suggest
    - navigation.expand

extra:
    # Cross-site URL variables (resolved by macros plugin at build time)
    guide_url: https://docs.mat3ra.com/guide
    interface_url: https://docs.mat3ra.com/interface
    reference_url: https://docs.mat3ra.com/reference
    resources_url: https://docs.mat3ra.com/resources
    developers_url: https://docs.mat3ra.com/developers
    cli_url: https://docs.mat3ra.com/command-line
    data_url: https://docs.mat3ra.com/standards


nav:
    - "← All Docs":                                      /
    - Home:                                              index-resources.md

# INFRASTRUCTURE
    - General Infrastructure:
        - Overview:                                     infrastructure/overview.md
        - Storage System:                               infrastructure/storage.md
        - Login Node:
            - Overview:                                 infrastructure/login/overview.md
            - Directory Structure:                      infrastructure/login/directories.md
        - Clusters:
            - Overview:                                 infrastructure/clusters/overview.md
            - Directory Structure:                      infrastructure/clusters/directories.md
            - Hardware Specifications:                  infrastructure/clusters/hardware.md
            - Google Clusters:                          infrastructure/clusters/google.md
            - AWS Clusters:                             infrastructure/clusters/aws.md
            - Azure Clusters:                           infrastructure/clusters/azure.md
        - Resource Management:
            - Overview:                                 infrastructure/resource/overview.md
            - Category:                                 infrastructure/resource/category.md
            - Queues:                                   infrastructure/resource/queues.md
        - Compute:
            - Overview:                                 infrastructure/compute/overview.md
            - Parameters:                               infrastructure/compute/parameters.md
            - Data:                                     infrastructure/compute/data.md

# DATA ON DISK
    - Data on Disk:
        - Overview:                                     data-on-disk/overview.md
        - Directory Structure:                          data-on-disk/directories.md
        - Quotas:                                       data-on-disk/quotas.md
        - Security:                                     data-on-disk/security.md

# DATA IN OBJECT STORAGE — Concepts
    - Data in Object Storage:
        - Overview:                                     data-in-objectstorage/overview.md
        - Files:                                        data-in-objectstorage/files.md
        - Security:                                     data-in-objectstorage/security.md
        - Dropbox:                                      data-in-objectstorage/dropbox.md