From f2aeb70e5952b475da26c561fc1ed27504768422 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Wed, 8 Feb 2023 20:00:59 -0500 Subject: [PATCH] Fix TOC on site / documentation (#1580) #### What type of PR is this? #### What this PR does / why we need it: The latest spelling error changes broke TOC from showing in the documentation #### Which issue(s) this PR fixes: Fixes # #### Special notes for your reviewer: Signed-off-by: Charlie Drage --- docs/architecture.md | 3 ++- docs/conversion.md | 4 ++-- docs/getting-started.md | 4 ++-- docs/installation.md | 4 ++-- docs/integrations.md | 4 ++-- docs/user-guide.md | 4 ++-- 6 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 8f9adf72..a1896366 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -9,7 +9,8 @@ redirect_from: # Architecture and Internal Design -- TOC +* TOC +{:toc} `kompose` has 3 stages: _Loader_, _Transformer_ and _Outputter_. Each stage should have a well-defined interface, so it is easy to write a new Loader, Transformer, or Outputters and plug it in. Currently, only Loader and Transformer interfaces are defined. diff --git a/docs/conversion.md b/docs/conversion.md index 31b22764..3c2fc9b9 100644 --- a/docs/conversion.md +++ b/docs/conversion.md @@ -9,8 +9,8 @@ redirect_from: # Conversion Matrix -- TOC - {:toc} +* TOC +{:toc} This document outlines all possible conversion details regarding `docker-compose.yaml` values to Kubernetes / OpenShift artifacts. diff --git a/docs/getting-started.md b/docs/getting-started.md index 582c658f..0d692bed 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -9,8 +9,8 @@ redirect_from: # Getting Started -- TOC - {:toc} +* TOC +{:toc} This is how you'll get started with Kompose! diff --git a/docs/installation.md b/docs/installation.md index e11603d6..a23e91cd 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -9,8 +9,8 @@ redirect_from: # Installation -- TOC - {:toc} +* TOC +{:toc} We have multiple ways to install Kompose. Our preferred (and most up-to-date) method is downloading the binary from the latest GitHub release. diff --git a/docs/integrations.md b/docs/integrations.md index 9a366e13..e21b6a52 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -9,8 +9,8 @@ redirect_from: # Integrations -- TOC - {:toc} +* TOC +{:toc} There are some projects out there known to use Kompose integrated in some form or another diff --git a/docs/user-guide.md b/docs/user-guide.md index 9519106e..4c261e5a 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -9,8 +9,8 @@ redirect_from: # User Guide -- TOC - {:toc} +* TOC +{:toc} Kompose has support for two providers: OpenShift and Kubernetes. You can choose a targeted provider using global option `--provider`. If no provider is specified, Kubernetes is set by default.