feat: add doc versioning

Signed-off-by: ankitm123 <[email protected]>
jenkins-x · Nov 17, 2020 · 55447a4 · 55447a4
1 parent a0a57ab
commit 55447a4
Show file tree

Hide file tree

Showing 49 changed files with 144 additions and 3 deletions.
diff --git a/config.toml b/config.toml
@@ -186,3 +186,14 @@ no = 'Sorry to hear that. Please <a href="https://github.com/jenkins-x/jx-docs/i
 	url = "https://kubernetes.slack.com/messages/C9LTHT2BB"
 	icon = "fab fa-slack"
   desc = "Chat with other project developers"
+
+# Versioning
+[[params.versions]]
+version = "v3.x"
+url = "/docs/v3"
+dirpath = "docs-v3"
+
+[[params.versions]]
+version = "v2.x"
+url = "/docs"
+dirpath = "docs"
diff --git a/content/en/docs/v3/_index.md → content/en/docs-v3/_index.md b/content/en/docs/v3/_index.md → content/en/docs-v3/_index.md
@@ -5,6 +5,7 @@ type: docs
 weight: 45
 aliases:
   - /labs
+  - /docs/v3/
 ---
 
 

diff --git a/content/en/docs/v3/about/_index.md → content/en/docs-v3/about/_index.md b/content/en/docs/v3/about/_index.md → content/en/docs-v3/about/_index.md
@@ -4,6 +4,8 @@ linktitle: About
 type: docs
 description: Documentation about Jenkins X 3.x benefits, comparison and how it works
 weight: 5
+aliases: 
+    - /docs/v3/about/
 ---
 
 
diff --git a/content/en/docs/v3/about/benefits.md → content/en/docs-v3/about/benefits.md b/content/en/docs/v3/about/benefits.md → content/en/docs-v3/about/benefits.md
@@ -1,8 +1,11 @@
 ---
 title: Benefits
 linktitle: Benefits
+type: docs
 description: Benefits of using Jenkins X 3.x
 weight: 80
+aliases: 
+    - /docs/v3/about/benefits/
 ---
 
 

diff --git a/content/en/docs/v3/about/changes.md → content/en/docs-v3/about/changes.md b/content/en/docs/v3/about/changes.md → content/en/docs-v3/about/changes.md
@@ -1,8 +1,11 @@
 ---
 title: Changes
 linktitle: Changes
+type: docs
 description: The change log for Jenkins X 3.x
 weight: 55
+aliases: 
+    - /docs/v3/about/changes/
 ---
 
 You may also find the [Roadmap](/community/roadmap/) and [Maturity Matrix](/docs/v3/about/maturity-matrix/) documents useful:

diff --git a/content/en/docs/v3/about/comparison.md → content/en/docs-v3/about/comparison.md b/content/en/docs/v3/about/comparison.md → content/en/docs-v3/about/comparison.md
@@ -1,8 +1,11 @@
 ---
 title: Comparison
 linktitle: Comparison
+type: docs
 description: Comparison of Jenkins X version 3.x to 2.x
 weight: 90
+aliases: 
+    - /docs/v3/about/comparison/
 ---
 
 

diff --git a/content/en/docs/v3/about/extending.md → content/en/docs-v3/about/extending.md b/content/en/docs/v3/about/extending.md → content/en/docs-v3/about/extending.md
@@ -1,8 +1,11 @@
 ---
 title: Extending
 linktitle: Extending
+type: docs
 description: How to extend Jenkins X 3.x 
 weight: 500
+aliases: 
+    - /docs/v3/about/extending/
 ---
 
 Jenkins X has a number of extension points you can use to extend the CI/CD platform to suit your needs:

diff --git a/content/en/docs/v3/about/how-it-works.md → content/en/docs-v3/about/how-it-works.md b/content/en/docs/v3/about/how-it-works.md → content/en/docs-v3/about/how-it-works.md
@@ -1,8 +1,11 @@
 ---
 title: How it works
 linktitle: How it works
+type: docs
 description: How Jenkins X 3.x works under the covers
 weight: 130
+aliases: 
+    - /docs/v3/about/how-it-works/
 ---
 
 

diff --git a/content/en/docs/v3/about/maturity-matrix.md → content/en/docs-v3/about/maturity-matrix.md b/content/en/docs/v3/about/maturity-matrix.md → content/en/docs-v3/about/maturity-matrix.md
@@ -1,8 +1,11 @@
 ---
 title: Maturity Level Matrix
