From af41e4ad05454a3f9461637347787f9ca618f509 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Fri, 15 Jan 2021 11:56:10 -0500 Subject: [PATCH] update contributing docs --- contributing/development.md | 2 +- contributing/permalinks.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/contributing/development.md b/contributing/development.md index 439e75d8c5ab..3187272a29ce 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -48,7 +48,7 @@ For more detailed instructions, please see this [VS Code recipe](https://github. While running the local server, you can visit [localhost:4000/dev-toc](http://localhost:4000/dev-toc) to view a top-level TOC of all the content in the site. This page is not available on https://docs.github.com. It was created for internal GitHub writers' use. -At the `/dev-toc` path, you'll see a list of available versions. Click a version, and a list of products will appear. Note that the TOC content is versioned. If you are viewing `free-pro-team@latest` and you click the `Enterprise Admin` product, it will be empty, because there isn't any Admin content available on that version. +At the `/dev-toc` path, you'll see a list of available versions. Click a version, and a list of products will appear. Note that the TOC content is versioned. If you are viewing the `GitHub.com` version and you click the `Enterprise Admin` product, it will be empty, because there isn't any Admin content available on that version. ## Site structure diff --git a/contributing/permalinks.md b/contributing/permalinks.md index f4c1a8532d7b..634990eb2308 100644 --- a/contributing/permalinks.md +++ b/contributing/permalinks.md @@ -4,7 +4,7 @@ Because the site is dynamic, it does not build HTML files for each different ver For example, an article that is available in currently supported versions will have permalink URLs like the following: -* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git` +* `/en/github/getting-started-with-github/set-up-git` * `/en/enterprise-server@2.22/github/getting-started-with-github/set-up-git` * `/en/enterprise-server@2.21/github/getting-started-with-github/set-up-git` * `/en/enterprise-server@2.20/github/getting-started-with-github/set-up-git` @@ -12,7 +12,7 @@ For example, an article that is available in currently supported versions will h An article that is not available in Enterprise will have just one permalink: -* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git` +* `/en/github/getting-started-with-github/set-up-git` **If you are a content contributor:** You don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article you can just use its relative location: