wangup-docs/mkdocs.yml at main · NTU-CompHydroMet-Lab/wangup-docs · 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
site_name: WangUp Computing Documentation
site_description: Documentation for lab computing infrastructure and resources
site_author: Kilin
repo_url: https://github.com/NTU-CompHydroMet-Lab/wangup-docs
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.footer
    - navigation.path
    - navigation.expand
    - navigation.indexes
    - navigation.sections
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - tags
  - glightbox
  - privacy:
      links_attr_map:
        target: _blank

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: docs
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.blocks.caption
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md

  - User Guide:
    - Quick Reference: user-guide/quick-reference.md
    - Specs: infrastructures/computing-specs.md
    - Tools: user-guide/tools.md
    - FAQ: user-guide/faq.md
    # - Rules of Conduct: user-guide/rules-of-conduct.md
    - New Users:
      - Account Registry: user-guide/onboard/account.md
      - Environment: user-guide/onboard/environment.md
      - Development: user-guide/onboard/development.md
    - Containers:
      - Introduction: user-guide/containers/intro.md
      - Images: user-guide/containers/lab-images.md
      - Using Podman: user-guide/containers/use-podman.md
      # - Harbor Registry: user-guide/containers/harbor.md
      - Building Images: user-guide/containers/building.md
    - Storage:
      - Overview: user-guide/storage/overview.md
      - Transferring Data: user-guide/storage/transfer.md
      - Shared Datasets: user-guide/storage/datasets.md
      - Synology Web UI: user-guide/storage/synology.md
    # - Services:
    #   - Github Organization: user-guide/services/github.md
    #   - Discord Bot: user-guide/services/discord.md
    #   - Harbor Registry: user-guide/services/harbor.md
    #   - Account Management: user-guide/services/ldap.md
    #   - Synology Web UI: user-guide/storage/synology.md
    #   - InfluxDB:  user-guide/service/influxdb.md

  - HPC:
    - Overview: hpc/overview.md
    - Quickstart: hpc/quickstart.md
    - Concepts:
      - Architecture: hpc/architecture.md
      - Job Scheduling (Slurm): hpc/slurm.md
      - Containers: hpc/containers.md
      - File Transfer: hpc/transfer.md
      - Getting Access (iService): hpc/iservice.md
    - Systems:
      - Nano4: hpc/nano4/overview.md
      - Nano5: hpc/nano5/overview.md
      - Forerunner1: hpc/f1/overview.md
      - Twnia3: hpc/twnia3/overview.md
      - TWCC: hpc/twcc/overview.md

  - Maintainer:
    - Overview: maintainer/overview/overview.md
    - Team: maintainer/team.md
    - Administration:
      - Users:
        - New Account: maintainer/admin/new-account/new-account.md
        # Stubs — uncomment when written:
        # - Remove Account: maintainer/admin/users/remove-account.md
        # - Reset Password: maintainer/admin/users/reset-password.md
      - Infrastructure:
        - New Compute Node: maintainer/admin/new-node/new-node.md
        # Stubs — uncomment when written:
        # - OS Installation: maintainer/admin/infrastructure/os-install.md
        # - New NAS: maintainer/admin/new-nas/new-nas.md
        # - Migrate User Home: maintainer/admin/infrastructure/migrate-user-home.md
      # Stubs — uncomment when written:
      # - Lab Images:
      #   - Publish New Version: maintainer/admin/lab-images/publish.md
      # - Services:
      #   - Add Traefik Route: maintainer/admin/services/add-traefik-route.md
      #   - Add Harbor Project: maintainer/admin/services/add-harbor-project.md
      # - Security: maintainer/admin/security/security.md
    - Services:
      - Harbor Registry: maintainer/services/harbor/harbor-registry.md
      # Stubs — uncomment when written:
      # - Synology NAS: maintainer/services/nas/nas-webui.md
      # - LDAP Server: maintainer/services/ldap/ldap-server.md
      # - Discord Bot: maintainer/services/discord/discord.md
      # - Influx DB: maintainer/services/influx/influx.md
      # - Postgres DB: maintainer/services/postgres/pg.md
      # - EMQX Broker: maintainer/services/emqx/emqx.md
      # - Traefik: maintainer/services/traefik/traefik.md
    - Cloud:
      - Cloudflare: maintainer/cloud/cloudflare/cloudflare.md
      # Stubs — uncomment when written:
      # - Google GCP: maintainer/cloud/gcp/gcp.md
      # - SquareSpace: maintainer/cloud/sspace/sspace.md
    # Stubs — uncomment when written:
    # - Hardwares:
    #   - Machines: maintainer/hardwares/machines/machines.md
    #   - Sensors:
    #     - OTT Parsivel2: maintainer/hardwares/sensors/parsivel.md
    #     - OTT Pluvio L: maintainer/hardwares/sensors/pluviol.md
    #     - OTT Pluvio S: maintainer/hardwares/sensors/pluvios.md
    #     - Lufft WS100: maintainer/hardwares/sensors/ws100.md
    #     - Theis Ultrasonic 3D: maintainer/hardwares/sensors/ultra.md
    #   - Power (UPS): maintainer/hardwares/ups/ups.md
    #   - Network: maintainer/hardwares/network/network.md
    #- Weather Sensors: maintainer/sensors.md
    # - Docker Services: maintainer/dockerfiles.md
    # - Storage Infrastructure: maintainer/storage.md
    # - Roadmap: maintainer/roadmap.md

  # - Reference:
  #   - Glossary: reference/glossary.md
  #   - FAQ: reference/faq.md
  #   - Quick Reference: reference/quick-ref.md
  #   - External Resources: reference/resources.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/NTU-CompHydroMet-Lab
  annotate:
    dockerfile: [.s2]
    json: [.s2]

extra_css:
  - stylesheets/extra.css