index.yaml

# This file is an index of the pages to display on the documentation website
# (https://ignitionrobotics.org/docs). The order of the pages in this file
# is reflected on the website's left sidebar.
#
# Components of the index:
#
# 1. "pages:" The master list of pages
#
# 2. Each page has a
#    a. "name:" This should be a short url-friendly and unique name. It will
#    be used in the website url.
#
#    b. "title:" This is a human-friendly title for the page. This title will
#    be displayed on the website's left side bar.
#
#    c. "file:" The markdown file that contains the page's content.
pages:
  - name: getstarted
    title: Get Started
    file: get_started.md
    description: Getting started with Ignition.
  - name: roadmap
    title: Roadmap
    file: roadmap.md
    description: Our development plans.
  - name: release-features
    title: Release Features
    file: release_features.md
    description: Features available in each Ignition release.
  - name: releases
    title: Releases
    file: releases.md
    description: Past, current, and future release information.
  - name: contributing
    title: Contributing
    file: contributing.md
    description: How to contribute to Ignition.
  - name: architecture
    title: Architecture
    file: architecture.md
    description: Ignition Gazebo's architecture overview.
    unlisted: true
  - name: release
    title: Release process
    file: release.md
    description: Release process overview.
    unlisted: true
  - name: ci
    title: Continuous Integration
    file: ci.md
    description: Continuous Integration overview.
    unlisted: true
releases:
  - name: garden
    lts: false
    eol: false
    description: Upcoming release, under development.
  - name: fortress
    lts: true
    eol: false
    description: Recommended version.
  - name: edifice
    lts: false
    eol: true
    description: Supported Mar, 2021 to Mar, 2022
  - name: dome
    lts: false
    eol: true
    description: Supported Sep, 2020 to Dec, 2021
  - name: citadel
    lts: true
    eol: false
    description: Supported Dec, 2019 to Dec, 2024
  - name: blueprint
    lts: false
    eol: true
    description: Supported May, 2019 to Dec, 2020
  - name: acropolis
    lts: false
    eol: true
    description: Ignition's first release.