1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/_topic_maps/_topic_map_ms.yml
2023-04-14 18:38:19 +00:00

158 lines
4.5 KiB
YAML

# 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.13 release notes
File: microshift-4-13-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: Embedding in a RHEL for Edge image
File: microshift-embed-in-rpm-ostree
---
Name: Support
Dir: microshift_support
Distros: microshift
Topics:
- Name: MicroShift etcd
File: microshift-etcd
- Name: MicroShift sos report
File: microshift-sos-report
---
Name: API reference
Dir: microshift_rest_api
Distros: microshift
Topics:
- Name: Understanding API tiers
File: understanding-api-support-tiers
- Name: API compatibility guidelines
File: understanding-compatibility-guidelines
- Name: Network APIs
Dir: network_apis
Topics:
- 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: microshift_cli_ref
Distros: microshift
Topics:
- Name: CLI tools overview
File: microshift-cli-overview
- Name: Installing the OpenShift CLI
File: microshift-oc-cli-install
- Name: Configuring the OpenShift CLI
File: microshift-oc-config
- Name: Using the OpenShift CLI
File: microshift-cli-using-oc
- Name: Using oc and kubectl
File: microshift-usage-oc-kubectl
- Name: List of oc CLI commands
File: microshift-oc-cli-commands-list
---
Name: Configuring
Dir: microshift_configuring
Distros: microshift
Topics:
- Name: Using configuration tools
File: microshift-using-config-tools
- Name: Cluster access with kubeconfig
File: microshift-cluster-access-kubeconfig
---
Name: Networking
Dir: microshift_networking
Distros: microshift
Topics:
- Name: Networking settings
File: microshift-networking
- Name: Firewall configuration
File: microshift-firewall
---
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: Generic ephemeral volumes for MicroShift
File: generic-ephemeral-volumes-microshift
- Name: Understanding persistent storage for MicroShift
File: understanding-persistent-storage-microshift
- Name: Expanding persistent volumes for MicroShift
File: expanding-persistent-volumes-microshift
- Name: Dynamic storage using the LVMS plugin
File: microshift-storage-plugin-overview
---
Name: Running applications
Dir: microshift_running_apps
Distros: microshift
Topics:
- Name: Application deployment
File: microshift-applications
- Name: Operators
File: microshift-operators
- Name: Greenboot health check
File: microshift-greenboot
---
Name: Troubleshooting
Dir: microshift_troubleshooting
Distros: microshift
Topics:
- Name: Checking your version
File: microshift-version
- Name: Additional information
File: microshift-things-to-know