openshift-docs/_topic_maps/_topic_map_ms.yml

# This configuration file dictates the organization of the topic groups and
# topics on the main page of the doc site for this branch. Each record
# consists of the following:
#
# ---                                  <= Record delimiter
# Name: Origin of the Species          <= Display name of topic group
# Dir:  origin_of_the_species          <= Directory name of topic group
# Topics:
#   - Name: The Majestic Marmoset      <= Topic name
#     File: the_majestic_marmoset      <= Topic file under group dir +/-
#   - Name: The Curious Crocodile      <= Topic 2 name
#     File: the_curious_crocodile      <= Topic 2 file
#   - Name: The Numerous Nematodes     <= Sub-topic group name
#     Dir: the_numerous_nematodes      <= Sub-topic group dir
#     Topics:
#       - Name: The Wily Worm          <= Sub-topic name
#         File: the_wily_worm          <= Sub-topic file under <group dir>/<subtopic dir>
#       - Name: The Acrobatic Ascarid  <= Sub-topic 2 name
#         File: the_acrobatic_ascarid  <= Sub-topic 2 file under <group dir>/<subtopic dir>
#
# The ordering of the records in this document determines the ordering of the
# topic groups and topics on the main page.

---
Name: About
Dir: welcome
Distros: microshift
Topics:
- Name: Welcome
  File: index
- Name: Legal notice
  File: legal-notice
---
Name: Release notes
Dir: microshift_release_notes
Distros: microshift
Topics:
- Name: MicroShift 4.12 release notes
  File: microshift-4-12-release-notes
---
Name: Getting Started
Dir: microshift_getting_started
Distros: microshift
Topics:
- Name: Understanding MicroShift
  File: microshift-understanding
- Name: Architecture
  File: microshift-architecture
---
Name: Installing
Dir: microshift_install
Distros: microshift
Topics:
- Name: Installing from RPM
  File: microshift-install-rpm
- Name: Installing in a RHEL for Edge Image
  File: microshift-install-rhel-for-edge
---
Name: API reference
Dir: rest_api
Distros: microshift
Topics:
- Name: Network APIs
  Dir: network_apis
  Topics:
    # FIXME: need to incorporate the supported k8s APIs
  - Name: 'Route [route.openshift.io/v1]'
    File: route-route-openshift-io-v1
- Name: Security APIs
  Dir: security_apis
  Topics:
  - Name: 'SecurityContextConstraints [security.openshift.io/v1]'
    File: securitycontextconstraints-security-openshift-io-v1
---
Name: CLI tools
Dir: cli_reference
Distros: microshift
Topics:
- Name: CLI tools overview
  File: index
- Name: OpenShift CLI (oc)
  Dir: openshift_cli
  Topics:
  - Name: Getting started with the OpenShift CLI
    File: getting-started-cli
  - Name: Configuring the OpenShift CLI
    File: configuring-cli
  - Name: Managing CLI profiles
    File: managing-cli-profiles
  - Name: Extending the OpenShift CLI with plug-ins
    File: extending-cli-plugins
  # FIXME: auto-generated content in the next file includes commands
  # not supported on MicroShift
  - Name: OpenShift CLI developer command reference
    File: developer-cli-commands
  # FIXME: Review the commands we expect to support in this file
  # - Name: OpenShift CLI administrator command reference
  #   File: administrator-cli-commands
  #   Distros: openshift-enterprise,openshift-origin
  - Name: Usage of oc and kubectl commands
    File: usage-oc-kubectl
---
Name: Configuring
Dir: microshift_configuring
Distros: microshift
Topics:
- Name: Configuring
  File: microshift-using-config-tools
- Name: Additional information
  File: microshift-things-to-know
---
Name: Networking
Dir: microshift_networking
Distros: microshift
Topics:
- Name: Understanding networking
  File: microshift-networking
---
Name: Storage
Dir: microshift_storage
Distros: microshift
Topics:
- Name: MicroShift storage overview
  File: index
- Name: Understanding ephemeral storage for MicroShift
  File: understanding-ephemeral-storage-microshift
- Name: Understanding persistent storage for MicroShift
  File: understanding-persistent-storage-microshift
- Name: Configuring persistent storage for MicroShift
  Dir:  persistent_storage_microshift
  Topics:
  - Name: MicroShift storage plugin overview
    File: microshift-storage-plugin-overview
- Name: Using container storage interface (CSI) for MicroShift
  Dir: container_storage_interface_microshift
  Distros: microshift
  Topics:
  - Name: Configuring CSI volumes for MicroShift
    File: microshift-persistent-storage-csi
- Name: Generic ephemeral volumes for MicroShift
  File: generic-ephemeral-volumes-microshift
- Name: Expanding persistent volumes for MicroShift
  File: expanding-persistent-volumes-microshift
- Name: Dynamic provisioning for MicroShift
  File: dynamic-provisioning-microshift
# ---
# Name: Networking
# Dir: networking
# Distros: microshift
# Topics:
# - Name: Understanding the Ingress Operator
#   File: ingress-operator-microshift
# - Name: Configuring a cluster-wide proxy during installation
#   File: configuring-cluster-wide-proxy
# - Name: CIDR range definitions
#   File: cidr-range-definitions
# - Name: Network policy
#   Dir: network_policy
#   Topics:
#   - Name: About network policy
#     File: about-network-policy
#   - Name: Creating a network policy
#     File: creating-network-policy
#   - Name: Viewing a network policy
#     File: viewing-network-policy
#   - Name: Deleting a network policy
#     File: deleting-network-policy
#   - Name: Configuring multitenant isolation with network policy
#     File: multitenant-network-policy
# ---
# Name: Updating clusters
# Dir: updating
# Distros: microshift
# Topics:
# - Name: Updating MicroShift Clusters
#   File: TBD
---
Name: Troubleshooting
Dir: microshift_troubleshooting
Distros: microshift
Topics:
- Name: Checking your version
  File: microshift-version
- Name: Known issues
  File: microshift-known-issues