hyperbytedb/mkdocs.yml at main · hyperbyte-cloud/hyperbytedb · 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
site_name: HyperbyteDB Documentation
site_description: Documentation for HyperbyteDB — a time-series database with InfluxDB v1 compatibility, embedded chDB MergeTree storage, and master-master clustering
site_url: https://docs.hyperbyte.cloud
repo_url: https://github.com/hyperbyte-cloud/hyperbytedb
repo_name: hyperbyte-cloud/hyperbytedb
edit_uri: edit/main/docs/

theme:
  name: material
  logo: img/logo.png
  palette:
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - header.autohide
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - minify:
      minify_html: true

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

validation:
  nav:
    omitted_files: info
  links:
    not_found: info

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/hyperbyte-cloud/hyperbytedb
  generator: false

nav:
  - Home: index.md
  - User Guide:
      - user-guide/index.md
      - Installation: user-guide/installation.md
      - Kubernetes operator:
          - Overview: user-guide/operator/index.md
          - Installation: user-guide/operator/installation.md
          - HyperbytedbCluster: user-guide/operator/cluster.md
          - Backup & Restore: user-guide/operator/backup-restore.md
          - hyperbytedb-proxy: user-guide/operator/hyperbytedb-proxy.md
      - Configuration: user-guide/configuration.md
      - Basic operations: user-guide/basic-operations.md
      - CLI (hyperbytedb-cli): user-guide/cli.md
      - Authentication: user-guide/authentication.md
      - Advanced features: user-guide/advanced-features.md
      - Common workflows: user-guide/common-workflows.md
      - Administration: user-guide/administration.md
      - Troubleshooting: user-guide/troubleshooting.md
      - API & TimeseriesQL Reference: user-guide/reference.md
  - Developer Guide:
      - developer-guide/index.md
      - Architecture: developer-guide/architecture.md
      - System architecture: developer-guide/system-architecture.md
      - Development Setup: developer-guide/development-setup.md
      - Coding Standards: developer-guide/coding-standards.md
      - Internals:
          - developer-guide/internals/index.md
          - Core Modules: developer-guide/internals/core-modules.md
          - Key Design Decisions: developer-guide/internals/key-design-decisions.md
          - Replication design: developer-guide/internals/replication-design.md
          - Extension Points: developer-guide/internals/extension-points.md
      - Testing: developer-guide/testing.md
      - Building & CI: developer-guide/building-and-ci.md
      - Contributing: developer-guide/contributing.md
  - Benchmarks: benchmarks.md
  - Deep Dive Series:
      - Clustering: deep-dive/deep-dive-clustering.md
      - Compaction: deep-dive/deep-dive-compaction.md
      - Read Path: deep-dive/deep-dive-read-path.md
      - Write Path: deep-dive/deep-dive-write-path.md
      - Self Repair: deep-dive/deep-dive-self-repair.md
  - Glossary: glossary.md