CogStack-NiFi/mkdocs.yml at main · CogStack/CogStack-NiFi · 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
site_name: Cogstack NiFi Documentation
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://cogstack-nifi.readthedocs.io/en/latest/"]

theme:
  name: material
  custom_dir: docs/overrides
  favicon: _static/cogstack-logo.png
  logo: _static/cogstack-logo.png
  icon:
    logo: _static/cogstack-logo.png
  palette:
    primary: white

  features:
    - navigation.indexes
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - header.autohide
    - content.tooltips
    - content.action.edit
    - content.action.view
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate # This setting makes the table of contents that usually appears on the right hand side appear inside the main nav tree instead
    - attr_list

repo_url: https://github.com/CogStack/CogStack-NiFi
repo_name: CogStack-NiFi
edit_uri: edit/main/docs/

docs_dir: docs

exclude_docs: |
  README.md

nav:
  - Home: index.md
  - 📰 News: news.md
  - 🛠️ Building the documentation: building-documentation.md
  - 📋 Prerequisites: deploy/main.md
  - 📦 Air-gapped NiFi: deploy/air-gapped.md
  - 📦 Deployment: deploy/deployment.md
  - ⚙️ Configuration: deploy/configuration.md
  - 🧩 Services: deploy/services.md
  - 📛 Troubleshooting: deploy/troubleshooting.md
  - 🔀 Workflows:
      - Overview: deploy/workflows.md
      - 🗄️ Database documents to OpenSearch: deploy/workflows/database_to_opensearch.md
      - 📄 Database documents via OCR: deploy/workflows/database_ocr_to_opensearch.md
      - 🧠 MedCAT annotations to OpenSearch: deploy/workflows/medcat_annotations_to_opensearch.md
      - 📁 Filesystem Parquet to OpenSearch: deploy/workflows/filesystem_parquet_to_opensearch.md
      - ☁️ Azure Blob Parquet to OpenSearch: deploy/workflows/azure_blob_parquet_to_opensearch.md
  - 💧 NiFi:
      - nifi/main.md
      - Development Guide: nifi/development_guide.md
      - Processors Catalog: nifi/processors_catalog.md
      - Processor Scripting: nifi/processor_scripting.md
      - User Scripts: nifi/user_scripts.md
      - Python Extensions: nifi/user_python_extensions.md
  - 🛡️ Security:
      - security/main.md
      - 🏛️ Certificates and Root CA: security/certificates.md
      - 🗄️ Additional services: security/services.md
      - 🔐 NiFi TLS & Admin Access Setup (with NGINX): security/nifi.md
      - 🌐 Elasticsearch / OpenSearch Security: security/elasticsearch_opensearch.md

plugins:

  - search


extra:
  analytics:
    provider: custom


markdown_extensions:
  - md_in_html
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn