mkdocs.yml

site_name: Tinkerbell Docs
site_url: https://docs.tinkerbell.org
site_description: Designed for scalable provisioning of physical hardware, Tinkerbell is both open-source and cloud native. Contributed by Equinix Metal.
site_image: https://tinkerbell.org/images/social/tinkerbell-social-image.png
repo_url: https://github.com/tinkerbell/tinkerbell-docs
edit_uri: "edit/main/docs/"

nav:
  - Home: index.md

  - Architecture: architecture.md

  - Services:
      - Tink Server: services/tink-server.md
      - Tink Worker: services/tink-worker.md
      - Tink Controller: services/tink-controller.md
      - Boots: services/boots.md
      - Hegel: services/hegel.md
      - PBnJ: services/pbnj.md
      - Rufio: services/rufio.md
  - Hook: hook.md

  - Workflows:
      - Working with Workflows: workflows/working-with-workflows.md
      - A Hello-world Workflow: workflows/hello-world-workflow.md

  - Hardware Data: hardware-data.md
  - Templates: templates.md

  - Actions:
      - Action Hub: https://artifacthub.io/packages/search?kind=4
      - Action Architecture: actions/action-architecture.md
      - Creating a Basic Action: actions/creating-a-basic-action.md

  - Setting Up Tinkerbell: setup.md

  - Deploying Operating Systems:
      - The Basics: deploying-operating-systems/the-basics.md
      - The Deployment: deploying-operating-systems/the-deployment.md
      - Example - Deploying Ubuntu: deploying-operating-systems/examples-ubuntu.md
      - Example - Deploying Ubuntu from Packer Machine Image: deploying-operating-systems/examples-ubuntu-packer.md
      - Example - Deploying Debian: deploying-operating-systems/examples-debian.md
      - Example - Deploying FreeBSD: deploying-operating-systems/examples-freebsd.md
      - Example - Deploying Red Hat Enterprise Linux and CentOS: deploying-operating-systems/examples-rhel-centos.md
      - Example - Deploying Windows: deploying-operating-systems/examples-win.md

  - Troubleshooting: troubleshooting.md

  - Contribute: contrib/index.md

theme:
  name: material
  custom_dir: overrides
  logo: assets/logo.png
  footer_logo: assets/packet.png
  font: false

extra_css:
  - stylesheets/extra.css
  - stylesheets/simple-grid.css
  - stylesheets/font-awesome.min.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tinkerbell
    - icon: fontawesome/brands/slack
      link: https://slack.cncf.io/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/tinkerbell_oss

#google_analytics:
#  - UA-52258647-10
#  - auto

plugins:
  - search

markdown_extensions:
  - admonition
  - mdx_truly_sane_lists
  - pymdownx.superfences
  - pymdownx.tabbed