mkdocs.yml

site_name: 'Quix Docs'
site_description: 'Quix Developer Documentation. Includes documentation (guides, tutorials, references) for Quix Cloud, Quix Streams client library, and REST and websocket APIs.'
site_author: 'Quix.io'
site_url: 'https://quix.io/docs'

copyright: >
  Copyright © 2020 - 2023 Quix Analytics, Ltd. –
  <a href="#__consent">Change cookie settings</a>

docs_dir: docs/
repo_name: quixio/quix-docs
repo_url: https://github.com/quixio/quix-docs
edit_uri: tree/dev/docs

nav:
  - 'Get started':
    - 'Welcome': 'get-started/welcome.md'
    - 'Quickstart': 'get-started/quickstart.md'
    - 'Quix Tour': 
      - 'Overview': 'get-started/quixtour/overview.md'
      - '1. Ingest': 'get-started/quixtour/ingest-push.md'
      - '2. Process': 'get-started/quixtour/process-threshold.md'
      - '3. Serve': 'get-started/quixtour/serve-sms.md'
    - 'Project templates': 'get-started/project-templates.md'
    - 'Quix CLI': 'get-started/cli.md'
    - 'What is Quix?': 'get-started/what-is-quix.md'
    - 'Glossary': 'get-started/glossary.md'
    - 'Contribute': 'get-started/contribute.md'
  - 'Create':
    - 'Overview': 'create/overview.md'
    - 'Create a project': 'create/create-project.md'
    - 'Create an environment': 'create/create-environment.md'
    - 'Protected environments': 'create/protected-environment.md'
    - 'Syncing an environment': 'create/syncing-environment.md'
    - 'Project structure': 'create/project-structure.md'
  - 'Develop':
    - 'Overview': 'develop/overview.md'
    - 'Create an application': 'develop/create-application.md'
    - 'Authentication':
      - 'Personal Access Token (PAT)': 'develop/authentication/personal-access-token.md'
      - 'Streaming Token': 'develop/authentication/streaming-token.md'
    - 'Using Code Samples': 'develop/code-samples.md'
    - 'Connectors': 
      - 'connectors/index.md'
