Skip to content
mkdocs.yml 2.51 KiB
Newer Older
Silvia Almagia's avatar
Silvia Almagia committed
# Project information
site_name: ETSI SDG OSL Documentation
site_description: ETSI SDG OSL Documentation page
site_author: OpenSlice by ETSI
Kostis Trantzas's avatar
Kostis Trantzas committed
site_url: https://osl.etsi.org/
Silvia Almagia's avatar
Silvia Almagia committed

# Repository
Kostis Trantzas's avatar
Kostis Trantzas committed
repo_name: OSL GitLab
Kostis Trantzas's avatar
Kostis Trantzas committed
repo_url: https://labs.etsi.org/rep/osl
Silvia Almagia's avatar
Silvia Almagia committed
edit_uri: ""
docs_dir: doc

# 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
Kostis Trantzas's avatar
Kostis Trantzas committed
# https://squidfunk.github.io/mkdocs-material/creating-your-site/
Silvia Almagia's avatar
Silvia Almagia committed
theme:
Kostis Trantzas's avatar
Kostis Trantzas committed
  name: material
Silvia Almagia's avatar
Silvia Almagia committed

  # Don't include MkDocs' JavaScript
Kostis Trantzas's avatar
Kostis Trantzas committed
  #include_search_page: false
  #search_index_only: true
Silvia Almagia's avatar
Silvia Almagia committed

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

Silvia Almagia's avatar
Silvia Almagia committed
  palette:
Kostis Trantzas's avatar
Kostis Trantzas committed
    accent: 'blue'
  logo: 'images/logo_osl.png'
  favicon: images/favicon.png
Silvia Almagia's avatar
Silvia Almagia committed

Kostis Trantzas's avatar
Kostis Trantzas committed
  icon:
    repo: fontawesome/brands/gitlab

Silvia Almagia's avatar
Silvia Almagia committed
# Copyright
copyright: "Copyright © 2019-2023 Openslice Project"

# Options
extra:
Kostis Trantzas's avatar
Kostis Trantzas committed
#  search:
#    languages: "en"
Silvia Almagia's avatar
Silvia Almagia committed
  social:
    - icon: fontawesome/solid/globe
Kostis Trantzas's avatar
Kostis Trantzas committed
      link: https://osl.etsi.org/
    - icon: fontawesome/brands/gitlab
Kostis Trantzas's avatar
Kostis Trantzas committed
      link: https://labs.etsi.org/rep/osl
    - icon: fontawesome/brands/linkedin
Kostis Trantzas's avatar
Kostis Trantzas committed
      link: https://www.linkedin.com/company/openslice/
    - icon: fontawesome/brands/x-twitter
Silvia Almagia's avatar
Silvia Almagia committed
      link: https://twitter.com/OpensliceOSS
Kostis Trantzas's avatar
Kostis Trantzas committed
  version:
    provider: mike
Silvia Almagia's avatar
Silvia Almagia committed

# Page tree
nav:
  - Overview:
      - Introduction: index.md
  - Getting Started:
      - Deployment/Installation: deployment.md
      - NFV Orchestrator Configuration: nfvoconfig.md
      - Service Catalogs: catalogs.md
      - NFV Catalogs: nfvcatalogs.md
      - LCM Rules: lcm.md
      - Consuming Services From External OSS: ./architecture/consumingServicesFromExternalPartners.md
      - Service Inventory: service_inventory.md
      - Alarms and Actions: alarms_actions.md
  - Design & Architecture:
      - Architecture: ./architecture/architecture.md
      - Message bus: ./architecture/messagebus.md
      - OSOM: ./architecture/osom.md
      - Authentication: ./architecture/oauth.md
      - TMF API: ./architecture/tmfapi.md
      - NFV API: ./architecture/nfvapi.md
      - TMF WEB: ./architecture/tmfweb.md
      - NFV WEB: ./architecture/nfvweb.md
      - Issue management: ./architecture/issuemgt.md
      - Central logging: ./architecture/centrallog.md
  - Contributing:
      - Developing: ./contributing/developing.md