feat: add doc versioning

[ankitm123]

Signed-off-by: ankitm123 ankitmohapatra123@gmail.com

fixes #3048

[jenkins-x-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign ankitm123
You can assign the PR to them by writing /assign @ankitm123 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ankitm123]

So the reason it fails is because we dont pull the v2 release branch, and only pull and build the hugo site off the master branch. There's a nice explanation here.

Going to read up on some of the alternatives.

[MarckK]

/test this

[MarckK]

/test this

[MarckK]

Logs:

[jstrachan]

@ankitm123 lots of link errors....

     <a href="/docs/v3/about/how-it-works/#boot-job">boot job will push changes</a>
- ./tmp-website/docs-v3/index.html
  *  internally linking to /docs/v3/about/changes/, which does not exist (line 0)
     <a href="/docs/v3/about/changes/" title="what has changed">Whats new</a>
  *  internally linking to /docs/v3/about/how-it-works/, which does not exist (line 0)
     <a href="/docs/v3/about/how-it-works/" title="How Jenkins X works">How it works</a>
  *  internally linking to /docs/v3/about/overview/, which does not exist (line 0)
     <a href="/docs/v3/about/overview/" title="Overview of Jenkins X and its architecture">Architecture</a>
  *  internally linking to /docs/v3/about/what, which does not exist (line 0)
     <a href="/docs/v3/about/what" title="What is Jenkins X and why would I use it">What is Jenkins X?</a>
  *  internally linking to /docs/v3/develop/, which does not exist (line 0)
     <a href="/docs/v3/develop/" title="GCP with GKE">Developer Guides</a>
  *  internally linking to /docs/v3/develop/create-project/, which does not exist (line 0)
     <a href="/docs/v3/develop/create-project/" title="create quickstarts or import new repositories">Create Projects</a>
  *  internally linking to /docs/v3/getting-started/azure/, which does not exist (line 0)
     <a href="/docs/v3/getting-started/azure/" title="setup Jenkins X on Azure cloud with AKS">
            <img alt="Azure" src="/images/logo/azure.svg" style="float: none;">
          </a>
  *  internally linking to /docs/v3/getting-started/eks/, which does not exist (line 0)
     <a href="/docs/v3/getting-started/eks/" title="setup Jenkins X on Amazon cloud with EKS">
            <img alt="Amazon" src="/images/logo/aws.svg" style="float: none;">
          </a>
  *  internally linking to /docs/v3/getting-started/gke/, which does not exist (line 0)
     <a href="/docs/v3/getting-started/gke/" title="setup Jenkins X on Google Cloud with GKE">
            <img alt="Google" src="/images/logo/gcp.svg" style="float: none;">
          </a>
  *  internally linking to /docs/v3/getting-started/minikube/, which does not exist (line 0)
     <a href="/docs/v3/getting-started/minikube/" title="setup Jenkins X on your laptop">
            <img alt="Minkube" src="/images/logo/minikube.svg" style="float: none;">
          </a>
  *  internally linking to /docs/v3/getting-started/on-premise/, which does not exist (line 0)
     <a href="/docs/v3/getting-started/on-premise/" title="setup Jenkins X on any Kubernetes cluster without cloud resources">
            <img alt="On Premise" src="/images/logo/k8s.svg" style="float: none;">
          </a>
  *  internally linking to /docs/v3/getting-started/openshift/, which does not exist (line 0)
     <a href="/docs/v3/getting-started/openshift/" title="setup Jenkins X on OpenShift">
            <img width="397" height="66" alt="OpenShift" src="/images/logo/openshift.png" style="float: none;"> 
          </a>
- ./tmp-website/docs/resources/guides/extending-**/index.html
  *  internally linking to /docs/v3/about/extending, which does not exist (line 0)
     <a href="/docs/v3/about/extending">improved extending guide</a>

[jstrachan]