-linktitle: Maturity Level Matrix 
+linktitle: Maturity Level Matrix
+type: docs
 description: Jenkins X 3.x features maturity assessment on different cloud providers
 weight: 60
+aliases: 
+    - /docs/v3/about/maturity-matrix/
 ---
 
 This maturity matrix descibes the status of the Jenkins X 3.x __Alpha__ release.  This will continue to evolve as we progress towards Beta.

diff --git a/content/en/docs/v3/about/overview.md → content/en/docs-v3/about/overview.md b/content/en/docs/v3/about/overview.md → content/en/docs-v3/about/overview.md
@@ -1,8 +1,11 @@
 ---
 title: Overview
 linktitle: Overview
+type: docs
 description: Overview of the architecture, concepts and motivations for Jenkins X 3.x
 weight: 50
+aliases: 
+    - /docs/v3/about/overview/
 ---
 
 Jenkins X 3.x creates clearer separation of concerns between conceptual areas and releasable components.

diff --git a/content/en/docs/v3/about/what.md → content/en/docs-v3/about/what.md b/content/en/docs/v3/about/what.md → content/en/docs-v3/about/what.md
@@ -1,8 +1,11 @@
 ---
 title: What is Jenkins X?
 linktitle: What is Jenkins X?
+type: docs
 description: Introduction to what Jenkins X is
 weight: 10
+aliases: 
+    - /docs/v3/about/what/
 ---
 
 Jenkins X aims to automate and accelerate Continuous Integration and Continuous Delivery for developers on the cloud and/or Kubernetes so they can focus on building awesome software and not waste time figuring out how to use the cloud or manually create and maintain pipelines.

diff --git a/content/en/docs/v3/develop/_index.md → content/en/docs-v3/develop/_index.md b/content/en/docs/v3/develop/_index.md → content/en/docs-v3/develop/_index.md
@@ -4,6 +4,8 @@ linktitle: Developer Guides
 type: docs
 description: Guides on developing software with Jenkins X 3.x
 weight: 200
+aliases: 
+    - /docs/v3/develop/
 ---
 
 Make sure you have got the [jx 3.x binary](/docs/v3/guides/jx3/) before proceeding.

diff --git a/content/en/docs/v3/develop/apps.md → content/en/docs-v3/develop/apps.md b/content/en/docs/v3/develop/apps.md → content/en/docs-v3/develop/apps.md
@@ -1,10 +1,12 @@
 ---
 title: Apps
 linktitle: Apps
+type: docs
 description: Adding or configuration apps and charts 
 weight: 100
 aliases:
   - /docs/v3/guides/apps/
+  - /docs/v3/develop/apps
 ---
 
 

diff --git a/.../docs/v3/develop/create-project/_index.md → .../docs-v3/develop/create-project/_index.md b/.../docs/v3/develop/create-project/_index.md → .../docs-v3/develop/create-project/_index.md
@@ -2,10 +2,11 @@
 title: "Creating projects"
 date: 2017-01-05
 weight: 30
+type: docs
 description: >
   Now that you've setup the platform, let's create your first project.
-aliases:
-  - /docs/v3/create-project/
+aliases: 
+    - /docs/v3/develop/create-project/
 ---
 
 To create or import projects you will need to get the [jx 3.x binary](/docs/v3/guides/jx3/) and put it on your `$PATH`

diff --git a/.../v3/develop/create-project/jenkinsfile.md → ...-v3/develop/create-project/jenkinsfile.md b/.../v3/develop/create-project/jenkinsfile.md → ...-v3/develop/create-project/jenkinsfile.md
@@ -1,8 +1,11 @@
 ---
 title: Jenkinsfile support
 linktitle: Jenkinsfile support
+type: docs
 description: How 3.x handles importing Jenkinsfiles
 weight: 30
+aliases: 
+    - /docs/v3/develop/jenkinsfile
 ---
 
 

diff --git a/content/en/docs/v3/develop/faq/_index.md → content/en/docs-v3/develop/faq/_index.md b/content/en/docs/v3/develop/faq/_index.md → content/en/docs-v3/develop/faq/_index.md
@@ -1,11 +1,13 @@
 ---
 title: FAQ
 linktitle: FAQ
+type: docs
 description: Questions on using Jenkins X 3.x and helm 3
 weight: 500
 aliases:
   - /faq/
   - /docs/v3/guides/faq/
+  - /docs/v3/develop/faq/
 ---
 
 