#ConnectorsGetInsertedHere
    - 'Integrate your data':
      - 'Overview': 'develop/integrate-data/overview.md'
      - 'Prebuilt connectors': 'develop/integrate-data/prebuilt-connector.md'
      - 'Read CSV file': 'develop/integrate-data/read-csv.md'
      - 'Polling': 'develop/integrate-data/polling.md'
      - 'Inbound webhooks': 'develop/integrate-data/inbound-webhooks.md'
      - 'External source': 'develop/integrate-data/external-source.md'
      - 'External destination': 'develop/integrate-data/external-destination.md'
      - 'Streaming APIs': 'develop/integrate-data/streaming-apis.md'
      - 'Quix Streams': 'develop/integrate-data/quix-streams.md'
      - 'Web app': 'develop/integrate-data/web-app.md'
      - 'Export to Jupyter notebooks': 'develop/integrate-data/jupyter-nb.md'
    - 'Process your data':
      - 'Overview': 'develop/process/overview.md'
      - 'Types of processing': 'develop/process/types-of-processing.md'
      - 'Types of transform': 'develop/process/types-of-transform.md'
      - 'Generating events': 'develop/process/timeseries-events.md'
    - 'APIs': 
      - 'Overview': 'develop/apis-overview.md'
      - 'Streaming Writer API': 
        - 'Overview': 'apis/streaming-writer-api/overview.md'
        - 'Setup': 'apis/streaming-writer-api/setup.md'
        - 'HTTP requests': 'apis/streaming-writer-api/http-requests.md'
        - 'Create a new Stream': 'apis/streaming-writer-api/create-stream.md'
        - 'Add Stream metadata': 'apis/streaming-writer-api/stream-metadata.md'
        - 'Send Parameter data': 'apis/streaming-writer-api/send-data.md'
        - 'Send an Event': 'apis/streaming-writer-api/send-event.md'
      - 'Streaming Reader API': 
        - 'Overview': 'apis/streaming-reader-api/overview.md'
        - 'Setup': 'apis/streaming-reader-api/setup.md'
        - 'Reading data': 'apis/streaming-reader-api/reading-data.md'
        - 'Subscription and events': 'apis/streaming-reader-api/subscriptions.md'
  - 'Deploy':
    - 'Overview': 'deploy/overview.md'
    - 'Environment variables': 'deploy/environment-variables.md'
    - 'Secrets management': 'deploy/secrets-management.md'
    - 'YAML variables': 'deploy/yaml-variables.md'
    - 'State management': 'deploy/state-management.md'  
    - 'Deploy public services': 'deploy/deploy-public-page.md'
  - 'Manage':
    - 'Overview': 'manage/overview.md'
    - 'Troubleshooting': 'manage/troubleshooting.md'
    - 'Security': 'manage/security.md'
    - 'MLOps': 'manage/MLOps.md'
    - 'Using replay service': 'manage/replay.md'
    - 'Testing using Quix data store': 'manage/testing-data-store.md'
    - 'Query API': 
      - 'Overview': 'apis/query-api/overview.md'
      - 'Setup': 'apis/query-api/setup.md'
      - 'HTTP requests': 'apis/query-api/http-requests.md'
      - 'Paged streams': 'apis/query-api/streams-paged.md'
      - 'Filtered streams': 'apis/query-api/streams-filtered.md'
      - 'Streams with models': 'apis/query-api/streams-models.md'
      - 'Raw data': 'apis/query-api/raw-data.md'
      - 'Aggregate data by time': 'apis/query-api/aggregate-time.md'
      - 'Aggregate data by tags': 'apis/query-api/aggregate-tags.md'
      - 'Tag filtering': 'apis/query-api/filter-tags.md'
    - 'Portal API': 
      - 'Overview': 'apis/portal-api/overview.md'
      - 'Setup': 'apis/portal-api/setup.md'
      - 'HTTP requests': 'apis/portal-api/http-requests.md'
  - 'Integrations':
    - 'Overview': 'integrations/overview.md'
    - 'InfluxDB':
        - 'Overview': integrations/influxdb/overview.md
        - 'Quickstart': integrations/influxdb/quickstart.md
        - 'Guides': 
          - 'Using Telegraf': integrations/influxdb/telegraf.md
  - 'Tutorials':
    - 'Overview': 'tutorials/overview.md'
    - 'Predictive maintenance': 
      - 'Overview': 'tutorials/predictive-maintenance/overview.md'
      - '1. Get the project': 'tutorials/predictive-maintenance/get-project.md'
      - '2. Data generator': 'tutorials/predictive-maintenance/data-generator.md'
      - '3. Downsampling': 'tutorials/predictive-maintenance/downsampling.md'
      - '4. Forecast': 'tutorials/predictive-maintenance/forecast-service.md'
      - '5. Alerts': 'tutorials/predictive-maintenance/alert-service.md'
      - '6. InfluxDB - raw data': 'tutorials/predictive-maintenance/influxdb-raw-data.md'
      - '7. InfluxDB - alerts': 'tutorials/predictive-maintenance/influxdb-alerts.md'
      - '8. Printers dashboard': 'tutorials/predictive-maintenance/printers-dashboard.md'
      - '9. Lab: Add phone alerts': 'tutorials/predictive-maintenance/phone-alerts.md'
      - '10. Summary': 'tutorials/predictive-maintenance/summary.md'
    - 'Clickstream analysis': 
      - 'Overview': 'tutorials/clickstream/overview.md'
      - '1. Get the project': 'tutorials/clickstream/get-project.md'
      - '2. Clickstream producer': 'tutorials/clickstream/clickstream-producer.md'
      - '3. Data ingestion': 'tutorials/clickstream/data-ingestion.md'
      - '4. Data enrichment': 'tutorials/clickstream/data-enrichment.md'
      - '5. Data aggregation': 'tutorials/clickstream/data-aggregation.md'
      - '6. Event detection': 'tutorials/clickstream/event-detection.md'
      - '7. Webshop frontend': 'tutorials/clickstream/webshop-frontend.md'
      - '8. Real-time dashboard': 'tutorials/clickstream/realtime-dashboard.md'
      - '9. Lab: change offer': 'tutorials/clickstream/change-offer.md'
      - '10. Summary': 'tutorials/clickstream/summary.md'
    - 'Computer vision': 
      - 'Overview': 'tutorials/computer-vision/overview.md'
      - '1. Get the project': tutorials/computer-vision/get-project.md
      - '2. TfL camera feed': tutorials/computer-vision/tfl-camera-feed.md
      - '3. Frame grabber': tutorials/computer-vision/tfl-frame-grabber.md
      - '4. Object detection': tutorials/computer-vision/object-detection.md
      - '5. Web UI': tutorials/computer-vision/web-ui.md
      - '6. Other services': tutorials/computer-vision/other-services.md
      - '7. Add service': tutorials/computer-vision/add-service.md
      - '8. Summary': tutorials/computer-vision/summary.md        
    - 'Chat sentiment analysis': 
      - 'Overview': 'tutorials/sentiment-analysis/overview.md'
      - '1. Get the project': tutorials/sentiment-analysis/get-project.md
      - '2. Try the UI': 'tutorials/sentiment-analysis/try-the-ui.md'
      - '3. UI service': 'tutorials/sentiment-analysis/ui-service.md'
      - '4. Sentiment analysis service': 'tutorials/sentiment-analysis/sentiment-analysis-service.md'
      - '5. Twitch service': 'tutorials/sentiment-analysis/twitch-service.md'
      - '6. Customize the UI': 'tutorials/sentiment-analysis/customize-the-ui.md'
      - '7. Summary': 'tutorials/sentiment-analysis/summary.md'
    - 'Real-time ML predictions':
      - 'Overview': 'tutorials/data-science/overview.md'
      - '1. Bicycle data': 'tutorials/data-science/1-bikedata.md'
      - '2. Weather data': 'tutorials/data-science/2-weatherdata.md'
      - '3. Data views': 'tutorials/data-science/3-data.md'
      - '4. Get training data': 'tutorials/data-science/4-train.md'
      - '5. Run the model': 'tutorials/data-science/5-run.md'
      - '6. Conclusion': 'tutorials/data-science/6-conclusion.md'
    - 'Real-time ML pipelines':
      - 'Overview': 'tutorials/train-and-deploy-ml/overview.md'
      - 'Create your data': 'tutorials/train-and-deploy-ml/create-data.md'
      - 'Import data into Jupyter': 'tutorials/train-and-deploy-ml/import-data.md'
      - 'Train your ML model': 'tutorials/train-and-deploy-ml/train-ml.md'
      - 'Deploy your ML model': 'tutorials/train-and-deploy-ml/deploy-ml.md'
      - 'Conclusion': 'tutorials/train-and-deploy-ml/conclusion.md'
    - 'Real-time event detection':
      - 'Overview': 'tutorials/event-detection/overview.md'
      - '1. Data acquisition': 'tutorials/event-detection/data-acquisition.md'
      - '2. Event detection': 'tutorials/event-detection/crash-detection.md'
      - '3. Demo UI': 'tutorials/event-detection/crash-detection-ui.md'
      - '4. Conclusion': 'tutorials/event-detection/conclusion.md'
    - 'RSS Processing': 'tutorials/rss-tutorial/rss-processing-pipeline.md'
    - 'Currency Alerting': 'tutorials/currency-alerting/currency-alerting.md'
    - 'Data Stream Processing': 'tutorials/data-stream-processing/data-stream-processing.md'
    - 'Slack Alerting': 'tutorials/slack-alerting/slack-alerting.md'
    - 'MATLAB and Simulink': 'tutorials/matlab/matlab-and-simulink.md'
  - 'Quix Streams':
    - 'v0.5 (stable)': '!import https://github.com/quixio/quix-streams?branch=release/v0.5'
    - 'v2.0+ (latest)': '!import https://github.com/quixio/quix-streams?branch=main'
  - 'Bring Your Own Cluster (BYOC)':
    - 'Overview': 'byoc/overview.md'
    - 'Requirements': 'byoc/requirements.md'
    - 'Installation': 'byoc/installation.md'
    - 'BYOC vs. Cloud': 'byoc/byoc-vs-cloud.md'
    - 'Release filtering': 'byoc/release-filtering.md'

