dagshub-docs/mkdocs.yml

site_name: DagsHub Docs
site_description: 'DagsHub Documentation - Learn how to use DagsHub and improve you data science workflow'
site_dir: 'build/docs'
site_url: 'https://dagshub.com/docs'

copyright: "© 2023 DagsHub"
nav:
  - Home: index.md
  - Quick Links:
    - quick_start/index.md
    - DagsHub Platform: https://dagshub.com/product/
    - Set up DagsHub: quick_start/set_up_dagshub.md
    - Hello World Colab: https://colab.research.google.com/drive/1tzut9HMmtepff8os0eq-XV8VHkNrhKyZ?usp=sharing
    - API: api.md
    - Preconfigured Colab: https://colab.research.google.com/drive/1XLP2Ouxk-k6y9yOxc4Grp-Aq6aGcbhuj?usp=sharing
    - interactive-session: workshops/interactive-session.md
    - FAQ: faq.md
    - Troubleshooting: troubleshooting.md
  - Use Cases:
    - use_cases/index.md
    - Set up DagsHub: quick_start/set_up_dagshub.md
    - Connect an Existing Project: use_cases/connect_existing_project.md
    - Version Data and Code: quick_start/version_data_and_code.md
    - Track ML Experiments: use_cases/track_ml_experiments.md
    - Annotate Data: data_engine/use_cases/annotate_data.md
    - Connect External Storage: feature_guide/connect_s3_compatible_storage.md
    - Reproduce ML Experiments: use_cases/reproduce_experiment_results.md
    - Build Data Pipelines: use_cases/build_data_pipeline.md
    - Build custom Dataloader: use_cases/stream_data_for_ml_training.md
    - Deploy ML Model to Cloud: use_cases/deploy_ml_model_to_cloud.md
    - Data Science Peer Review: teamwork/data_science_peer_review.md
  - Feature Guide:
      - feature_guide/index.md
      - DagsHub Storage: feature_guide/dagshub_storage.md
      - Connect External Storage: feature_guide/connect_s3_compatible_storage.md
      - Upload Data: feature_guide/data_upload.md
      - Download Data: feature_guide/data_streaming.md
      - Experiment Table: feature_guide/discovering_experiments.md
      - DagsHub Tracking: feature_guide/git_tracking.md
      - DagsHub Annotations: feature_guide/annotations.md
      - DagsHub Diffing: feature_guide/dagshub_diffing.md
      - DagsHub Discussions: feature_guide/dagshub_discussions.md
      - DagsHub Pipelines: feature_guide/pipeline.md
      - Data Science Pull Requests: feature_guide/data_science_pull_requests.md
      - DagsHub Topics: feature_guide/topics.md
      - DagsHub Templates: feature_guide/project_templates.md
      - DagsHub Automation: feature_guide/automation.md
      - Reproduce ML Experiments: use_cases/reproduce_experiment_results.md
      - Data Merging: feature_guide/data_merging.md
  - Integration Guide:
    - integration_guide/index.md
    - GitHub: integration_guide/github.md
    - Google Colab: integration_guide/google_colab.md
    - DVC: integration_guide/dvc.md
    - MLflow: integration_guide/mlflow_tracking.md
    - Jenkins: integration_guide/jenkins.md
    - Label Studio: integration_guide/label_studio.md
    - External Storage: feature_guide/connect_s3_compatible_storage.md
    - External Git Server: integration_guide/connect_a_git_server_to_dagshub.md
    - Webhooks: integration_guide/webhook.md
    - New Relic: integration_guide/new_relic_monitoring.md
    - Google Drive: integration_guide/google_drive_to_dagshub_storage.md
    - PyCaret: integration_guide/pycaret.md
    - Hugging Face: integration_guide/hugging_face.md
    - YOLO-NAS: integration_guide/yolo_nas.md
  - Workshops:
      - workshops/index.md
      - Interactive Session: workshops/interactive_session.md
      - MLflow Crash Course: workshops/mlflow_crash_course.md
      - DVC and DDA: workshops/dvc_and_dda.md
      - Label Studio: workshops/label_studio.md
      - Generative AI: workshops/generative_ai_comics_strip.md
  - FAQ: faq.md
  - Troubleshooting: troubleshooting.md
  - Tutorials:
    - Basic Tutorial:
        - experiment_tutorial/index.md
        - 0. Data Exploration: experiment_tutorial/0_data.md
        - 1. Setup: experiment_tutorial/1_setup.md
        - 2. Data Versioning: experiment_tutorial/2_data_versioning.md
        - 3. Experimentation: experiment_tutorial/3_experiments.md
    - Pipeline Tutorial - Advanced:
        - tutorial/index.md
        - Setup: tutorial/setup.md
        - Defining the Pipeline: tutorial/pipeline.md
  - API: api.md
  - Data Engine:
    - Data Engine Feature Guide:
        - data_engine/feature_guide/index.md
        - Feature Guide: data_engine/feature_guide/overview.md
    - Data Engine Use Cases:
        - data_engine/use_cases/index.md
        - Generate training-ready datasets: data_engine/use_cases/overview.md
        - Connect your datasource: data_engine/use_cases/connect_datasource.md
        - Enriching your data and using it: data_engine/use_cases/enrich_datasource.md
        - Query and save subsets of your data: data_engine/use_cases/query_and_create_subsets.md
        - Visualizing your data: data_engine/use_cases/visualizing_datasets.md
        - Annotating your data: data_engine/use_cases/annotate_data.md
        - Train a model: data_engine/use_cases/train_model.md
edit_uri: https://dagshub.com/DagsHub-Official/dagshub-docs/_edit/main/docs/

markdown_extensions:
  - codehilite:
      linenums: true
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - footnotes
  - attr_list
  - pymdownx.mark
  - tables

google_analytics: [true, true]

theme:
  features:
    - navigation.indexes
    - navigation.top
  name: 'material'
  icon:
    repo: fontawesome/brands/git-alt
    edit: material/file-document-edit-outline
  custom_dir: 'theme'
  favicon: 'assets/images/favicon.png'
  logo: 'assets/images/logo.svg'
  palette:
    - scheme: default
      primary: 'teal'
      accent: 'teal'
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: 'teal'
      accent: 'teal'
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  font:
    text: 'Inter'
    code: 'Roboto Mono'
  navigation_depth: 4

plugins:
  - search:
      separator: '[\s\-\.]+'
      lang:
        - en

extra_css:
  - 'assets/stylesheets/header.css'
  - 'assets/stylesheets/footer.css'
  - 'assets/stylesheets/extra.css'
  - 'assets/stylesheets/swagger-ui.css'
  - 'assets/stylesheets/custom-search.css'
  - 'assets/stylesheets/dark-mode-toggle.css'
  - 'assets/stylesheets/prev-next-buttons.css'

extra_javascript:
  - 'assets/javascripts/redirects.js'
  - 'assets/javascripts/header.js'
  - 'js/jquery-3.6.0.min.js'

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/TheRealDagsHub
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCeuZrCdpIY69XNWqn9OeSYQ
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/dagshub
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/9gU36Y6