_build_cfg.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 +/- .adoc
#   - 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: OpenShift Documentation
Dir: welcome
Topics:
  - Name: Welcome
    File: index

---
Name: What's New?
Dir: whats_new
Topics:
  - Name: Overview
    File: overview
  - Name: Applications
    File: applications
  - Name: Cartridges vs Images
    File: carts_vs_images
  - Name: Terminology
    File: terminology

---
Name: Getting Started
Dir: getting_started
Topics:
  - Name: Overview
    File: overview
  - Name: Developers
    Dir: dev_get_started
    Topics:
      - Name: Overview
        File: overview
      - Name: Setup
        File: setup
      - Name: Installation
        File: installation
      - Name: Try It Out
        File: try_it_out
  - Name: Administrators
    Dir: admin_get_started
    Topics:
      - Name: Overview
        File: overview
      - Name: Installation
        File: install
      - Name: Configuration
        File: configure
      - Name: Monitoring
        File: monitor

---
Name: Architecture
Dir: architecture
Topics:
  - Name: Overview
    File: overview
  - Name: Infrastructure Components
    Dir: infrastructure_components
    Topics:
      - Name: Overview
        File: overview
      - Name: Kubernetes Infrastructure
        File: kubernetes_infrastructure
      - Name: Image Registry
        File: image_registry
      - Name: Management Console
        File: management_console
  - Name: Core Objects
    Dir: core_objects
    Topics:
      - Name: Overview
        File: overview
      - Name: Kubernetes Model
        File: kubernetes_model
      - Name: OpenShift Model
        File: openshift_model
      - Name: Builds
        File: builds
      - Name: Routing
        File: routing
  - Name: Additional Concepts
    Dir: additional_concepts
    Topics:
      - Name: Overview
        File: overview
      - Name: Networking
        File: networking
      - Name: Authentication
        File: authentication
      - Name: Authorization
        File: authorization
      - Name: Remote Commands
        File: remote_commands
      - Name: Port Forwarding
        File: port_forwarding
      - Name: Throttling
        File: throttling
      - Name: Source Control Management
        File: scm

---
Name: Administrator Guide
Dir: admin_guide
Topics:
  - Name: Overview
    File: overview
  - Name: Installing OpenShift
    File: admin_install_openshift
  - Name: Master and Node Configuration
    File: master_node_configuration
  - Name: Configuring Authentication
    File: configuring_authentication
  - Name: Managing Authorization Policies
    File: manage_authorization_policy
  - Name: Managing Nodes
    File: manage_nodes
  - Name: Scheduler
    File: scheduler
  - Name: Routers
    File: router
  - Name: High Availability
    File: high_availability
  - Name: Self-Provisioned Projects
    File: selfprovisioned_projects

---
Name: CLI Reference
Dir: cli_reference
Topics:
  - Name: Overview
    File: overview
  - Name: Get Started with the CLI
    File: get_started_cli
  - Name: Multiple CLI Profiles
    File: setup_multiple_cli_profiles
  - Name: CLI Operations
    File: basic_cli_operations

---
Name: Developer Guide
Dir: dev_guide
Topics:
  - Name: Overview
    File: overview
  - Name: Authentication
    File: authentication
  - Name: Management Console
    File: console
  - Name: Create a New Application
    File: new_app
  - Name: Templates
    File: templates
  - Name: Builds
    File: builds
  - Name: Deployments
    File: deployments
  - Name: Integrating External Services
    File: integrating_external_services
  - Name: Projects
    File: projects
  - Name: Resource Limits
    File: limits
  - Name: Quota
    File: quota
  - Name: Linking
    File: linking
  - Name: Executing Remote Commands
    File: executing_remote_commands
  - Name: Port Forwarding
    File: port_forwarding
  - Name: Application Health
    File: application_health
  - Name: Events
    File: events
  - Name: Output Build Dependencies
    File: output_deps
  - Name: JBoss Tools IDE
    File: jboss_tools

---
Name: Creating Images
Dir: creating_images
Topics:
  - Name: Overview
    File: overview
  - Name: Guidelines
    File: guidelines
  - Name: Image Metadata
    File: metadata
  - Name: STI Requirements
    File: sti
  - Name: Testing STI Images
    File: sti_testing

---
Name: Using Images
Dir: using_images
Topics:
  - Name: Overview
    File: overview
  - Name: STI Images
    Dir: sti_images
    Topics:
      - Name: Overview
        File: overview
      - Name: Base
        File: base
      - Name: NodeJS
        File: nodejs
      - Name: Ruby
        File: ruby
      - Name: Perl
        File: perl
      - Name: PHP
        File: php
      - Name: Python
        File: python
  - Name: Database Images
    Dir: db_images
    Topics:
      - Name: Overview
        File: overview
      - Name: MySQL
        File: mysql
      - Name: PostgreSQL
        File: postgresql
      - Name: MongoDB
        File: mongodb
  - Name: Docker Images
    Dir: docker_images
    Topics:
      - Name: Overview
        File: overview
  - Name: xPaaS Middleware Images
    Dir: xpaas_images
    Distros: openshift-online,openshift-enterprise
    Topics:
      - Name: Overview
        File: overview
      - Name: EAP
        File: eap
      - Name: JBoss A-MQ
        File: a_mq
      - Name: JBoss Web Server
        File: jws

---
Name: REST API Reference
Dir: rest_api
Topics:
  - Name: Overview
    File: overview