still lots of errors...

  *  linking to internal hash #customising-charts that does not exist (line 0)
     <a href="/docs/v3/develop/apps/#customising-charts">app customisation mechanism</a>
  *  linking to internal hash #customising-charts that does not exist (line 0)
     <a href="/docs/v3/develop/apps/#customising-charts">how to customise a chart</a>
  *  linking to internal hash #customising-charts that does not exist (line 0)
     <a href="/docs/v3/develop/apps/#customising-charts">app customisation mechanism</a>
  *  linking to internal hash #edit-secrets that does not exist (line 0)
     <a href="/docs/v3/guides/secrets/#edit-secrets">editing the pipeline token</a>
  *  linking to internal hash #editing-pipelines that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#editing-pipelines">edit any pipeline in any git repository</a>
  *  linking to internal hash #generate-step that does not exist (line 0)
     <a href="/docs/v3/about/how-it-works/#generate-step">how it works</a>
  *  linking to internal hash #git-operator that does not exist (line 0)
     <a href="/docs/v3/about/how-it-works/#git-operator">git operator</a>
  *  linking to internal hash #how-do-i-configure-the-ingress-domain-in-dev-staging-or-production that does not exist (line 0)
     <a href="/docs/v3/develop/faq/#how-do-i-configure-the-ingress-domain-in-dev-staging-or-production">override domain names</a>
  *  linking to internal hash #ide-support that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#ide-support">IDE</a>
  *  linking to internal hash #ide-support that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#ide-support">IDE tooling</a>
  *  linking to internal hash #import-an-existing-project that does not exist (line 0)
     <a href="/docs/v3/develop/create-project/#import-an-existing-project">import a repository</a>
  *  linking to internal hash #import-an-existing-project that does not exist (line 0)
     <a href="/docs/v3/develop/create-project/#import-an-existing-project">import a repository</a>
  *  linking to internal hash #import-secrets that does not exist (line 0)
     <a href="/docs/v3/guides/secrets/#import-secrets">import secrets</a>
  *  linking to internal hash #reference-guide that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#reference-guide">reference guide</a>
  *  linking to internal hash #upgrading-pipelines-and-helm-charts that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#upgrading-pipelines-and-helm-charts">update mechanism on all git repositories</a>
  *  linking to internal hash #upgrading-pipelines-and-helm-charts that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#upgrading-pipelines-and-helm-charts">upgrade your local copy with upstream changes</a>
  *  linking to internal hash #using-vault that does not exist (line 0)
     <a href="/docs/v3/guides/secrets/vault/#using-vault">follow these instructions</a>
  *  linking to internal hash #vault that does not exist (line 0)
     <a href="/docs/v3/guides/config/#vault">configure vault</a>
  *  linking to internal hash #why-does-jenkins-x-use-helmfile-template that does not exist (line 0)
     <a href="/docs/v3/develop/faq/#why-does-jenkins-x-use-helmfile-template">helmfile template</a>
htmlproofer 3.17.0 | Error:  HTML-Proofer found 61 failures!

btw I don't think the link checker cares about aliases; it barfs if the link isn't correct?

[jstrachan]

errors:

./tmp-website/docs-v3/about/benefits/index.html
  *  internally linking to /docs/v3/guides/operator/, which does not exist (line 0)
     <a href="/docs/v3/guides/operator/">installing the git operator</a>
- ./tmp-website/docs-v3/about/extending/index.html
  *  internally linking to /docs/v3/develop/ui/octant, which does not exist (line 0)
     <a href="/docs/v3/develop/ui/octant">octant</a>
  *  internally linking to /docs/v3/guides/upgrade/#cluster, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cluster">** gitops upgrade</a>
- ./tmp-website/docs-v3/about/how-it-works/index.html
  *  internally linking to /docs/v3/guides/operator/, which does not exist (line 0)
     <a href="/docs/v3/guides/operator/">install the git operator</a>