# Exclude build scripts from v2.0+
exclude_docs: |
  quix-streams/v2-0-latest/build/*

# Use custom hook to create redirects for 0.5 docs
hooks:
- hooks/redirect_0_5_urls.py

plugins:
  - multirepo:
      cleanup: true
  - search:
      separator: '[\s\-\.]' 
  - social:
      cards_layout_dir: layouts
      cards_layout: quix
  - glightbox
  - redirects:
      redirect_maps:
        'index.md': 'get-started/welcome.md'
        'contribute.md': 'get-started/contribute.md'
        'platform/changes.md': 'get-started/welcome.md'
        'platform/changes.md#environment': 'create/create-environment.md'
        'platform/ingest-data.md': 'develop/overview.md'
        'platform/quickstart.md': 'get-started/quickstart.md'
        'platform/what-is-quix.md': 'get-started/what-is-quix.md'
        'platform/glossary.md': 'get-started/glossary.md'
        'platform/quixtour/overview.md': 'get-started/quixtour/overview.md'
        'platform/tutorials/index.md': 'tutorials/overview.md'
        'platform/tutorials/computer-vision/index.md': 'tutorials/computer-vision/overview.md'
        'platform/tutorials/computer-vision/get-project.md': 'tutorials/computer-vision/get-project.md'
        'platform/tutorials/computer-vision/tfl-camera-feed.md': 'tutorials/computer-vision/tfl-camera-feed.md'
        'platform/tutorials/computer-vision/tfl-frame-grabber.md': 'tutorials/computer-vision/tfl-frame-grabber.md'
        'platform/tutorials/computer-vision/object-detection.md': 'tutorials/computer-vision/object-detection.md'
        'platform/tutorials/computer-vision/web-ui.md': 'tutorials/computer-vision/web-ui.md'
        'platform/tutorials/computer-vision/other-services.md': 'tutorials/computer-vision/other-services.md'
        'platform/tutorials/computer-vision/add-service.md': 'tutorials/computer-vision/add-service.md'
        'platform/tutorials/computer-vision/summary.md': 'tutorials/computer-vision/summary.md'
        'platform/tutorials/currency-alerting/currency-alerting.md': 'tutorials/currency-alerting/currency-alerting.md'
        'platform/tutorials/data-science/index.md': 'tutorials/data-science/overview.md'
        'platform/tutorials/data-stream-processing/data-stream-processing.md': 'tutorials/data-stream-processing/data-stream-processing.md'
        'platform/tutorials/event-detection/index.md': 'tutorials/event-detection/overview.md'
        'platform/tutorials/matlab/matlab-and-simulink.md': 'tutorials/matlab/matlab-and-simulink.md'
        'platform/tutorials/nocode-sentiment/nocode-sentiment-analysis.md': 'tutorials/sentiment-analysis/overview.md'
        'platform/tutorials/rss-tutorial/rss-processing-pipeline.md': 'tutorials/rss-tutorial/rss-processing-pipeline.md'
        'platform/tutorials/sentiment-analysis/index.md': 'tutorials/sentiment-analysis/overview.md'
        'platform/tutorials/sentiment-analysis/get-project.md': 'tutorials/sentiment-analysis/get-project.md'
        'platform/tutorials/sentiment-analysis/try-the-ui.md': 'tutorials/sentiment-analysis/try-the-ui.md'
        'platform/tutorials/sentiment-analysis/sentiment-analysis-service.md': 'tutorials/sentiment-analysis/sentiment-analysis-service.md'
        'platform/tutorials/sentiment-analysis/twitch-service.md': 'tutorials/sentiment-analysis/twitch-service.md'
        'platform/tutorials/sentiment-analysis/customize-the-ui.md': 'tutorials/sentiment-analysis/customize-the-ui.md'
        'platform/tutorials/sentiment-analysis/summary.md': 'tutorials/sentiment-analysis/summary.md'
        'platform/tutorials/slack-alerting/slack-alerting.md': 'tutorials/slack-alerting/slack-alerting.md'
        'platform/tutorials/train-and-deploy-ml/index.md': 'tutorials/train-and-deploy-ml/overview.md'
        'apis/streaming-writer-api/index.md': 'apis/streaming-writer-api/overview.md'
        'apis/streaming-reader-api/index.md': 'apis/streaming-reader-api/overview.md'
        'apis/portal-api/index.md': 'apis/portal-api/overview.md'
        'apis/query-api/index.md': 'apis/query-api/overview.md'
        'platform/connectors/index.md': 'connectors/index.md'
        'platform/how-to/personal-access-token-pat.md': 'develop/authentication/personal-access-token.md'
        'platform/how-to/replay.md': 'manage/replay.md'
        'platform/how-to/create-project.md': 'create/create-project.md'
        'client-library-intro.md': 'quix-streams/client-library-intro.md'
#        'client-library/quickstart.md': 'quix-streams/v0-5-stable/quickstart.md'
#        'client-library/connect.md': 'quix-streams/v0-5-stable/connect.md'
#        'quix-streams/subscribe.md': 'quix-streams/v0-5-stable/subscribe.md'
#        'quix-streams/publish.md': 'quix-streams/v0-5-stable/publish.md'
#        'quix-streams/state-management.md': 'quix-streams/v0-5-stable/state-management.md'

theme:
  name: 'material'
  custom_dir: overrides
#  features:

  # TODO
  #custom_dir: 'theme'
  favicon: 'assets/favicon.ico'
  
  palette: 
  # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: blue
      toggle:
        icon: material/weather-night 
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  
  features:
  - content.code.copy
  - navigation.instant     # Instant loading pages.
#  - navigation.sections    # Render top sections as groups.
  - navigation.top         # Adds a "Back to top" that is shown when scrolling up.
  - navigation.tracking    # Updates the url with highlighted section anchor.
  - navigation.indexes     # Documents can be directly attached to sections
  - search.highlight       # Search will highlight the searched word(s) on the page.*
  - search.share           # Adds an option to share a search query link.*
  - search.suggest         # Search will suggest the likeliest completion for a word.*
  - content.tabs.link
  - content.code.annotate  # code annotations
  - content.action.view    # view page source
  - content.code.copy
  
  icon:
    logo: 'material/library'
    repo: 'material/library'
  

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/quix.js
  - javascripts/feedback.js
extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/quixio/quix-docs'
    - icon: 'fontawesome/brands/slack'
      link: 'https://quix.io/community'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/quix_io'
    - icon: 'fontawesome/brands/youtube'
      link: 'https://www.youtube.com/channel/UCrijXvbQg67m9-le28c7rPA'
  analytics:
    provider: google-tag-manager
    property: GTM-55L66N3
  posthog:
    host: https://eu.posthog.com
    key: phc_UyQcafs2J7OUQEwJrmejeb0vCIdA9i9vYz66suPshix
  hotjar:
    id: 2437577
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    cookies:
      analytics:
        name: Google Analytics
        checked: true
      posthog: Posthog
  
  #alternate:
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details:
  - pymdownx.highlight:
      anchor_linenums: true