Skip to content

Commit

Permalink
update contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahs committed Jan 15, 2021
1 parent b3a2ea4 commit af41e4a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion contributing/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions contributing/permalinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ 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/[email protected]/github/getting-started-with-github/set-up-git`
* `/en/[email protected]/github/getting-started-with-github/set-up-git`
* `/en/[email protected]/github/getting-started-with-github/set-up-git`
* `/en/[email protected]/github/getting-started-with-github/set-up-git`

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:

Expand Down

0 comments on commit af41e4a

Please sign in to comment.