Skip to content

Commit 0744800

Browse files
authored
Document version picker for GitHub Docs (#23703)
1 parent fceb34d commit 0744800

19 files changed

Lines changed: 101 additions & 15 deletions
100 KB
Loading
107 KB
Loading
108 KB
Loading
86 KB
Loading

content/admin/overview/about-github-ae.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,5 @@ Secure access to your enterprise on {% data variables.product.prodname_ghe_manag
3737

3838
## Further reading
3939

40+
- "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)"
4041
- "[Receiving help from {% data variables.product.company_short %} Support](/admin/enterprise-support/receiving-help-from-github-support)"

content/get-started/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ featuredLinks:
3737
- /github/getting-started-with-github/signing-up-for-a-new-github-account
3838
- /get-started/quickstart/hello-world
3939
- /github/getting-started-with-github/set-up-git
40+
- /get-started/learning-about-github/about-versions-of-github-docs
4041
- /github/getting-started-with-github/github-glossary
4142
- /github/getting-started-with-github/fork-a-repo
4243
- /github/getting-started-with-github/keyboard-shortcuts
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: About versions of GitHub Docs
3+
intro: "You can read documentation that reflects the {% data variables.product.company_short %} product you're currently using."
4+
versions: '*'
5+
shortTitle: Docs versions
6+
---
7+
8+
## About versions of {% data variables.product.prodname_docs %}
9+
10+
{% data variables.product.company_short %} offers different products for storing and collaborating on code. The product you use determines which features are available to you. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)."
11+
12+
This website, {% data variables.product.prodname_docs %}, provides documentation for all of {% data variables.product.company_short %}'s products. If the content you're reading applies to more than one product, you can choose the version of the documentation that's relevant to you by selecting the product you're currently using.
13+
14+
At the top of a page on {% data variables.product.prodname_docs %}, select the dropdown menu and click a product. If your browser window is not wide enough to display the full navigation bar, you may need to click {% octicon "three-bars" aria-label="The three bars icon" %} first.
15+
16+
![Screenshot of the dropdown menu for picking a version of {% data variables.product.prodname_docs %} to view](/assets/images/help/docs/version-picker.png)
17+
18+
{% note %}
19+
20+
**Note**: You can try changing the version now. You're viewing {% ifversion ghes %}a{% else %}the{% endif %} {% ifversion fpt %}Free, Pro, & Team{% else %}{% data variables.product.product_name %}{% endif %} version of this article.
21+
22+
{% endnote %}
23+
24+
## Determining which {% data variables.product.company_short %} product you use
25+
26+
You can determine which {% data variables.product.company_short %} product you're currently using by reviewing the URL in the address bar of your browser and the heading for the {% data variables.product.prodname_dotcom %} website you're on.
27+
28+
You may use more than one {% data variables.product.company_short %} product. For example, you might contribute to open source on {% data variables.product.prodname_dotcom_the_website %} and collaborate on code on your employer's {% data variables.product.prodname_ghe_server %} instance. You may need to view different versions of the same article at different times, depending on the problem you're currently trying to solve.
29+
30+
### {% data variables.product.prodname_dotcom_the_website %} plans or {% data variables.product.prodname_ghe_cloud %}
31+
32+
If you access {% data variables.product.prodname_dotcom %} at https://github.com, you're either using the features of a Free, Pro, or Team plan, or you're using {% data variables.product.prodname_ghe_cloud %}.
33+
34+
In a wide browser window, there is no text that immediately follows the {% data variables.product.company_short %} logo on the left side of the header.
35+
36+
![Screenshot of the address bar and the {% data variables.product.prodname_dotcom_the_website %} header in a browser](/assets/images/help/docs/header-dotcom.png)
37+
38+
On {% data variables.product.prodname_dotcom_the_website %}, each account has its own plan. Each personal account has an associated plan that provides access to certain features, and each organization has a different associated plan. If your personal account is a member of an organization on {% data variables.product.prodname_dotcom_the_website %}, you may have access to different features when you use resources owned by that organization than when you use resources owned by your personal account. For more information, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)."
39+
40+
If you don't know whether an organization uses {% data variables.product.prodname_ghe_cloud %}, ask an organization owner. For more information, see "[Viewing people's roles in an organization](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization)."
41+
42+
### {% data variables.product.prodname_ghe_server %}
43+
44+
If you access {% data variables.product.prodname_dotcom %} at a URL other than https://github.com, `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_server %}. For example, you may access {% data variables.product.prodname_ghe_server %} at `https://github.YOUR-COMPANY-NAME.com`. Your administrators may choose a URL that doesn't include the word "{% data variables.product.company_short %}."
45+
46+
In a wide browser window, the word "Enterprise" immediately follows the {% data variables.product.company_short %} logo on the left side of the header.
47+
48+
![Screenshot of address bar and {% data variables.product.prodname_ghe_server %} header in a browser](/assets/images/help/docs/header-ghes.png)
49+
50+
### {% data variables.product.prodname_ghe_managed %}
51+
52+
If you access {% data variables.product.prodname_dotcom %} at `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_managed %}.
53+
54+
In a wide browser window, the words "{% data variables.product.prodname_ghe_managed %}" immediately follow the {% data variables.product.company_short %} logo in the header.
55+
56+
![Address bar and {% data variables.product.prodname_ghe_managed %} header in a browser](/assets/images/help/docs/header-ghae.png)

content/get-started/learning-about-github/githubs-products.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ topics:
2424

2525
You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %}
2626

27+
When you read {% data variables.product.prodname_docs %}, make sure to select the version that reflects your product. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
28+
2729
## {% data variables.product.prodname_free_user %} for user accounts
2830

2931
With {% data variables.product.prodname_free_team %} for user accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set.

content/get-started/learning-about-github/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ topics:
1717
- Security
1818
children:
1919
- /githubs-products
20+
- /about-versions-of-github-docs
2021
- /github-language-support
21-
- /about-github-advanced-security
2222
- /types-of-github-accounts
2323
- /access-permissions-on-github
24+
- /about-github-advanced-security
2425
- /faq-about-changes-to-githubs-plans
2526
---
2627

content/get-started/onboarding/getting-started-with-github-ae.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,11 @@ For more information on enabling and configuring {% data variables.product.prodn
7373
## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources
7474
Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need with {% data variables.product.prodname_dotcom %} Enterprise Support.
7575

76-
### 1. Learning with {% data variables.product.prodname_learning %}
76+
### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %}
77+
You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_managed %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
78+
79+
### 2. Learning with {% data variables.product.prodname_learning %}
7780
{% data reusables.getting-started.learning-lab-enterprise %}
7881

79-
### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support
82+
### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support
8083
{% data reusables.getting-started.contact-support-enterprise %}

0 commit comments

Comments
 (0)