openobserve-docs/mkdocs.yml at main · openobserve/openobserve-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
site_name: OpenObserve Documentation
site_url: https://openobserve.ai/docs
site_description: OpenObserve (O2) is a cloud-native observability platform that unifies logs, metrics, and traces into a single solution, built for petabyte scale with up to 140x lower storage cost than Elasticsearch.
# https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin required for nav
hooks:
  - hooks/llm_markdown.py
plugins:
  - search
  - awesome-pages
  - material-plausible
  - llmstxt:
      sections:
        Getting started:
          - index.md
          - getting-started.md
          - quickstart.md
          - architecture.md
          - downloads.md
        User guide:
          - user-guide/*.md
        Ingestion:
          - ingestion/*.md
        Integrations:
          - integration/*.md
        Features:
          - features/*.md
        Administration:
          - administration/*.md
        Reference:
          - reference/*.md
        Migration:
          - migration/*.md
        Releases:
          - releases.md
# nav:
#   - index.md
#   - getting-started.md
#   - installation.md
#   - ...
#   - monitoring.md
extra_css:
  - stylesheets/extra.css
  - stylesheets/feedback.css
  - css/output.css
  - css/landing-page.css
extra_javascript:
  - https://unpkg.com/openapi-explorer@0/dist/browser/openapi-explorer.min.js
  # - js/ms-clarity.js
  # - js/zinc.js
  # - js/vector_co.js
  - js/search-close-minimal.js
  - js/search-tracking.js
  - js/theme.js
  # - js/toc-highlight.js
  - https://buttons.github.io/buttons.js
  # - js/reo.js
  - js/landing-individual-card-ms-tracking.js
  - js/google-tag-manager.js
  - js/feedback.js
  - js/segment.js
extra:
  # social:
  #   - icon: fontawesome/brands/linkedin
  #     link: https://www.linkedin.com/company/zinclabsinc
  #   - icon: fontawesome/brands/github
  #     link: https://github.com/openobserve/openobserve
  #   - icon: fontawesome/brands/docker
  #     link: https://gallery.ecr.aws/zinclabs/openobserve
  #   - icon: fontawesome/brands/slack
  #     link: https://short.openobserve.ai/community
  alternate:
    # - name: English
    #   link: /en/
    #   lang: en
    # - name: Chinese
    #   link: /cn/
    #   lang: zh
  generator: false
  default_color_scheme: default
  # version:
  #   provider: mike
  analytics:
    provider: google
    property: G-3383ZJ2HH7
    domain: openobserve.ai
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: Thank you for your feedback.
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: Thank you, we will review this page.
    # feedback:
    #   title: Was this page helpful?
    #   ratings:
    #     - icon: material/emoticon-happy-outline
    #       name: This page was helpful
    #       data: good
    #       note: >-
    #         Thanks for your feedback!

    #     - icon: material/emoticon-sad-outline
    #       name: This page could be improved
    #       data: bad
    #       note: >-
    #         Thanks for your feedback! Help us improve this page by
    #         using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
theme:
  favicon: images/logo_circle.png
  name: material
  custom_dir: overrides
  features:
    # - navigation.expand
    # - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.instant
    - navigation.tracking
    - content.code.copy
    - content.code.select
  palette:
    - scheme: default
      primary: white
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode
# repo_url: https://github.com/openobserve/openobserve
# repo_name: openobserve/openobserve
# edit_uri: https://github.com/openobserve/openobserve-docs/edit/main/docs/
markdown_extensions:
  - admonition
  - tables
  - attr_list
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - meta