analytics/mkdocs.yml at main · georchestra/analytics · 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: geOrchestra analytics

repo_url: https://github.com/georchestra/analytics
repo_name: georchestra-analytics

docs_dir: docs
edit_uri: edit/main/docs/


theme:
  language: en
  features:
    # - toc.integrate
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
  logo: images/georchestra-logo-white.svg
  favicon: images/favicon.ico
  name: material

extra:
  version:
    provider: mike
  generator: false
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:[email protected]
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/georchestra
    - icon: fontawesome/brands/github
      link: https://github.com/georchestra
    - icon: fontawesome/brands/google
      link: https://groups.google.com/g/georchestra?hl=en
    - icon: fontawesome/brands/dev
      link: https://groups.google.com/group/georchestra-dev?hl=fr
    - icon: fontawesome/regular/comments
      link: https://matrix.to/#/#georchestra:osgeo.org


copyright: '© 2025 - geOrchestra'

extra_css:
    - css/extra.css

extra_javascript:
    - assets/custom_versions.js

# 1st and 2nd level tree structure to manage here
# These entries match the documentation template
# Here do not put .fr or .en in the name of the markdown: the i18n plugin manage this for you

nav:
    - Home: index.md
    - User guide:
        - User guide: user_guide/index.md
        - Default usage analytics dashboard: user_guide/superset_dashboard.md
        - Creating new dataviz: user_guide/new_dataviz.md
        - TimescaleDB, creating new aggregated view: user_guide/aggregated_views.md
        - Collecting access logs from several sources: user_guide/multiple_log_sources.md
    - Technical guides:
        - Index: technical_guides/index.md
#        - Administration:
#            - technical_guides/administration/index.md
#            - technical_guides/administration/one_page.md
        - Installation:
            - technical_guides/installation/index.md
            - technical_guides/installation/presentation.md
            - technical_guides/installation/prerequisites.md
            - technical_guides/installation/preparation.md
            - technical_guides/installation/installation.md
            - Configuration:
              - technical_guides/installation/configuration/index.md
              - technical_guides/installation/configuration/gateway.md
              - technical_guides/installation/configuration/security_proxy.md
              - technical_guides/installation/configuration/vector.md
              - technical_guides/installation/configuration/timescaledb.md
              - technical_guides/installation/configuration/analytics-cli.md
              - technical_guides/installation/configuration/superset.md
            - technical_guides/installation/troubleshooting.md
            - Advanced configurations:
              - technical_guides/installation/advanced_configurations/index.md
              - technical_guides/installation/advanced_configurations/gateway_reconcile_netty_logs.en.md
            # - technical_guides/installation/tests.md
        - Contribute:
            - technical_guides/contribute/index.md
            - technical_guides/contribute/analytics-cli.md
            - Documentation:
                - technical_guides/contribute/documentation/index.md
            - Tutorials:
                - technical_guides/contribute/tutorials/index.md
                - How to add a new app processor:
                    - technical_guides/contribute/tutorials/add_a_new_app_processor/index.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - def_list

plugins:
  - search
  - callouts
#  - toc-md:
#     toc_page_title: Contents
#     toc_page_description: Summary of the section
#     header_level: 3
#     pickup_description_meta: false
#     pickup_description_class: false
#     output_path: tableofcontent.md
#     output_log: true
#     ignore_page_pattern: index.md
#     remove_navigation_page_pattern: index.md
#     template_dir_path: custom_template
  - exclude:
      glob:
        - tableofcontent.md
  - i18n:
        docs_structure: suffix
        fallback_to_default: true
        reconfigure_material: true
        reconfigure_search: true
        languages:
          - locale: en
            default: true
            name: English
            build: true
            site_name: "geOrchestra analytics : monitoring your platform usage"
          # - locale: fr
          #   name: Français
          #   build: true
          #   site_name: "Template pour la documentation d'un composant geOrchestra"
          #   nav_translations:
          #     Home: "Accueil"
          #     User guide: "Guide utilisateur"
          #     Index: "Sommaire"
          #     Getting started: "Prendre en main"
          #     Global overview: "Vue globale"
          #     Menus and toolbars: "Barres ou menus d''outils"
          #     Syntax help: "Aide syntaxe"
          #     Technical guides: "Guides techniques"
          #     Administration: "Administrer"
          #     Installation: "Installer"
          #     Contribute: "Développer"


  - git-revision-date-localized:
      enable_creation_date: true