diff --git a/assets/images/help/docs/header-dotcom.png b/assets/images/help/docs/header-dotcom.png new file mode 100644 index 0000000000..a1bc7e4fbf Binary files /dev/null and b/assets/images/help/docs/header-dotcom.png differ diff --git a/assets/images/help/docs/header-ghae.png b/assets/images/help/docs/header-ghae.png new file mode 100644 index 0000000000..ba71e27507 Binary files /dev/null and b/assets/images/help/docs/header-ghae.png differ diff --git a/assets/images/help/docs/header-ghes.png b/assets/images/help/docs/header-ghes.png new file mode 100644 index 0000000000..57e38e27d5 Binary files /dev/null and b/assets/images/help/docs/header-ghes.png differ diff --git a/assets/images/help/docs/version-picker.png b/assets/images/help/docs/version-picker.png new file mode 100644 index 0000000000..24b0bfb13b Binary files /dev/null and b/assets/images/help/docs/version-picker.png differ diff --git a/content/admin/overview/about-github-ae.md b/content/admin/overview/about-github-ae.md index 3e100a82a9..62d5fcf17b 100644 --- a/content/admin/overview/about-github-ae.md +++ b/content/admin/overview/about-github-ae.md @@ -37,4 +37,5 @@ Secure access to your enterprise on {% data variables.product.prodname_ghe_manag ## Further reading +- "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)" - "[Receiving help from {% data variables.product.company_short %} Support](/admin/enterprise-support/receiving-help-from-github-support)" diff --git a/content/get-started/index.md b/content/get-started/index.md index 8917ef270e..8131599b42 100644 --- a/content/get-started/index.md +++ b/content/get-started/index.md @@ -37,6 +37,7 @@ featuredLinks: - /github/getting-started-with-github/signing-up-for-a-new-github-account - /get-started/quickstart/hello-world - /github/getting-started-with-github/set-up-git + - /get-started/learning-about-github/about-versions-of-github-docs - /github/getting-started-with-github/github-glossary - /github/getting-started-with-github/fork-a-repo - /github/getting-started-with-github/keyboard-shortcuts diff --git a/content/get-started/learning-about-github/about-versions-of-github-docs.md b/content/get-started/learning-about-github/about-versions-of-github-docs.md new file mode 100644 index 0000000000..71486683c9 --- /dev/null +++ b/content/get-started/learning-about-github/about-versions-of-github-docs.md @@ -0,0 +1,56 @@ +--- +title: About versions of GitHub Docs +intro: "You can read documentation that reflects the {% data variables.product.company_short %} product you're currently using." +versions: '*' +shortTitle: Docs versions +--- + +## About versions of {% data variables.product.prodname_docs %} + +{% 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)." + +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. + +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. + +![Screenshot of the dropdown menu for picking a version of {% data variables.product.prodname_docs %} to view](/assets/images/help/docs/version-picker.png) + +{% note %} + +**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. + +{% endnote %} + +## Determining which {% data variables.product.company_short %} product you use + +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. + +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. + +### {% data variables.product.prodname_dotcom_the_website %} plans or {% data variables.product.prodname_ghe_cloud %} + +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 %}. + +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. + +![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) + +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)." + +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)." + +### {% data variables.product.prodname_ghe_server %} + +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 %}." + +In a wide browser window, the word "Enterprise" immediately follows the {% data variables.product.company_short %} logo on the left side of the header. + +![Screenshot of address bar and {% data variables.product.prodname_ghe_server %} header in a browser](/assets/images/help/docs/header-ghes.png) + +### {% data variables.product.prodname_ghe_managed %} + +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 %}. + +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. + +![Address bar and {% data variables.product.prodname_ghe_managed %} header in a browser](/assets/images/help/docs/header-ghae.png) diff --git a/content/get-started/learning-about-github/githubs-products.md b/content/get-started/learning-about-github/githubs-products.md index c5927d487d..a45107bd4c 100644 --- a/content/get-started/learning-about-github/githubs-products.md +++ b/content/get-started/learning-about-github/githubs-products.md @@ -24,6 +24,8 @@ topics: You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %} +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)." + ## {% data variables.product.prodname_free_user %} for user accounts 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. diff --git a/content/get-started/learning-about-github/index.md b/content/get-started/learning-about-github/index.md index 32d67d6de5..5861d232ae 100644 --- a/content/get-started/learning-about-github/index.md +++ b/content/get-started/learning-about-github/index.md @@ -17,10 +17,11 @@ topics: - Security children: - /githubs-products + - /about-versions-of-github-docs - /github-language-support - - /about-github-advanced-security - /types-of-github-accounts - /access-permissions-on-github + - /about-github-advanced-security - /faq-about-changes-to-githubs-plans --- diff --git a/content/get-started/onboarding/getting-started-with-github-ae.md b/content/get-started/onboarding/getting-started-with-github-ae.md index 34adcc9fcb..013ac1a1af 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -73,8 +73,11 @@ For more information on enabling and configuring {% data variables.product.prodn ## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources 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. -### 1. Learning with {% data variables.product.prodname_learning %} +### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} +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)." + +### 2. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support +### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index d8227e1740..9598e02d65 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -199,14 +199,18 @@ Members of your organization or enterprise can use tools from the {% data variab ## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community Members of your organization or enterprise can use GitHub's learning and support resources to get the help they need. You can also support the open source community. -### 1. Learning with {% data variables.product.prodname_learning %} + +### 1. Reading about {% data variables.product.prodname_ghe_cloud %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} Members of your organization or enterprise can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by the friendly Learning Lab bot. For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." -### 2. Supporting the open source community +### 3. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 3. Contacting {% data variables.contact.github_support %} +### 4. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% data variables.product.prodname_ghe_cloud %} allows you to submit priority support requests with a target eight-hour response time. For more information, see "[{% data variables.product.prodname_ghe_cloud %} support](/github/working-with-github-support/github-enterprise-cloud-support)." diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-server.md b/content/get-started/onboarding/getting-started-with-github-enterprise-server.md index 6022968de4..4637e3b623 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-server.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-server.md @@ -114,7 +114,13 @@ If you are the owner of both a {% data variables.product.product_name %} instanc ## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources 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 when setting up and managing {% data variables.product.product_location %} with {% data variables.product.prodname_dotcom %} Enterprise Support. -### 1. Learning with {% data variables.product.prodname_learning %} + +### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} + +You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_server %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 2. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab-enterprise %} -### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support + +### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data reusables.getting-started.contact-support-enterprise %} diff --git a/content/get-started/onboarding/getting-started-with-github-team.md b/content/get-started/onboarding/getting-started-with-github-team.md index f98c11638d..27e6ee5e6a 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -83,13 +83,16 @@ You can help to make your organization more secure by recommending or requiring ### 2. Interacting with the {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Learning with {% data variables.product.prodname_learning %} +### 3. Reading about {% data variables.product.prodname_team %} on {% data variables.product.prodname_docs %} +You can read documentation that reflects the features available with {% data variables.product.prodname_team %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." + +### 4. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -### 4. Supporting the open source community +### 5. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. Contacting {% data variables.contact.github_support %} +### 6. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} ## Further reading diff --git a/content/get-started/onboarding/getting-started-with-your-github-account.md b/content/get-started/onboarding/getting-started-with-your-github-account.md index 8c5c1036a1..245a75c61f 100644 --- a/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -182,14 +182,18 @@ For more information, see "[Securing your software supply chain](/code-security/ ### 2. Interacting with {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### 3. Learning with {% data variables.product.prodname_learning %} +### 3. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %} + +{% data reusables.docs.you-can-read-docs-for-your-product %} + +### 4. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} {% ifversion fpt or ghec %} -### 4. Supporting the open source community +### 5. Supporting the open source community {% data reusables.getting-started.sponsors %} -### 5. Contacting {% data variables.contact.github_support %} +### 6. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% ifversion fpt %} diff --git a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index 0a60c0a9d2..f5c9633c79 100644 --- a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -56,6 +56,8 @@ Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/). +{% data reusables.docs.you-can-read-docs-for-your-product %} + {% data reusables.products.product-roadmap %} ## Finishing your trial diff --git a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md index 6b47866c00..1328f54580 100644 --- a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md +++ b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md @@ -41,6 +41,7 @@ To get the most out of your trial, follow these steps: - [Quick start guide to {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast - [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides - [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides + - "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)" 3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)." 4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[Using SAML](/enterprise-server@latest/admin/user-management/using-saml)" and "[Using LDAP](/enterprise-server@latest/admin/authentication/using-ldap)." 5. Invite an unlimited number of people to join your trial. diff --git a/data/reusables/docs/you-can-read-docs-for-your-product.md b/data/reusables/docs/you-can-read-docs-for-your-product.md new file mode 100644 index 0000000000..8de7a8d98f --- /dev/null +++ b/data/reusables/docs/you-can-read-docs-for-your-product.md @@ -0,0 +1 @@ +You can read documentation that reflects the features available to you on {% data variables.product.product_name %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." diff --git a/data/variables/product.yml b/data/variables/product.yml index 507d01f637..57db972f55 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -22,6 +22,7 @@ prodname_ghe_server: 'GitHub Enterprise Server' prodname_ghe_cloud: 'GitHub Enterprise Cloud' prodname_ghe_managed: 'GitHub AE' prodname_ghe_one: 'GitHub One' +prodname_docs: 'GitHub Docs' ## Use these variables when referring specifically to a location within a product product_location: >- diff --git a/tests/content/featured-links.js b/tests/content/featured-links.js index d5af4508a9..9a4b03cb32 100644 --- a/tests/content/featured-links.js +++ b/tests/content/featured-links.js @@ -64,7 +64,7 @@ describe('featuredLinks', () => { test('Enterprise user intro links have expected values', async () => { const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/get-started`) const $featuredLinks = $('[data-testid=article-list] a') - expect($featuredLinks).toHaveLength(10) + expect($featuredLinks).toHaveLength(11) expect($featuredLinks.eq(0).attr('href')).toBe( `/en/enterprise-server@${enterpriseServerReleases.latest}/github/getting-started-with-github/githubs-products` )