mkdocs.yml

# Project Information
site_name: Red Hat OpenShift Service on AWS
site_url: https://www.rosaworkshop.io
site_description: A guided workshop that ranges from cluster creation and configuration to application deployment for ROSA clusters.
site_author: Red Hat

# Repository
repo_name: openshift-cs/rosaworkshop
repo_url: https://github.com/openshift-cs/rosaworkshop

# Edit icon
edit_uri: edit/master/rosa-workshop/

#copyright
copyright: Copyright © 2020 - 2023 Red Hat, Inc.

# Nav Menu Definition
nav:
  - Home: index.md
  - Getting started with ROSA:
    - Setup: 'rosa/1-account_setup.md'
    - Deploy the cluster:
      - Read me first!: 'rosa/choosing_deployments.md'
      - Choose one:
        - Simple CLI guide: 'rosa/17-simple_cli_deploy.md'
        - Detailed CLI guide: 'rosa/2-deploy.md'
        - Simple UI guide: 'rosa/19-simple-ui-deploy.md'
        - Detailed UI guide: 'rosa/16-deploy_ui.md'
        - Hosted Control Planes: 'rosa/18-deploy_hcp.md'
    - Create an admin user: 'rosa/3-create_initial_admin.md'
    - Setup an IdP: 'rosa/4-setup_idp.md'
    - Granting admin rights: 'rosa/5-grant_admin.md'
    - Accessing your cluster: 'rosa/6-access_cluster.md'
    - Managing worker nodes: 'rosa/7-managing_nodes.md'
    - Autoscaling: 'rosa/8-autoscaling.md'
    - Upgrade the cluster: 'rosa/9-upgrade.md'
    - Delete the cluster: 'rosa/12-delete_cluster.md'
    - Obtaining support: 'rosa/13-obtaining_support.md'
  - Deploy the application:
    - Introduction: 'ostoy/lab_intro.md'
    - Prerequisites: 'ostoy/1-prereqs.md'
    - Lab Overview: 'ostoy/3-lab_overview.md'
    - Deployment: 'ostoy/4-deployment.md'
    - Health Check: 'ostoy/5-healthcheck.md'
    - Storage: 'ostoy/6-storage.md'
    - ConfigMaps, Secrets, Env Var: 'ostoy/7-confsecenv.md'
    - Networking: 'ostoy/8-networking.md'
    - Scaling: 'ostoy/12-scaling.md'
    - Logging: 'ostoy/9-logging.md'
    - Integrating with AWS sevices: 'ostoy/13-ack.md'
    - S2I Deployments: 'ostoy/10-deployment_s2i.md'
    - S2I Webhooks for CICD: 'ostoy/11-cicd_s2i.md'
  - OpenShift Concepts: 'ostoy/2-concepts.md'
  - ROSA with STS explained: 'rosa/15-sts_explained.md'
  - FAQ: 'rosa/14-faq.md'
  - Feedback: 'feedback.md'

# Theme Configuration
theme:
  name: material
  language: 'en'
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: black
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      accent: red
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  font:
    text: Overpass
    code: Overpass Mono
  logo: favicon.ico
  favicon: favicon.ico
  icon:
    repo: material/github

docs_dir: rosa-workshop

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - toc:
      permalink: "#"

# Analytics
extra:
  social:
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/openshift
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/red-hat
  - icon: fontawesome/brands/facebook
    link: https://www.facebook.com/openshift/
  analytics:
    provider: google
    property: G-EVZE0ZMHBK
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            opening a <a href="https://github.com/openshift-cs/rosaworkshop/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">GitHub Issue</a>.