Skip to content
Snippets Groups Projects
mkdocs.yml 3.04 KiB
Newer Older
# Project information
site_name: ETSI SDG TFS Documentation
site_description: ETSI SDG TFS Documentation page
site_author: TeraflowSDN by ETSI
site_url: https://tfs.etsi.org/

# Repository
repo_name: TFS GitLab
repo_url: https://labs.etsi.org/rep/tfs
edit_uri: ""
docs_dir: doc

extra_css:
  - stylesheets/extra.css

# edit_uri: edit/docs-revamp/docs/
# edit_uri: blob/docs-revamp/docs/

# remote_name: origin
# remote_branch: gh-pages

# Theme and overrides, i.e. language partial
# https://squidfunk.github.io/mkdocs-material/creating-your-site/
theme:
  name: material

  # Don't include MkDocs' JavaScript
  #include_search_page: false
  #search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
#  feature:
#    tabs: true
  features:
  - navigation.instant
  - navigation.instant.progress
  - navigation.top
  - navigation.footer
  - navigation.path
  - search
  - search.highlight

  palette:
    primary: '1565C0'
    accent: '1E88E5'
yangalicace1's avatar
yangalicace1 committed
  logo: 'images/logos/TeraFlowSDN_tr.png'
  favicon: images/favicon.png

  icon:
    repo: fontawesome/brands/gitlab

# Copyright
copyright: "Copyright © 2019-2024 TeraflowSDN Project"

# Options
extra:
#  search:
#    languages: "en"
  social:
    - icon: fontawesome/solid/globe
      link: https://tfs.etsi.org/
    - icon: fontawesome/brands/gitlab
      link: https://labs.etsi.org/rep/tfs
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/teraflowsdn/
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/TeraflowSDN
  version:
    provider: mike

# Page tree
nav:
  - 1. Deployment Guide: ./deployment_guide/deployment_guide.md
yangalicace1's avatar
yangalicace1 committed
  - 1.1. Configure your Machine: ./deployment_guide/configure_your_machine/configure_your_machine.md
  - 1.1.1. Physical Server: ./deployment_guide/configure_your_machine/physical_server.md
  - 1.1.2. Oracle Virtual Box: ./deployment_guide/configure_your_machine/oracle_virtual_box.md
  - 1.1.3. VMWare Fusion: ./deployment_guide/configure_your_machine/vm_ware_fusion.md
  - 1.1.4. OpenStack: ./deployment_guide/configure_your_machine/openstack.md
  - 1.1.5. Vagrant Box: ./deployment_guide/configure_your_machine/vagrant_box.md
  - 1.2. Install MicroK8s: ./deployment_guide/install_micro_k8s/install_micro_k8s.md
  - 1.3. Deploy TeraFlowSDN: ./deployment_guide/deploy_TeraFlowSDN/deploy_TeraFlowSDN.md
  - 1.4. WebUI and Grafana Dashboards: ./deployment_guide/webUI_and_grafana_dashboards/webUI_and_grafana_dashboards.md
  - 1.5. Show deployments and Logs: ./deployment_guide/show_deployment_and_logs/show_deployment_and_logs.md
  - 2. Development Guide: ./development_guide/development_guide.md
yangalicace1's avatar
yangalicace1 committed
  - 2.1 Configure Environment: ./development_guide/configure_environment/configure_environment.md
  - 2.1.1. Python: ./development_guide/configure_environment/python.md
  - 2.1.2. Java (Quarkus): ./development_guide/configure_environment/java_quarkus.md 
  - Testing:
      - Test Plan: ./testing/testplan/README.md
      - Robot Framework: ./testing/robotframework/README.md
      - Postman: ./testing/postman/README.md
  - FAQ: ./FAQ.md