- ./tmp-website/docs-v3/about/overview/index.html
  *  internally linking to /docs/v3/develop/ui/dashboard, which does not exist (line 0)
     <a href="/docs/v3/develop/ui/dashboard">pipelines visualizer</a>
  *  internally linking to /docs/v3/develop/ui/dashboard, which does not exist (line 0)
     <a href="/docs/v3/develop/ui/dashboard">pipelines visualizer</a>
  *  internally linking to /docs/v3/develop/ui/octant, which does not exist (line 0)
     <a href="/docs/v3/develop/ui/octant">octant</a>
  *  internally linking to /docs/v3/guides/health/, which does not exist (line 0)
     <a href="/docs/v3/guides/health/">health checks</a>
  *  internally linking to /docs/v3/guides/health/, which does not exist (line 0)
     <a href="/docs/v3/guides/health/">health and improve observability</a>
- ./tmp-website/docs-v3/develop/apps/index.html
  *  internally linking to /docs/v3/guides/upgrade/#cluster, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cluster">upgrade your cluster</a>
  *  internally linking to /docs/v3/guides/upgrade/#cluster, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cluster">upgrade mechanism</a>
- ./tmp-website/docs-v3/develop/create-project/index.html
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">** 3.x binary</a>
- ./tmp-website/docs-v3/develop/faq/index.html
  *  internally linking to /docs/v3/guides/health/, which does not exist (line 0)
     <a href="/docs/v3/guides/health/">health subsystem</a>
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">**</a>
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">**</a>
  *  internally linking to /docs/v3/guides/operator/, which does not exist (line 0)
     <a href="/docs/v3/guides/operator/">git operator</a>
  *  internally linking to /docs/v3/guides/upgrade/#cluster, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cluster">upgrade your cluster</a>
- ./tmp-website/docs-v3/develop/index.html
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">** 3.x binary</a>
- ./tmp-website/docs-v3/develop/pipeline-catalog/index.html
  *  internally linking to /docs/v3/guides/upgrade/#cluster, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cluster">upgrade your cluster to the latest version stream</a>
  *  internally linking to /docs/v3/guides/upgrade/#cluster, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cluster">clusters git repository</a>
- ./tmp-website/docs-v3/develop/ui/cli/index.html
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">**</a>
- ./tmp-website/docs-v3/develop/ui/dashboard/index.html
  *  internally linking to /docs/v3/guides/upgrade/#cli, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cli">have a recent ** binary</a>
- ./tmp-website/docs-v3/develop/ui/octant/index.html
  *  internally linking to /docs/v3/guides/upgrade/#cli, which does not exist (line 0)
     <a href="/docs/v3/guides/upgrade/#cli">have a recent ** binary</a>
- ./tmp-website/docs-v3/getting-started/on-premise/index.html
  *  internally linking to /docs/v3/guides/operator/, which does not exist (line 0)
     <a href="/docs/v3/guides/operator/" target="github" class="btn bg-primary text-light" title="install the git operator to setup Jenkins X in your cluster">
Install the git operator
</a>
- ./tmp-website/docs-v3/getting-started/openshift/index.html
  *  internally linking to /docs/v3/guides/operator/, which does not exist (line 0)
     <a href="/docs/v3/guides/operator/" class="btn bg-primary text-light">Install the Git Operator</a>