diff --git a/...nt/en/docs/v3/develop/pipeline-catalog.md → ...nt/en/docs-v3/develop/pipeline-catalog.md b/...nt/en/docs/v3/develop/pipeline-catalog.md → ...nt/en/docs-v3/develop/pipeline-catalog.md
@@ -1,10 +1,12 @@
 ---
 title: Pipeline Catalogs
 linktitle: Pipeline Catalogs
+type: docs
 description: Integration with Tekton Pipelines and Tekton Catalog
 weight: 200
 aliases:
   - /docs/v3/guides/pipeline-catalog/
+  - /docs/v3/develop/pipeline-catalog
 ---
 
 As part of the [Tekton Catalog enhancement proposal](https://github.com/jenkins-x/enhancements/issues/37) we've improved support for Tekton in Jenkins X so that you can

diff --git a/content/en/docs/v3/develop/ui/_index.md → content/en/docs-v3/develop/ui/_index.md b/content/en/docs/v3/develop/ui/_index.md → content/en/docs-v3/develop/ui/_index.md
@@ -1,10 +1,13 @@
 ---
 title: UI
 linktitle: UI
+type: docs
 description: User interfaces for Jenkins X
 weight: 10
 aliases:
   - /docs/v3/guides/ui/
+  - /docs/v3/develop/ui/
+
 ---
 
 
diff --git a/content/en/docs/v3/develop/ui/cli.md → content/en/docs-v3/develop/ui/cli.md b/content/en/docs/v3/develop/ui/cli.md → content/en/docs-v3/develop/ui/cli.md
@@ -1,8 +1,11 @@
 ---
 title: CLI
 linktitle: CLI
+type: docs
 description: Jenkins X Command Line Interface
 weight: 10
+aliases:
+  - /docs/v3/develop/ui/cli
 ---
 
 For those who like command lines you can view and watch most things via the [jx](/docs/v3/guides/jx3/) command line.

diff --git a/content/en/docs/v3/develop/ui/dashboard.md → content/en/docs-v3/develop/ui/dashboard.md b/content/en/docs/v3/develop/ui/dashboard.md → content/en/docs-v3/develop/ui/dashboard.md
@@ -1,8 +1,11 @@
 ---
 title: Dashboard
 linktitle: Dashboard
+type: docs
 description: Read only dashboard view of pipelines and logs
 weight: 100
+aliases:
+  - /docs/v3/develop/ui/dashboard
 ---
 
 It's a common requirement to want to view pipelines running, their logs or to be able to click on a Pull Request on your git provider and view the pipeline log for that commit on that Pull Request.

diff --git a/content/en/docs/v3/develop/ui/octant.md → content/en/docs-v3/develop/ui/octant.md b/content/en/docs/v3/develop/ui/octant.md → content/en/docs-v3/develop/ui/octant.md
@@ -1,8 +1,11 @@
 ---
 title: Console
 linktitle: Console
+type: docs
 description: Jenkins X Console based on Octant 
 weight: 50
+aliases:
+  - /docs/v3/develop/ui/octant
 ---
 
 As a general purpose console for working with Kubernetes, Jenkins X, Tekton and more resources we highly recommend [Octant](https://octant.dev/)

diff --git a/content/en/docs/v3/getting-started/_index.md → content/en/docs-v3/getting-started/_index.md b/content/en/docs/v3/getting-started/_index.md → content/en/docs-v3/getting-started/_index.md
@@ -1,11 +1,14 @@
 ---
 title: Installation
 linktitle: Installation
+type: docs
 description: Getting you started with your Jenkins X 3.x installation
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 10
+aliases:
+  - /docs/v3/getting-started/
 ---
 
 Jenkins X 3.x alpha includes a new install approach which uses tools like helm 3, kpt, and kustomize to maintain Kubernetes YAML. This is one of many [improvements](/docs/v3/about/benefits/) over Jenkins X 2.

diff --git a/content/en/docs/v3/getting-started/azure.md → content/en/docs-v3/getting-started/azure.md b/content/en/docs/v3/getting-started/azure.md → content/en/docs-v3/getting-started/azure.md
@@ -1,11 +1,14 @@
 ---
 title: Azure
 linktitle: Azure
+type: docs
 description: Setup Jenkins X on Azure
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 30
+aliases:
+  - /docs/v3/getting-started/azure
 ---
 
 ---

diff --git a/content/en/docs/v3/getting-started/eks.md → content/en/docs-v3/getting-started/eks.md b/content/en/docs/v3/getting-started/eks.md → content/en/docs-v3/getting-started/eks.md
@@ -1,11 +1,14 @@
 ---
 title: Amazon
 linktitle: Amazon
+type: docs
 description: Setup Jenkins X on EKS on AWS
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 20
+aliases:
+  - /docs/v3/getting-started/eks
 ---
 
 ---

diff --git a/content/en/docs/v3/getting-started/gke.md → content/en/docs-v3/getting-started/gke.md b/content/en/docs/v3/getting-started/gke.md → content/en/docs-v3/getting-started/gke.md
@@ -1,11 +1,14 @@
 ---
 title: Google Cloud
 linktitle: Google Cloud
+type: docs
 description: Setup Jenkins X on GKE 
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 40
+aliases:
+  - /docs/v3/getting-started/gke
 ---
 
 ---

diff --git a/...nt/en/docs/v3/getting-started/minikube.md → ...nt/en/docs-v3/getting-started/minikube.md b/...nt/en/docs/v3/getting-started/minikube.md → ...nt/en/docs-v3/getting-started/minikube.md
@@ -1,11 +1,14 @@
 ---
 title: Minikube
 linktitle: Minikube
+type: docs
 description: Setup Jenkins X on your laptop
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 100
+aliases:
+  - /docs/v3/getting-started/minikube
 ---
 
 ---

diff --git a/.../en/docs/v3/getting-started/on-premise.md → .../en/docs-v3/getting-started/on-premise.md b/.../en/docs/v3/getting-started/on-premise.md → .../en/docs-v3/getting-started/on-premise.md
@@ -1,11 +1,14 @@
 ---
 title: On Premise
 linktitle:  On Premise
+type: docs
 description: Setup Jenkins X on vanilla Kubernetes  
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 150
+aliases:
+  - /docs/v3/getting-started/on-premise
 ---
 
 ---

diff --git a/...t/en/docs/v3/getting-started/openshift.md → ...t/en/docs-v3/getting-started/openshift.md b/...t/en/docs/v3/getting-started/openshift.md → ...t/en/docs-v3/getting-started/openshift.md
@@ -1,11 +1,14 @@
 ---
 title: OpenShift
 linktitle:  OpenShift
+type: docs
 description: Setup Jenkins X on an existing OpenShift cluster
 date: 2017-02-01
 publishdate: 2017-02-01
 lastmod: 2020-02-21
 weight: 200
+aliases:
+  - /docs/v3/getting-started/openshift
 ---
 
 If you don't have a cluster or want to try Openshift on your laptop then please try <a href="/docs/v3/guides/infra/openshift-crc/" target="github" class="btn bg-primary text-light">Install Jenkins X with OpenShift CodeReady Containers</a> 

diff --git a/content/en/docs/v3/guides/_index.md → content/en/docs-v3/guides/_index.md b/content/en/docs/v3/guides/_index.md → content/en/docs-v3/guides/_index.md
@@ -4,6 +4,8 @@ linktitle: Admin Guides
 type: docs
 description: Admin Guides on configuring, ugprading and managing Jenkins X 3.x
 weight: 200
+aliases:
+  - /docs/v3/guides/
 ---
 
 Make sure you have got the [jx 3.x binary](/docs/v3/guides/jx3/) before proceeding.

diff --git a/content/en/docs/v3/guides/config.md → content/en/docs-v3/guides/config.md b/content/en/docs/v3/guides/config.md → content/en/docs-v3/guides/config.md
@@ -1,8 +1,11 @@
 ---
 title: Configuration
 linktitle: Configuration
+type: docs
 description: Changing your configuration
 weight: 80
+aliases:
+  - /docs/v3/guides/config
 ---
 
 

diff --git a/content/en/docs/v3/guides/health.md → content/en/docs-v3/guides/health.md b/content/en/docs/v3/guides/health.md → content/en/docs-v3/guides/health.md
@@ -1,8 +1,11 @@
 ---
 title: Health
 linktitle: Health
+type: docs
 description: Check the health of a Jenkins X installation
 weight: 92
+aliases:
+  - /docs/v3/guides/health
 ---
 
 Jenkins X v3.x now has a CLI plugin that works with [Kuberhealthy](https://github.com/Comcast/kuberhealthy) to check the health of a working Jenkins X.
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ type: docs @@
     weight: 45
     aliases:
       - /labs
+      - /docs/v3/
     ---
@@ Expand Down @@