From 25b094ce5741c48b14e12652955e4b4e4655c600 Mon Sep 17 00:00:00 2001 From: Tom Dykstra Date: Fri, 9 Dec 2016 10:49:02 -0800 Subject: [PATCH 1/2] add redirect info --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 155d82c5de..cdfa1babba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,6 +106,18 @@ DocFX requires the .NET Framework on Windows, or Mono for Linux or macOS. * Run **docfx** in the `Docs\aspnetcore` directory to build the site, and **docfx-serve** to view the site at `http://localhost:8080`. +## Redirects + +If you delete an article, change its file name, or move it to a different folder, create a redirect so that people who bookmarked the article won't get 404s. To seet up a redirect, create a file that has the redirect target URL as shown below, and put it in the original file's location. + +``` +--- +redirect_url: /aspnet/core/location-of-target-for-redirect +--- +``` + +For an example, see the [redirect file](https://github.com/aspnet/Docs/blob/master/aspnetcore/security/authentication/sociallogins.md) that redirects `/security/authentication/sociallogins` to `/security/authentication/social/index`. + ## Voice and tone Our goal is to write documentation that is easily understandable by the widest possible audience. To that end we have established guidelines for writing style that we ask our contributors to follow. For more information, see [Voice and tone guidelines](https://github.com/dotnet/docs/blob/master/styleguide/voice-tone.md) in the .NET Core repo. From d045a4d7cd01ff4fda5065118665ef3cc858d945 Mon Sep 17 00:00:00 2001 From: Tom Dykstra Date: Fri, 9 Dec 2016 11:21:20 -0800 Subject: [PATCH 2/2] move redirects to end --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdfa1babba..f734f3f06f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,6 +106,10 @@ DocFX requires the .NET Framework on Windows, or Mono for Linux or macOS. * Run **docfx** in the `Docs\aspnetcore` directory to build the site, and **docfx-serve** to view the site at `http://localhost:8080`. +## Voice and tone + +Our goal is to write documentation that is easily understandable by the widest possible audience. To that end we have established guidelines for writing style that we ask our contributors to follow. For more information, see [Voice and tone guidelines](https://github.com/dotnet/docs/blob/master/styleguide/voice-tone.md) in the .NET Core repo. + ## Redirects If you delete an article, change its file name, or move it to a different folder, create a redirect so that people who bookmarked the article won't get 404s. To seet up a redirect, create a file that has the redirect target URL as shown below, and put it in the original file's location. @@ -117,7 +121,3 @@ redirect_url: /aspnet/core/location-of-target-for-redirect ``` For an example, see the [redirect file](https://github.com/aspnet/Docs/blob/master/aspnetcore/security/authentication/sociallogins.md) that redirects `/security/authentication/sociallogins` to `/security/authentication/social/index`. - -## Voice and tone - -Our goal is to write documentation that is easily understandable by the widest possible audience. To that end we have established guidelines for writing style that we ask our contributors to follow. For more information, see [Voice and tone guidelines](https://github.com/dotnet/docs/blob/master/styleguide/voice-tone.md) in the .NET Core repo.