geocodes/mkdocs.yml at main · earthcube/geocodes · 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
## run `mkdocs serve` from docks to test this out

site_name: Geocodes Documentation
repo_url: https://github.com/earthcube/geocodes
edit_uri: blob/docs/docs/
theme:
#  name: 'readthedocs'
  name: material
  features:
    - content.action.edit
    - content.action.view
    - navigation.sections
    - navigation.tabs
    - navigation.path
    - navigation.indexes
    - navigation.footer
    - announce.dismiss
  icon:
    edit: material/pencil
    view: material/eye
extra:
  social:
    - icon: fontawesome/brands/slack
      link: https://earthcube.slack.com
      name: Earthcube on Slack
    - icon: fontawesome/brands/github
      link: https://github.com/earthcube/geocodes
      name: Geocodes on Github
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/?namespace=nsfearthcube
      name: Earthcube on Dockerhub
markdown_extensions:
  - toc:
      permalink: 
  - attr_list
  - def_list
  - tables
  - pymdownx.highlight:
      use_pygments: false
  - admonition
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences


plugins:
  - glightbox
  - search
  # literate_nav must load after multirepo for the features to be available.
  - multirepo:
      # (optional) tells multirepo to cleanup the temporary directory after site is built.
      cleanup: true
  -  mermaid2
  - literate-nav
  #https://pypi.org/project/mkdocs-jupyter/
  -  mkdocs-jupyter
  - callouts
  - include-markdown

#extra_javascript:
#  - https://unpkg.com/mermaid/dist/mermaid.min.js
#  -
nav:
  - How To Create a Geocodes Server:
    - Overview: index.md
    - List of services: stack_machines.md
  - Setup:
      - Services:
        - Base Machine: setting_up_services/setup_base_machine_configuration.md
        - Create Services Containers: setting_up_services/setup_geocodes_services_containers.md
        - Create Gleaner Containers: setting_up_services/setup_gleaner_container.md
      - Test Data:
        - Load Data: data_loading/indexing_with_gleanerio_for_testing.md
      - User Interface:
        - Create Geocodes UI Containers: setting_up_user_interface/setup_geocodes_ui_containers.md
        - Creating a Community Instance (Tenant): setting_up_user_interface/tenant
  - Load Data:
      - Load Data: data_loading/setup_indexing_with_gleanerio.md
      - Configuration Examples: data_loading/configuration
      - Onboarding: data_loading/onboarding_or_testing_a_datasource.md
      #- Watching Data Loading:  data_loading/watching_manual_gleanerio_data_loading.md
      - data_loading/*.md
  - Production:
      - Production: production
      - Creating and Loading Production: production/creatingAndLoadingProduction.md
      - Manage Services: production/managing_services.md
      - Testing/Onboarding a Datasource: data_loading/onboarding_or_testing_a_datasource.md
      - Production UI DNS changes: production/production_ui_deployment.md
      - Restore after Docker Swarm Corruption: production/restore-after-docker-swarm-corruption.md
  - Tooling:
      - Install Glcon: data_loading/install_glcon.md
      - Earthcube Utilities:
          - Overview: https://earthcube.github.io/earthcube_utilities/
          - Earthcube Utilities: https://earthcube.github.io/earthcube_utilities/earthcube_utilities/
          - Summarize: https://earthcube.github.io/earthcube_utilities/summarize/
  - Development:
      - User Interface: development/index.md
      - Local Stacks: development/local_stacks.md
      - Configuration examples (TBD): docs/development/localdeveloper_configs.md
  - Help:
    -        Some SPARQL Queries: production/sparql.md
    - Troubleshooting: troubleshooting.md