From 3319699f2449ccb9992b65906bd3c3b83ae20ca6 Mon Sep 17 00:00:00 2001 From: Gary Ewan Park Date: Mon, 2 Aug 2021 21:29:19 +0100 Subject: [PATCH] (#2664) Add redirects for pages that have moved As a result of changes to the structure of the documentation site, the original 301 redirects from readthedocs, were resulting in 404's within GitHub pages. This PR addresses this by ensuring that a Wyam RedirectFrom attribute is added to all affected pages, so that the end result is arrive on the correct page. There may be additional changes that need to be made to capture all pages, but this commit contains all 301 redirects from the current readthedocs configuration. --- docs/input/docs/index.cshtml | 3 +++ .../docs/learn/branching-strategies/contribute-examples.md | 1 + .../branching-strategies/gitflow/converting-to-gitflow.md | 1 + .../docs/learn/branching-strategies/gitflow/examples.md | 3 +++ docs/input/docs/learn/branching-strategies/gitflow/index.md | 1 + .../docs/learn/branching-strategies/githubflow/examples.md | 1 + .../docs/learn/branching-strategies/githubflow/index.md | 1 + docs/input/docs/learn/branching-strategies/index.cshtml | 4 ++++ docs/input/docs/learn/dynamic-repositories.md | 1 + docs/input/docs/learn/faq.md | 1 + docs/input/docs/learn/git-setup.md | 1 + docs/input/docs/learn/how-it-works.md | 1 + docs/input/docs/learn/index.cshtml | 1 + docs/input/docs/learn/intro-to-semver.md | 1 + docs/input/docs/learn/who.md | 1 + docs/input/docs/learn/why.md | 1 + docs/input/docs/reference/build-servers/appveyor.md | 1 + docs/input/docs/reference/build-servers/azure-devops.md | 1 + docs/input/docs/reference/build-servers/bamboo.md | 1 + docs/input/docs/reference/build-servers/continua.md | 1 + docs/input/docs/reference/build-servers/gitlab.md | 1 + docs/input/docs/reference/build-servers/index.cshtml | 6 ++++++ docs/input/docs/reference/build-servers/jenkins.md | 1 + docs/input/docs/reference/build-servers/myget.md | 1 + docs/input/docs/reference/build-servers/octopus-deploy.md | 1 + docs/input/docs/reference/build-servers/teamcity.md | 1 + docs/input/docs/reference/configuration.md | 1 + docs/input/docs/reference/modes/continuous-delivery.md | 1 + docs/input/docs/reference/modes/continuous-deployment.md | 1 + docs/input/docs/reference/modes/index.cshtml | 1 + docs/input/docs/reference/modes/mainline.md | 1 + docs/input/docs/reference/variables.md | 1 + docs/input/docs/reference/version-increments.md | 3 +++ docs/input/docs/reference/version-sources.md | 1 + docs/input/docs/usage/cli/index.cshtml | 1 + docs/input/docs/usage/index.cshtml | 3 +++ docs/input/docs/usage/library.md | 1 + docs/input/docs/usage/msbuild.md | 1 + 38 files changed, 54 insertions(+) diff --git a/docs/input/docs/index.cshtml b/docs/input/docs/index.cshtml index da06254bc2..670711876a 100644 --- a/docs/input/docs/index.cshtml +++ b/docs/input/docs/index.cshtml @@ -1,5 +1,8 @@ --- Title: Documentation +RedirectFrom: + - docs/reference/pull-requests + - docs/reference/feature-branches --- @{ diff --git a/docs/input/docs/learn/branching-strategies/contribute-examples.md b/docs/input/docs/learn/branching-strategies/contribute-examples.md index f2de039ab6..5ce7224cb5 100644 --- a/docs/input/docs/learn/branching-strategies/contribute-examples.md +++ b/docs/input/docs/learn/branching-strategies/contribute-examples.md @@ -2,6 +2,7 @@ Order: 70 Title: Contribute Examples Description: Contribute examples of how GitVersion works for your branching strategy +RedirectFrom: docs/git-branching-strategies/creating-updating-examples --- The examples are generated by GitVersion tests, there are a number of services diff --git a/docs/input/docs/learn/branching-strategies/gitflow/converting-to-gitflow.md b/docs/input/docs/learn/branching-strategies/gitflow/converting-to-gitflow.md index 0643c05496..7402b9655b 100644 --- a/docs/input/docs/learn/branching-strategies/gitflow/converting-to-gitflow.md +++ b/docs/input/docs/learn/branching-strategies/gitflow/converting-to-gitflow.md @@ -1,6 +1,7 @@ --- Order: 60 Title: Converting to GitFlow +RedirectFrom: docs/git-branching-strategies/converting-to-gitflow --- Converting to GitFlow is simple. Whenever you need to convert, simply do the diff --git a/docs/input/docs/learn/branching-strategies/gitflow/examples.md b/docs/input/docs/learn/branching-strategies/gitflow/examples.md index 7e38000182..32c3712343 100644 --- a/docs/input/docs/learn/branching-strategies/gitflow/examples.md +++ b/docs/input/docs/learn/branching-strategies/gitflow/examples.md @@ -1,6 +1,9 @@ --- Order: 40 Title: GitFlow Examples +RedirectFrom: +- docs/git-branching-strategies/gitflow-examples_complete +- docs/git-branching-strategies/gitflow-examples --- These examples are using the _default_ configuration with GitVersion. Which is diff --git a/docs/input/docs/learn/branching-strategies/gitflow/index.md b/docs/input/docs/learn/branching-strategies/gitflow/index.md index c4a989ff62..8c95f757fa 100644 --- a/docs/input/docs/learn/branching-strategies/gitflow/index.md +++ b/docs/input/docs/learn/branching-strategies/gitflow/index.md @@ -2,6 +2,7 @@ Order: 20 Title: Git Flow Description: The Git Flow branching strategy allows for more structured releases +RedirectFrom: docs/git-branching-strategies/gitflow --- Git Flow allows more structured releases, and GitVersion will derive sensible diff --git a/docs/input/docs/learn/branching-strategies/githubflow/examples.md b/docs/input/docs/learn/branching-strategies/githubflow/examples.md index ad492dd760..6766feee6b 100644 --- a/docs/input/docs/learn/branching-strategies/githubflow/examples.md +++ b/docs/input/docs/learn/branching-strategies/githubflow/examples.md @@ -1,6 +1,7 @@ --- Order: 50 Title: GitHubFlow Examples +RedirectFrom: docs/git-branching-strategies/githubflow-examples --- ## Feature branch diff --git a/docs/input/docs/learn/branching-strategies/githubflow/index.md b/docs/input/docs/learn/branching-strategies/githubflow/index.md index b0007f062c..513e1dd57b 100644 --- a/docs/input/docs/learn/branching-strategies/githubflow/index.md +++ b/docs/input/docs/learn/branching-strategies/githubflow/index.md @@ -2,6 +2,7 @@ Order: 30 Title: GitHub Flow Description: GitHub flow is a simpler and pull request-driven branching strategy +RedirectFrom: docs/git-branching-strategies/githubflow --- GitHubFlow is a simple and effective branching strategy which the folks at diff --git a/docs/input/docs/learn/branching-strategies/index.cshtml b/docs/input/docs/learn/branching-strategies/index.cshtml index 7d3fea96c4..95f2775aa2 100644 --- a/docs/input/docs/learn/branching-strategies/index.cshtml +++ b/docs/input/docs/learn/branching-strategies/index.cshtml @@ -2,6 +2,10 @@ Order: 4000 Title: Branching Strategies Description: Information about the different branching strategies supported by GitVersion +RedirectFrom: +- docs/git-branching-strategies/overview +- docs/git-branching-strategies +- docs/examples --- Commit graph diff --git a/docs/input/docs/learn/dynamic-repositories.md b/docs/input/docs/learn/dynamic-repositories.md index 30497536e7..0ba9bf49cb 100644 --- a/docs/input/docs/learn/dynamic-repositories.md +++ b/docs/input/docs/learn/dynamic-repositories.md @@ -1,6 +1,7 @@ --- Order: 20 Title: Dynamic Repositories +RedirectFrom: docs/more-info/dynamic-repositories --- GitVersion.exe requires access to the Git repository in order to do / infer all diff --git a/docs/input/docs/learn/faq.md b/docs/input/docs/learn/faq.md index 42cbd7a9ef..e69d106a94 100644 --- a/docs/input/docs/learn/faq.md +++ b/docs/input/docs/learn/faq.md @@ -1,6 +1,7 @@ --- Order: 50 Title: FAQ +RedirectFrom: docs/faq --- ## Why is my version not incrementing? diff --git a/docs/input/docs/learn/git-setup.md b/docs/input/docs/learn/git-setup.md index 4559a5bc0c..1d8d08d67f 100644 --- a/docs/input/docs/learn/git-setup.md +++ b/docs/input/docs/learn/git-setup.md @@ -1,6 +1,7 @@ --- Order: 20 Title: Git Setup +RedirectFrom: docs/reference/git-setup --- ## Remotes diff --git a/docs/input/docs/learn/how-it-works.md b/docs/input/docs/learn/how-it-works.md index 02f00efc1d..a492f50a1e 100644 --- a/docs/input/docs/learn/how-it-works.md +++ b/docs/input/docs/learn/how-it-works.md @@ -1,6 +1,7 @@ --- Order: 10 Title: How it works +RedirectFrom: docs/more-info/how-it-works --- GitVersion v3 works very differently to v2. Version 2 had knowledge of both diff --git a/docs/input/docs/learn/index.cshtml b/docs/input/docs/learn/index.cshtml index 397d2303d0..1df455dbbd 100644 --- a/docs/input/docs/learn/index.cshtml +++ b/docs/input/docs/learn/index.cshtml @@ -2,6 +2,7 @@ Title: Learn Description: More in depth information about GitVersion Order: 2000 +RedirectFrom: docs/more-info ---

Once you understand the basics of GitVersion, there are a number of lower level functions and configurations that you might want to make. These are detailed in the following sections.

diff --git a/docs/input/docs/learn/intro-to-semver.md b/docs/input/docs/learn/intro-to-semver.md index 68f6679bb9..0a627262fb 100644 --- a/docs/input/docs/learn/intro-to-semver.md +++ b/docs/input/docs/learn/intro-to-semver.md @@ -1,6 +1,7 @@ --- Order: 10 Title: Intro to SemVer +RedirectFrom: docs/reference/intro-to-semver --- For the official Semantic Version docs head to [semver.org](http://semver.org). This is just a quick guide for people getting started and how SemVer is used in GitVersion. diff --git a/docs/input/docs/learn/who.md b/docs/input/docs/learn/who.md index 6431650b8a..b175a688b3 100644 --- a/docs/input/docs/learn/who.md +++ b/docs/input/docs/learn/who.md @@ -1,6 +1,7 @@ --- Order: 70 Title: Who is using GitVersion +RedirectFrom: docs/who --- Various people are actively using GitVersion, and taking advantage of the diff --git a/docs/input/docs/learn/why.md b/docs/input/docs/learn/why.md index 8d09611a5b..421db61eee 100644 --- a/docs/input/docs/learn/why.md +++ b/docs/input/docs/learn/why.md @@ -1,6 +1,7 @@ --- Order: 60 Title: Why use GitVersion? +RedirectFrom: docs/why --- GitVersion makes versioning woes a thing of the past. It looks at your git diff --git a/docs/input/docs/reference/build-servers/appveyor.md b/docs/input/docs/reference/build-servers/appveyor.md index 15904e70e1..d23f0da61d 100644 --- a/docs/input/docs/reference/build-servers/appveyor.md +++ b/docs/input/docs/reference/build-servers/appveyor.md @@ -2,6 +2,7 @@ Order: 10 Title: AppVeyor Description: Details on the AppVeyor support in GitVersion +RedirectFrom: docs/build-server-support/build-server/appveyor --- AppVeyor is the first build server which has a setup helper built into diff --git a/docs/input/docs/reference/build-servers/azure-devops.md b/docs/input/docs/reference/build-servers/azure-devops.md index de649d9308..2f59695c9d 100644 --- a/docs/input/docs/reference/build-servers/azure-devops.md +++ b/docs/input/docs/reference/build-servers/azure-devops.md @@ -4,6 +4,7 @@ Title: Azure DevOps Description: | Details on the Azure DevOps or Team Foundation Server Build Pipeline support in GitVersion +RedirectFrom: docs/build-server-support/build-server/azure-devops --- ## Basic Usage diff --git a/docs/input/docs/reference/build-servers/bamboo.md b/docs/input/docs/reference/build-servers/bamboo.md index b693c5e5bf..71e0ad3ae1 100644 --- a/docs/input/docs/reference/build-servers/bamboo.md +++ b/docs/input/docs/reference/build-servers/bamboo.md @@ -2,6 +2,7 @@ Order: 30 Title: Bamboo Description: Details on the Bamboo support in GitVersion +RedirectFrom: docs/build-server-support/build-server/bamboo --- If you use Bamboo then you will have to use GitVersion from the command line, as diff --git a/docs/input/docs/reference/build-servers/continua.md b/docs/input/docs/reference/build-servers/continua.md index 0c53f9ae79..6245c72d29 100644 --- a/docs/input/docs/reference/build-servers/continua.md +++ b/docs/input/docs/reference/build-servers/continua.md @@ -2,6 +2,7 @@ Order: 40 Title: Continua CI Description: Details on the Continua CI support in GitVersion +RedirectFrom: docs/build-server-support/build-server/continua --- This guide explains how to run GitVersion inside [Continua CI](https://www.finalbuilder.com/continua-ci). diff --git a/docs/input/docs/reference/build-servers/gitlab.md b/docs/input/docs/reference/build-servers/gitlab.md index 062145add6..7bb7d290d7 100755 --- a/docs/input/docs/reference/build-servers/gitlab.md +++ b/docs/input/docs/reference/build-servers/gitlab.md @@ -2,6 +2,7 @@ Order: 50 Title: GitLab CI Description: Details on the GitLab CI support in GitVersion +RedirectFrom: docs/build-server-support/build-server/gitlab --- To use GitVersion with GitLab CI, either use the [MSBuild diff --git a/docs/input/docs/reference/build-servers/index.cshtml b/docs/input/docs/reference/build-servers/index.cshtml index e65f96af73..7db55ff01a 100644 --- a/docs/input/docs/reference/build-servers/index.cshtml +++ b/docs/input/docs/reference/build-servers/index.cshtml @@ -1,6 +1,12 @@ --- Order: 3000 Description: Details on GitVersion's Build Server support +RedirectFrom: +- docs/build-server-support +- docs/build-server-support/build-server +- docs/build-server-support/build-server/index.html +- docs/build-server-support/build-server-support +- docs/build-server-support/index.html ---

diff --git a/docs/input/docs/reference/build-servers/jenkins.md b/docs/input/docs/reference/build-servers/jenkins.md index d1decd9bb3..98705029ce 100644 --- a/docs/input/docs/reference/build-servers/jenkins.md +++ b/docs/input/docs/reference/build-servers/jenkins.md @@ -2,6 +2,7 @@ Order: 60 Title: Jenkins Description: Details on the Jenkins support in GitVersion +RedirectFrom: docs/build-server-support/build-server/jenkins --- ## SCM Settings diff --git a/docs/input/docs/reference/build-servers/myget.md b/docs/input/docs/reference/build-servers/myget.md index f339a4aad6..ac96fee925 100644 --- a/docs/input/docs/reference/build-servers/myget.md +++ b/docs/input/docs/reference/build-servers/myget.md @@ -2,6 +2,7 @@ Order: 70 Title: MyGet Description: Details on the MyGet support in GitVersion +RedirectFrom: docs/build-server-support/build-server/myget --- MyGet Build Services has built-in support for GitVersion and is encouraging you diff --git a/docs/input/docs/reference/build-servers/octopus-deploy.md b/docs/input/docs/reference/build-servers/octopus-deploy.md index f47472492d..10c2682680 100644 --- a/docs/input/docs/reference/build-servers/octopus-deploy.md +++ b/docs/input/docs/reference/build-servers/octopus-deploy.md @@ -2,6 +2,7 @@ Order: 80 Title: Octopus Deploy Description: Details on the Octopus Deploy support in GitVersion +RedirectFrom: docs/build-server-support/build-server/octopus-deploy --- While not a build server, there are a few things to consider when using Octopus diff --git a/docs/input/docs/reference/build-servers/teamcity.md b/docs/input/docs/reference/build-servers/teamcity.md index 989fb36383..130f8d66d2 100644 --- a/docs/input/docs/reference/build-servers/teamcity.md +++ b/docs/input/docs/reference/build-servers/teamcity.md @@ -2,6 +2,7 @@ Order: 90 Title: TeamCity Description: Details on the TeamCity support in GitVersion +RedirectFrom: docs/build-server-support/build-server/teamcity --- ## Basic Usage diff --git a/docs/input/docs/reference/configuration.md b/docs/input/docs/reference/configuration.md index d7c6af93e0..935828188b 100644 --- a/docs/input/docs/reference/configuration.md +++ b/docs/input/docs/reference/configuration.md @@ -2,6 +2,7 @@ Order: 10 Title: Configuration Description: Details about how GitVersion can be configured to suit your needs +RedirectFrom: docs/configuration --- GitVersion from version 3 is mainly powered by configuration and no longer has diff --git a/docs/input/docs/reference/modes/continuous-delivery.md b/docs/input/docs/reference/modes/continuous-delivery.md index 5025232ffa..8d321a2dcb 100644 --- a/docs/input/docs/reference/modes/continuous-delivery.md +++ b/docs/input/docs/reference/modes/continuous-delivery.md @@ -5,6 +5,7 @@ Description: | Continuous Delivery is the default versioning mode. In this mode, GitVersion calculates the next version and will use that until that is released. +RedirectFrom: docs/reference/versioning-modes/continuous-delivery --- Continuous Delivery is the practice of having a deployment pipeline and is the diff --git a/docs/input/docs/reference/modes/continuous-deployment.md b/docs/input/docs/reference/modes/continuous-deployment.md index 7e99e0d9aa..b6513ee8c4 100644 --- a/docs/input/docs/reference/modes/continuous-deployment.md +++ b/docs/input/docs/reference/modes/continuous-deployment.md @@ -4,6 +4,7 @@ Title: Continuous Deployment Description: | Sometimes you just want the version to keep changing and deploy continuously. In this case, Continuous Deployment is a good mode to operate GitVersion by. +RedirectFrom: docs/reference/versioning-modes/continuous-deployment --- Continuous Deployment is the process of checking into main, running all the diff --git a/docs/input/docs/reference/modes/index.cshtml b/docs/input/docs/reference/modes/index.cshtml index e83af72172..a0a8e8bb49 100644 --- a/docs/input/docs/reference/modes/index.cshtml +++ b/docs/input/docs/reference/modes/index.cshtml @@ -2,6 +2,7 @@ Order: 50 Title: Versioning Modes Description: The different modes of versioning GitVersion supports +RedirectFrom: docs/reference/versioning-modes/versioning-mode ---

diff --git a/docs/input/docs/reference/modes/mainline.md b/docs/input/docs/reference/modes/mainline.md index bce2481731..47980b13b7 100644 --- a/docs/input/docs/reference/modes/mainline.md +++ b/docs/input/docs/reference/modes/mainline.md @@ -5,6 +5,7 @@ Description: | Mainline Development versioning mode works like the Continuous Delivery, except that it tells GitVersion to *infer* releases from merges and commits to `main`. +RedirectFrom: docs/reference/versioning-modes/mainline-development --- Mainline Development is enabled when using [GitHubFlow][githubflow] or any other diff --git a/docs/input/docs/reference/variables.md b/docs/input/docs/reference/variables.md index d347bd54af..80615bc835 100644 --- a/docs/input/docs/reference/variables.md +++ b/docs/input/docs/reference/variables.md @@ -2,6 +2,7 @@ Order: 20 Title: Version Variables Description: The version variables exposed by GitVersion +RedirectFrom: docs/more-info/variables --- Version variables are quite useful if you need different formats of the version diff --git a/docs/input/docs/reference/version-increments.md b/docs/input/docs/reference/version-increments.md index d8cf337ca8..d68d1cdad3 100644 --- a/docs/input/docs/reference/version-increments.md +++ b/docs/input/docs/reference/version-increments.md @@ -2,6 +2,9 @@ Order: 40 Title: Version Incrementing Description: Details on how GitVersion performs version increments +RedirectFrom: +- docs/more-info/incrementing-per-commit +- docs/more-info/version-increments --- Because GitVersion works with several workflows, the way it does its version diff --git a/docs/input/docs/reference/version-sources.md b/docs/input/docs/reference/version-sources.md index 9a475f7992..e58b7c4beb 100644 --- a/docs/input/docs/reference/version-sources.md +++ b/docs/input/docs/reference/version-sources.md @@ -2,6 +2,7 @@ Order: 50 Title: Version Sources Description: Details on how GitVersion finds a source for its generated version number +RedirectFrom: docs/more-info/version-sources --- GitVersion has a two step process for calculating the version number. First it diff --git a/docs/input/docs/usage/cli/index.cshtml b/docs/input/docs/usage/cli/index.cshtml index c166e122aa..ae887aa492 100644 --- a/docs/input/docs/usage/cli/index.cshtml +++ b/docs/input/docs/usage/cli/index.cshtml @@ -5,6 +5,7 @@ Description: | The Command Line gives most flexibility by allowing the execution of GitVersion to be customized CardIcon: terminal.svg +RedirectFrom: docs/usage/command-line ---

diff --git a/docs/input/docs/usage/index.cshtml b/docs/input/docs/usage/index.cshtml index d7380af3ac..60336a77e3 100644 --- a/docs/input/docs/usage/index.cshtml +++ b/docs/input/docs/usage/index.cshtml @@ -4,6 +4,9 @@ Description: | There are four different ways to consume GitVersion itself. You can find each of these options below. Order: 1 +RedirectFrom: +- docs/usage/gem +- docs/usage/usage ---

@Html.Raw(Model.String(DocsKeys.Description))

diff --git a/docs/input/docs/usage/library.md b/docs/input/docs/usage/library.md index 4b6e1d4bd6..cec061ecdb 100644 --- a/docs/input/docs/usage/library.md +++ b/docs/input/docs/usage/library.md @@ -6,6 +6,7 @@ Description: | is an unsupported option and the API may break even between minor or patch releases, it's a useful option to some. CardIcon: library.svg +RedirectFrom: docs/usage/nuget-library --- Install with NuGet and use GitVersion as a software library. Although this diff --git a/docs/input/docs/usage/msbuild.md b/docs/input/docs/usage/msbuild.md index 29dd1e7614..a23e899934 100644 --- a/docs/input/docs/usage/msbuild.md +++ b/docs/input/docs/usage/msbuild.md @@ -5,6 +5,7 @@ Description: | Just install with NuGet and GitVersion will automatically generate assembly version information that is compiled into the resulting artifact. CardIcon: collect.svg +RedirectFrom: docs/usage/msbuild-task --- The MSBuild Task for GitVersion — **GitVersion.MsBuild** — is a simple solution if