- ./tmp-website/docs-v3/guides/index.html
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">** 3.x binary</a>
- ./tmp-website/docs-v3/guides/infra/minikube/index.html
  *  internally linking to /docs/v3/guides/**3/, which does not exist (line 0)
     <a href="/docs/v3/guides/**3/">Download and install the ** 3.x binary</a>
  *  internally linking to /docs/v3/guides/operator/, which does not exist (line 0)
     <a href="/docs/v3/develop/create-project/#create-a-new-project-from-a-quickstart">create a new quickstart</a>
  *  linking to internal hash #create-a-new-project-from-a-quickstart that does not exist (line 0)
     <a href="/docs/v3/develop/create-project/#create-a-new-project-from-a-quickstart">create a new quickstart</a>
  *  linking to internal hash #customising-charts that does not exist (line 0)
     <a href="/docs/v3/develop/apps/#customising-charts">app customisation mechanism</a>
  *  linking to internal hash #customising-charts that does not exist (line 0)
     <a href="/docs/v3/develop/apps/#customising-charts">how to customise a chart</a>
  *  linking to internal hash #customising-charts that does not exist (line 0)
     <a href="/docs/v3/develop/apps/#customising-charts">app customisation mechanism</a>
  *  linking to internal hash #edit-secrets that does not exist (line 0)
     <a href="/docs/v3/guides/secrets/#edit-secrets">editing the pipeline token</a>
  *  linking to internal hash #editing-pipelines that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#editing-pipelines">edit any pipeline in any git repository</a>
  *  linking to internal hash #generate-step that does not exist (line 0)
     <a href="/docs/v3/about/how-it-works/#generate-step">how it works</a>
  *  linking to internal hash #git-operator that does not exist (line 0)
     <a href="/docs/v3/about/how-it-works/#git-operator">git operator</a>
  *  linking to internal hash #how-do-i-configure-the-ingress-domain-in-dev-staging-or-production that does not exist (line 0)
     <a href="/docs/v3/develop/faq/#how-do-i-configure-the-ingress-domain-in-dev-staging-or-production">override domain names</a>
  *  linking to internal hash #ide-support that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#ide-support">IDE</a>
  *  linking to internal hash #ide-support that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#ide-support">IDE tooling</a>
  *  linking to internal hash #import-an-existing-project that does not exist (line 0)
     <a href="/docs/v3/develop/create-project/#import-an-existing-project">import a repository</a>
  *  linking to internal hash #import-an-existing-project that does not exist (line 0)
     <a href="/docs/v3/develop/create-project/#import-an-existing-project">import a repository</a>
  *  linking to internal hash #import-secrets that does not exist (line 0)
     <a href="/docs/v3/guides/secrets/#import-secrets">import secrets</a>
  *  linking to internal hash #reference-guide that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#reference-guide">reference guide</a>
  *  linking to internal hash #upgrading-pipelines-and-helm-charts that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#upgrading-pipelines-and-helm-charts">update mechanism on all git repositories</a>
  *  linking to internal hash #upgrading-pipelines-and-helm-charts that does not exist (line 0)
     <a href="/docs/v3/develop/pipeline-catalog/#upgrading-pipelines-and-helm-charts">upgrade your local copy with upstream changes</a>
  *  linking to internal hash #using-vault that does not exist (line 0)
     <a href="/docs/v3/guides/secrets/vault/#using-vault">follow these instructions</a>
  *  linking to internal hash #vault that does not exist (line 0)
     <a href="/docs/v3/guides/config/#vault">configure vault</a>
  *  linking to internal hash #why-does-jenkins-x-use-helmfile-template that does not exist (line 0)
     <a href="/docs/v3/develop/faq/#why-does-jenkins-x-use-helmfile-template">helmfile template</a>
htmlproofer 3.17.0 | Error:  HTML-Proofer found 61 failures!

[jenkins-x-bot]

⭐ PR built and available in a preview environment jenkins-x-jx-docs-pr-3114 here

[jenkins-x-bot]

⭐ PR built and available in a preview environment jenkins-x-jx-docs-pr-3114 here

[jenkins-x-bot]

⭐ PR built and available in a preview environment jenkins-x-jx-docs-pr-3114 here

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
No Duplication information

[borntorock]

The suffix URL for the v3 docs is being served at {URL}/docs-v3/ and for JX v2 at {URL}/docs/. Is this the behaviour we want and not the opposite?

I mean the v2 docs being served at {URL}/docs-v2/ and the latest JX v3 docs being served at {URL}/docs.

[jenkins-x-bot]

⭐ PR built and available in a preview environment jenkins-x-jx-docs-pr-3114 here