From bf0cc9528db0b29c424133e62424c7383c6b7f53 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Thu, 3 Jun 2021 13:04:05 -0400 Subject: [PATCH 01/52] created onboarding folder and end-user article file --- .../getting-started-with-your-github-account | 153 ++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account new file mode 100644 index 0000000000..27be8de7cb --- /dev/null +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account @@ -0,0 +1,153 @@ +--- +title: Getting started with your user account +intro: 'You can configure the different settings in your user account to best suit your needs.' +productVersions: + dotcom: '*' + enterprise: '*' +--- + +### Part 1: Configuring your {{ site.data.variables.product.product_name }} account + +There are several types of accounts on {{ site.data.variables.product.product_name }}. Every person who uses {{ site.data.variables.product.product_location }} has their own user account, which can be part of many organizations and teams. Your user account is your identity on {{ site.data.variables.product.product_location }} and represents you as an individual. + +#### Creating an account +To sign up for a {{ site.data.variables.product.product_name }} account, navigate to https://github.com/ and follow the prompts. + +To keep your {{ site.data.variables.product.product_name }} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). + +{{#note}} + +**Note**: Changing your {{ site.data.variables.product.product_name }} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your GitHub username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." + +{{/note}} + +{% if page.version == 'dotcom' %} +#### Choosing your {{ site.data.variables.product.product_name }} product +{{ site.data.variables.product.prodname_dotcom }} offers both free and paid products, each with a different set of features. {{ site.data.variables.product.prodname_free_user }} and {{ site.data.variables.product.prodname_pro }} offer features for individual users. {{ site.data.variables.product.prodname_team_os }} and {{ site.data.variables.product.prodname_team }} offer collaboration and management tools for teams. {{ site.data.variables.product.prodname_enterprise }} offers security, compliance, and deployment controls for organizations. + +For more information, see "[GitHub's products](/github/getting-started-with-github/githubs-products)." +{% endif %} + +{% if page.version == 'dotcom' %} +#### Verifying your email address +To ensure you can use all of {{ site.data.variables.product.product_name }}'s features, verify your email address after signing up for a new account. + +For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." +{% endif %} + +#### Configuring two-factor authentication +Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. + +{{#note}} + +**Note**: When you configure two-factor authentication, download and save your 2FA recovery codes with your password manager. If you lose access to your phone, you can authenticate to {{ site.data.variables.product.product_name }} using your recovery codes. + +{{/note}} + +For more information, see "[About two-factor authentication](/github/authenticating-to-github/about-two-factor-authentication)." + +#### Viewing your {{ site.data.variables.product.product_name }} profile and contribution graph +Your {{ site.data.variables.product.product_name }} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/about-your-profile)." + +Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile)." + +### Part 2: Using tools and processes with {{ site.data.variables.product.product_name }} +To best use {{ site.data.variables.product.product_name }}, you'll need to set up Git. Git is responsible for everything GitHub-related that happens locally on your computer. To effectively collaborate on {{ site.data.variables.product.prodname_dotcom_the_website }}, you'll write in issues and pull requests using {{ site.data.variables.product.product_name }} Flavored Markdown. + +#### Learning Git +{{ site.data.variables.product.product_name }}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {{ site.data.variables.product.product_name }}, see “[Understanding the GitHub flow](https://guides.github.com/introduction/flow/)." + +#### Setting up and using Git with {{ site.data.variables.product.prodname_desktop }} +{{ site.data.variables.product.prodname_desktop }} extends and simplifies your GitHub.com workflow, using a visual interface instead of text commands on the command line. + +After downloading {{ site.data.variables.product.prodname_desktop }} and signing into {{ site.data.variables.product.prodname_dotcom }}, you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {{ site.data.variables.product.prodname_dotcom }}, including installing an editor, creating a branch, making a commit, pushing to {{ site.data.variables.product.prodname_dotcom_the_website }}, and creating a pull request. + +For more information, see “[Creating your first repository using GitHub Desktop](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)." + +#### Setting up and using Git on the command line +To use Git on the command line, you'll need to download, install, and configure Git on your computer. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." + +When you connect to a {{ site.data.variables.product.product_name }} repository from Git, you'll need to authenticate with {{ site.data.variables.product.product_name }} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/using-git/about-remote-repositories)." + +You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." + +#### Writing on {{ site.data.variables.product.product_name }} +To make your communication clear and organized in issues and pull requests, you can use {{ site.data.variables.product.product_name }} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {{ site.data.variables.product.product_name }}](/github/writing-on-github/about-writing-and-formatting-on-github)." + +You can learn {{ site.data.variables.product.product_name }} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {{ site.data.variables.product.prodname_learning }}. + +### Part 3: Collaborating on {{ site.data.variables.product.product_name }} +Any number of people can work together in repositories across {{ site.data.variables.product.product_name }}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. + +#### Creating a repository +A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." + +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." + +#### Importing your projects +If you have existing projects you'd like to move over to {{ site.data.variables.product.product_name }} you can import projects using the {{ site.data.variables.product.product_name }} Importer, the command line, or external migration tools. For more information, see “[Importing source code to GitHub](/github/importing-your-projects-to-github/importing-source-code-to-github)." + +#### Managing collaborators and permissions +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." + +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)." + +#### Managing repository settings +As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." + +#### Setting up your project for healthy contributions +To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. + +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)." + +You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](github/building-a-strong-community/about-community-profiles-for-public-repositories)." + +{% if page.version == 'dotcom' %} +#### Managing security vulnerabilities +You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {{ site.data.variables.product.prodname_security_advisories }}. For more information, see “[Managing security vulnerabilities in your project +](/github/managing-security-vulnerabilities/managing-security-vulnerabilities-in-your-project)." +{% endif %} + +#### Managing project boards +You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." + +#### Managing notifications +Notifications provide updates about the activity on {{ site.data.variables.product.product_name }} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications)." + +#### Working with {{ site.data.variables.product.prodname_pages }} +You can use {{ site.data.variables.product.prodname_pages }} to create and host a website directly from a {{ site.data.variables.product.product_name }} repository. For more information, see “[Working with {{ site.data.variables.product.prodname_pages }}](/github/working-with-github-pages)." + +### Part 4: Customizing and automating your work on {{ site.data.variables.product.product_name }} +{{ site.data.reusables.getting-started.customizing-and-automating }} + +{{ site.data.reusables.getting-started.marketplace }} + +{{ site.data.reusables.getting-started.api }} + +{{ site.data.reusables.getting-started.actions }} + +{% if page.version == 'dotcom' %} +{{ site.data.reusables.getting-started.packages }} +{% endif %} + +### Part 5: Participating in {{ site.data.variables.product.prodname_dotcom }}'s community +{{ site.data.reusables.getting-started.participating-in-community }} + +{{ site.data.reusables.getting-started.open-source-projects }} + +{% if page.version == 'dotcom' %} +{{ site.data.reusables.getting-started.sponsors }} + +{{ site.data.reusables.getting-started.contact-support }} +{% endif %} + +#### Interacting with the {{ site.data.variables.product.prodname_gcf }} +{{ site.data.reusables.support.ask-and-answer-forum }} + +{{ site.data.reusables.getting-started.learning-lab }} + +{% if page.version == 'dotcom' %} +### Further reading +- "[Getting started with {{ site.data.variables.product.prodname_team }}](/github/getting-started-with-github/getting-started-with-github-team)" +- "[Getting started with {{ site.data.variables.product.prodname_ghe_cloud }}](/github/getting-started-with-github/getting-started-with-github-enterprise-cloud)" +{% endif %} \ No newline at end of file From 06d1b28eea4a29b64eac0dbbec7eeef629ecb826 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 9 Jun 2021 15:18:45 -0400 Subject: [PATCH 02/52] added onboarding page to getting-started landing page --- .../getting-started-with-github/index.md | 1 + .../getting-started-with-github-team.md | 99 +++++++++ .../getting-started-with-your-github-account | 153 -------------- ...etting-started-with-your-github-account.md | 188 ++++++++++++++++++ .../onboarding/index.md | 11 + 5 files changed, 299 insertions(+), 153 deletions(-) create mode 100644 content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md delete mode 100644 content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account create mode 100644 content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md create mode 100644 content/github/getting-started-with-github/onboarding/index.md diff --git a/content/github/getting-started-with-github/index.md b/content/github/getting-started-with-github/index.md index 77ef6d7e13..e5b9fc9d98 100644 --- a/content/github/getting-started-with-github/index.md +++ b/content/github/getting-started-with-github/index.md @@ -44,6 +44,7 @@ topics: - Accounts children: - /quickstart + - /onboarding - /learning-about-github - /signing-up-for-github - /using-github diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md new file mode 100644 index 0000000000..6d35963faa --- /dev/null +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md @@ -0,0 +1,99 @@ +--- +title: Getting started with GitHub Team +intro: 'With {{ site.data.variables.product.prodname_team }} groups of people can collaborate across many projects at the same time in an organization account.' +versions: + free-pro-team: '*' +--- + +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. + +### Part 1: Configuring your {{ site.data.variables.product.product_name }} account + + +#### Creating an organization, choosing GitHub Team as the product + + +#### About billing, managing billing, setting a billing manager, setting a billing email + + +#### About organizations + + +### Part 2: Adding members and setting up teams + + +#### Org-level permissions and roles + + +#### Managing users in the organization + + +#### About and creating teams + + +#### Managing team settings + + +#### Giving people and teams access to repos + + +### Part 3: Managing security for your organization + + +#### Recommending or requiring 2FA + + +#### Allowed IP addresses, approved domains for email addresses + + +#### Audit log, integrations + + +#### Security vulnerabilities in org-owned repos + + +### Part 4: Setting organization level policies + + +#### Link out to "Managing organization settings" for the full list, call out some helpful policies + + +#### Repos: Repo creation, visibility changes + + +#### Community: Org-level community health files, moderation tools + + +### Part 5: Customizing and automating your work on {{ site.data.variables.product.product_name }} +{{ site.data.reusables.getting-started.customizing-and-automating }} + +{{ site.data.reusables.getting-started.marketplace }} + +{{ site.data.reusables.getting-started.api }} + +{{ site.data.reusables.getting-started.actions }} + +{% if page.version == 'dotcom' %} +{{ site.data.reusables.getting-started.packages }} +{% endif %} + +### Part 6: Participating in {{ site.data.variables.product.prodname_dotcom }}'s community +{{ site.data.reusables.getting-started.participating-in-community }} + +{{ site.data.reusables.getting-started.open-source-projects }} + +{% if page.version == 'dotcom' %} +{{ site.data.reusables.getting-started.sponsors }} + +{{ site.data.reusables.getting-started.contact-support }} +{% endif %} + +#### Interacting with the {{ site.data.variables.product.prodname_gcf }} +{{ site.data.reusables.support.ask-and-answer-forum }} + +{{ site.data.reusables.getting-started.learning-lab }} + +{% if page.version == 'dotcom' %} +### Further reading +- "[Getting started with your GitHub account](/github/getting-started-with-github/onboarding/getting-started-with-your-github-account)" +{% endif %} \ No newline at end of file diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account deleted file mode 100644 index 27be8de7cb..0000000000 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Getting started with your user account -intro: 'You can configure the different settings in your user account to best suit your needs.' -productVersions: - dotcom: '*' - enterprise: '*' ---- - -### Part 1: Configuring your {{ site.data.variables.product.product_name }} account - -There are several types of accounts on {{ site.data.variables.product.product_name }}. Every person who uses {{ site.data.variables.product.product_location }} has their own user account, which can be part of many organizations and teams. Your user account is your identity on {{ site.data.variables.product.product_location }} and represents you as an individual. - -#### Creating an account -To sign up for a {{ site.data.variables.product.product_name }} account, navigate to https://github.com/ and follow the prompts. - -To keep your {{ site.data.variables.product.product_name }} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). - -{{#note}} - -**Note**: Changing your {{ site.data.variables.product.product_name }} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your GitHub username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." - -{{/note}} - -{% if page.version == 'dotcom' %} -#### Choosing your {{ site.data.variables.product.product_name }} product -{{ site.data.variables.product.prodname_dotcom }} offers both free and paid products, each with a different set of features. {{ site.data.variables.product.prodname_free_user }} and {{ site.data.variables.product.prodname_pro }} offer features for individual users. {{ site.data.variables.product.prodname_team_os }} and {{ site.data.variables.product.prodname_team }} offer collaboration and management tools for teams. {{ site.data.variables.product.prodname_enterprise }} offers security, compliance, and deployment controls for organizations. - -For more information, see "[GitHub's products](/github/getting-started-with-github/githubs-products)." -{% endif %} - -{% if page.version == 'dotcom' %} -#### Verifying your email address -To ensure you can use all of {{ site.data.variables.product.product_name }}'s features, verify your email address after signing up for a new account. - -For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." -{% endif %} - -#### Configuring two-factor authentication -Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. - -{{#note}} - -**Note**: When you configure two-factor authentication, download and save your 2FA recovery codes with your password manager. If you lose access to your phone, you can authenticate to {{ site.data.variables.product.product_name }} using your recovery codes. - -{{/note}} - -For more information, see "[About two-factor authentication](/github/authenticating-to-github/about-two-factor-authentication)." - -#### Viewing your {{ site.data.variables.product.product_name }} profile and contribution graph -Your {{ site.data.variables.product.product_name }} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/about-your-profile)." - -Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile)." - -### Part 2: Using tools and processes with {{ site.data.variables.product.product_name }} -To best use {{ site.data.variables.product.product_name }}, you'll need to set up Git. Git is responsible for everything GitHub-related that happens locally on your computer. To effectively collaborate on {{ site.data.variables.product.prodname_dotcom_the_website }}, you'll write in issues and pull requests using {{ site.data.variables.product.product_name }} Flavored Markdown. - -#### Learning Git -{{ site.data.variables.product.product_name }}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {{ site.data.variables.product.product_name }}, see “[Understanding the GitHub flow](https://guides.github.com/introduction/flow/)." - -#### Setting up and using Git with {{ site.data.variables.product.prodname_desktop }} -{{ site.data.variables.product.prodname_desktop }} extends and simplifies your GitHub.com workflow, using a visual interface instead of text commands on the command line. - -After downloading {{ site.data.variables.product.prodname_desktop }} and signing into {{ site.data.variables.product.prodname_dotcom }}, you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {{ site.data.variables.product.prodname_dotcom }}, including installing an editor, creating a branch, making a commit, pushing to {{ site.data.variables.product.prodname_dotcom_the_website }}, and creating a pull request. - -For more information, see “[Creating your first repository using GitHub Desktop](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)." - -#### Setting up and using Git on the command line -To use Git on the command line, you'll need to download, install, and configure Git on your computer. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." - -When you connect to a {{ site.data.variables.product.product_name }} repository from Git, you'll need to authenticate with {{ site.data.variables.product.product_name }} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/using-git/about-remote-repositories)." - -You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." - -#### Writing on {{ site.data.variables.product.product_name }} -To make your communication clear and organized in issues and pull requests, you can use {{ site.data.variables.product.product_name }} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {{ site.data.variables.product.product_name }}](/github/writing-on-github/about-writing-and-formatting-on-github)." - -You can learn {{ site.data.variables.product.product_name }} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {{ site.data.variables.product.prodname_learning }}. - -### Part 3: Collaborating on {{ site.data.variables.product.product_name }} -Any number of people can work together in repositories across {{ site.data.variables.product.product_name }}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. - -#### Creating a repository -A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." - -When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." - -#### Importing your projects -If you have existing projects you'd like to move over to {{ site.data.variables.product.product_name }} you can import projects using the {{ site.data.variables.product.product_name }} Importer, the command line, or external migration tools. For more information, see “[Importing source code to GitHub](/github/importing-your-projects-to-github/importing-source-code-to-github)." - -#### Managing collaborators and permissions -You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." - -You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)." - -#### Managing repository settings -As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." - -#### Setting up your project for healthy contributions -To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. - -By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)." - -You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](github/building-a-strong-community/about-community-profiles-for-public-repositories)." - -{% if page.version == 'dotcom' %} -#### Managing security vulnerabilities -You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {{ site.data.variables.product.prodname_security_advisories }}. For more information, see “[Managing security vulnerabilities in your project -](/github/managing-security-vulnerabilities/managing-security-vulnerabilities-in-your-project)." -{% endif %} - -#### Managing project boards -You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." - -#### Managing notifications -Notifications provide updates about the activity on {{ site.data.variables.product.product_name }} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications)." - -#### Working with {{ site.data.variables.product.prodname_pages }} -You can use {{ site.data.variables.product.prodname_pages }} to create and host a website directly from a {{ site.data.variables.product.product_name }} repository. For more information, see “[Working with {{ site.data.variables.product.prodname_pages }}](/github/working-with-github-pages)." - -### Part 4: Customizing and automating your work on {{ site.data.variables.product.product_name }} -{{ site.data.reusables.getting-started.customizing-and-automating }} - -{{ site.data.reusables.getting-started.marketplace }} - -{{ site.data.reusables.getting-started.api }} - -{{ site.data.reusables.getting-started.actions }} - -{% if page.version == 'dotcom' %} -{{ site.data.reusables.getting-started.packages }} -{% endif %} - -### Part 5: Participating in {{ site.data.variables.product.prodname_dotcom }}'s community -{{ site.data.reusables.getting-started.participating-in-community }} - -{{ site.data.reusables.getting-started.open-source-projects }} - -{% if page.version == 'dotcom' %} -{{ site.data.reusables.getting-started.sponsors }} - -{{ site.data.reusables.getting-started.contact-support }} -{% endif %} - -#### Interacting with the {{ site.data.variables.product.prodname_gcf }} -{{ site.data.reusables.support.ask-and-answer-forum }} - -{{ site.data.reusables.getting-started.learning-lab }} - -{% if page.version == 'dotcom' %} -### Further reading -- "[Getting started with {{ site.data.variables.product.prodname_team }}](/github/getting-started-with-github/getting-started-with-github-team)" -- "[Getting started with {{ site.data.variables.product.prodname_ghe_cloud }}](/github/getting-started-with-github/getting-started-with-github-enterprise-cloud)" -{% endif %} \ No newline at end of file diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md new file mode 100644 index 0000000000..e562fda4be --- /dev/null +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md @@ -0,0 +1,188 @@ +--- +title: Getting started with your GitHub account +intro: 'You can configure the different settings in your user account to best suit your needs.' +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +--- + +### Part 1: Configuring your {% data variables.product.product_name %} account + +There are several types of accounts on {% data variables.product.product_name %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of many organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. + +#### Creating an account +To sign up for a {% data variables.product.product_name %} account, navigate to https://github.com/ and follow the prompts. + +To keep your {% data variables.product.product_name %} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). + +{% note %} + +**Note**: Changing your {% data variables.product.product_name %} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your GitHub username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." + +{% endnote %} + +{% if page.version == 'free-pro-team@latest' %} +#### Choosing your {% data variables.product.product_name %} product +{% data variables.product.prodname_dotcom %} offers both free and paid products, each with a different set of features. {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} offer features for individual users. {% data variables.product.prodname_team %} offers collaboration and management tools for teams. {% data variables.product.prodname_enterprise %} offers security, compliance, and deployment controls for organizations. + +For more information, see "[GitHub's products](/github/getting-started-with-github/githubs-products)." +{% endif %} + +{% if page.version == 'free-pro-team@latest' %} +#### Verifying your email address +To ensure you can use all of {% data variables.product.product_name %}'s features, verify your email address after signing up for a new account. + +For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." +{% endif %} + +#### Configuring two-factor authentication +Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. + +{% note %} + +**Note**: When you configure two-factor authentication, download and save your 2FA recovery codes with your password manager. If you lose access to your phone, you can authenticate to {% data variables.product.product_name %} using your recovery codes. + +{% endnote %} + +For more information, see "[About two-factor authentication](/github/authenticating-to-github/about-two-factor-authentication)." + +#### Viewing your {% data variables.product.product_name %} profile and contribution graph +Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/about-your-profile)." + +Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile)." + +### Part 2: Working with {% data variables.product.product_name %} +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything GitHub-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.product_name %} Flavored Markdown. + +#### Introduction to Git + +##### Learning Git +{% data variables.product.product_name %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[Understanding the GitHub flow](https://guides.github.com/introduction/flow/)." + +##### Setting up and using Git with {% data variables.product.prodname_desktop %} +{% data variables.product.prodname_desktop %} extends and simplifies your GitHub.com workflow, using a visual interface instead of text commands on the command line. + +After downloading {% data variables.product.prodname_desktop %} and signing into {% data variables.product.prodname_dotcom %}, you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {% data variables.product.prodname_dotcom %}, including installing an editor, creating a branch, making a commit, pushing to {% data variables.product.prodname_dotcom_the_website %}, and creating a pull request. + +For more information, see “[Creating your first repository using GitHub Desktop](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)." + +##### Setting up and using Git on the command line +To use Git on the command line, you'll need to download, install, and configure Git on your computer. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." + +When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/using-git/about-remote-repositories)." + +You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." + +[INFO ON AUTHENTICATION?] + +#### Ways of working with {% data variables.product.product_name %} + +There are multiple ways you can interact with GitHub - which one you use all depends on your preference and what you need. + +- In browser on GitHub.com +- Desktop +- IDE or File Editor +- Command line with or without Github CLI +- GitHub API + + +#### Writing on {% data variables.product.product_name %} +To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.product_name %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.product_name %}](/github/writing-on-github/about-writing-and-formatting-on-github)." + +You can learn {% data variables.product.product_name %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. + +#### Searching on {% data variables.product.product_name %} + +#### Managing files on {% data variables.product.product_name %} + + +### Part 3: Collaborating on {% data variables.product.product_name %} +Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. + +#### Working with repositories + +##### Creating a repository +A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." + +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." + +##### Cloning a repository + +##### Forking a repository + +#### Importing your projects +If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.product_name %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to GitHub](/github/importing-your-projects-to-github/importing-source-code-to-github)." + +#### Managing collaborators and permissions +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." + +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)." + +#### Managing repository settings +As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." + +#### Setting up your project for healthy contributions +To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. + +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)." + +You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](github/building-a-strong-community/about-community-profiles-for-public-repositories)." + +{% if page.version == 'free-pro-team@latest' %} +#### Managing security vulnerabilities +You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and CHECK WHAT THIS MEANS[site.data.variables.product.prodname_security_advisories]. For more information, see “[Managing security vulnerabilities in your project +](/github/managing-security-vulnerabilities/managing-security-vulnerabilities-in-your-project)." +{% endif %} + +#### Managing project boards +You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." + +#### Managing notifications +Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications)." + +#### Working with {% data variables.product.prodname_pages %} +You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[Working with {% data variables.product.prodname_pages %}](/github/working-with-github-pages)." + +#### Working with {% data variables.product.prodname_discussions %} + +### Part 4: Customizing and automating your work on {% data variables.product.product_name %} + + + +### Part 5: Building securely on {% data variables.product.product_name %} + +#### Code scanning + +#### Dependabot + +### Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community + + +#### Interacting with the {% data variables.product.prodname_gcf %} + + +{% if currentVersion == 'free-pro-team@latest' %} +### Further reading +- "[Getting started with {% data variables.product.prodname_team %}](/github/getting-started-with-github/onboarding/getting-started-with-github-team)" +{% endif %} \ No newline at end of file diff --git a/content/github/getting-started-with-github/onboarding/index.md b/content/github/getting-started-with-github/onboarding/index.md new file mode 100644 index 0000000000..9f8182b6bd --- /dev/null +++ b/content/github/getting-started-with-github/onboarding/index.md @@ -0,0 +1,11 @@ +--- +title: Onboarding +intro: '' +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +children: + - /getting-started-with-your-github-account + - /getting-started-with-github-team +--- From 0353dc7d1ebc45ef6199237e862d0d758ca99a32 Mon Sep 17 00:00:00 2001 From: amy Date: Wed, 9 Jun 2021 17:11:28 -0400 Subject: [PATCH 03/52] adding GHEC guide --- ...ng-started-with-github-enterprise-cloud.md | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md new file mode 100644 index 0000000000..4b381f4663 --- /dev/null +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md @@ -0,0 +1,81 @@ +--- +title: Getting started with GitHub Enterprise Cloud +intro: 'Get Started with setting up and managing your GitHub Enterprise Cloud' +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +redirect_from: + - /github/getting-started-with-github/about-github-advanced-security +--- + +### Account Types + +GitHub provides two types of Enterprise products: + +- **GitHub Enterprise Cloud** +- **GitHub Enterprise Server** + +The main difference between the products are that GitHub Enterprise Cloud is hosted by GitHub. + +Within the GitHub Enterprise Cloud product, there are two different types of account that can be used: + +- A single org account, for example https://github.com/github, that uses GHEC +- An enterprise account on GHEC that contains multiple orgs + +In either scenario, your users will use their own self-created user account and you'll invite them. + +#### Choosing the type of account + +https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations#organizations-and-enterprise-accounts + +#### Differences + +## Org account + +### Setting up an organization account with access to GHEC + +#### Creating or upgrading an organization account + +To use an organization account with GHEC, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." + +Alternatively, if you have an existing organization account that you would like to upgrade, follow the steps in "[Upgrading your GitHub subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." + +#### Billing for GHEC + +When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." + +If you do decide to purchase GHEC, you'll need to set up your billing account. + +- Manage Billing +- Setting a billing manage +- Setting a billing email. + + +### Managing users and teams + +### Security + +If you upgraded your organization to {% data variables.product.prodname_ghe_cloud %}, you can set up identity and access management for your organization. For more information, see "[Managing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization)." + +https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#next-steps-for-organizations-using-github-enterprise-cloud + +### Other Settings + +## Enterprise account + +### Creating an enterprise account with multiple orgs + +### Managing users + +### Security + +### Integration, costomization, and automation + +### Community + +### Other Settings + +#### Single org +#### Enterprise account + From c6e4dcb1da10e8d5879877a0087269b6ed19e6ec Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Mon, 14 Jun 2021 17:09:27 -0400 Subject: [PATCH 04/52] updates for user account guide --- .../getting-started-with-github-team.md | 89 ++++--- ...etting-started-with-your-github-account.md | 241 ++++++++++-------- data/reusables/getting-started/actions.md | 1 + data/reusables/getting-started/api.md | 1 + .../getting-started/contact-support.md | 1 + .../customizing-and-automating.md | 1 + .../reusables/getting-started/learning-lab.md | 5 + data/reusables/getting-started/marketplace.md | 1 + .../getting-started/open-source-projects.md | 4 + data/reusables/getting-started/packages.md | 1 + .../participating-in-community.md | 1 + data/reusables/getting-started/sponsors.md | 1 + data/variables/product.yml | 2 +- 13 files changed, 195 insertions(+), 154 deletions(-) create mode 100644 data/reusables/getting-started/actions.md create mode 100644 data/reusables/getting-started/api.md create mode 100644 data/reusables/getting-started/contact-support.md create mode 100644 data/reusables/getting-started/customizing-and-automating.md create mode 100644 data/reusables/getting-started/learning-lab.md create mode 100644 data/reusables/getting-started/marketplace.md create mode 100644 data/reusables/getting-started/open-source-projects.md create mode 100644 data/reusables/getting-started/packages.md create mode 100644 data/reusables/getting-started/participating-in-community.md create mode 100644 data/reusables/getting-started/sponsors.md diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md index 6d35963faa..2a16fb2141 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md @@ -7,91 +7,98 @@ versions: Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. -### Part 1: Configuring your {{ site.data.variables.product.product_name }} account +## Part 1: Configuring your {{ data variables.product.product_name }} account -#### Creating an organization, choosing GitHub Team as the product +### Creating an organization, choosing GitHub Team as the product -#### About billing, managing billing, setting a billing manager, setting a billing email +### About billing, managing billing, setting a billing manager, setting a billing email -#### About organizations +### About organizations -### Part 2: Adding members and setting up teams +## Part 2: Adding members and setting up teams -#### Org-level permissions and roles +### Org-level permissions and roles -#### Managing users in the organization +### Managing users in the organization -#### About and creating teams +### About and creating teams -#### Managing team settings +### Managing team settings -#### Giving people and teams access to repos +### Giving people and teams access to repos -### Part 3: Managing security for your organization +## Part 3: Managing security for your organization -#### Recommending or requiring 2FA +### Recommending or requiring 2FA -#### Allowed IP addresses, approved domains for email addresses +### Allowed IP addresses, approved domains for email addresses -#### Audit log, integrations +### Audit log, integrations -#### Security vulnerabilities in org-owned repos +### Security vulnerabilities in org-owned repos -### Part 4: Setting organization level policies +## Part 4: Setting organization level policies -#### Link out to "Managing organization settings" for the full list, call out some helpful policies +### Link out to "Managing organization settings" for the full list, call out some helpful policies -#### Repos: Repo creation, visibility changes +### Repos: Repo creation, visibility changes -#### Community: Org-level community health files, moderation tools +### Community: Org-level community health files, moderation tools -### Part 5: Customizing and automating your work on {{ site.data.variables.product.product_name }} -{{ site.data.reusables.getting-started.customizing-and-automating }} +## Part 5: Customizing and automating your work on {{ data variables.product.product_name }} -{{ site.data.reusables.getting-started.marketplace }} +{% data reusables.getting-started.customizing-and-automating %} -{{ site.data.reusables.getting-started.api }} +### Using {% data variables.product.prodname_marketplace %} +{% data reusables.getting-started.marketplace %} -{{ site.data.reusables.getting-started.actions }} +### Using the {% data variables.product.product_name %} APIs +{% data reusables.getting-started.api %} -{% if page.version == 'dotcom' %} -{{ site.data.reusables.getting-started.packages }} +### Building {% data variables.product.prodname_actions %} +{% data reusables.getting-started.actions %} + +### Publishing and managing {% data variables.product.prodname_registry %} +{% data reusables.getting-started.packages %} + +## Part 6: Participating in {{ site.data.variables.product.prodname_dotcom }}'s community +{% data reusables.getting-started.participating-in-community %} +### Contributing to open source projects +{% data reusables.getting-started.open-source-projects %} + +### Interacting with the {% data variables.product.prodname_gcf %} +{% data reusables.support.ask-and-answer-forum %} + +### Learning with {% data variables.product.prodname_learning %} +{% data reusables.getting-started.learning-lab %} + +{% if currentVersion == 'free-pro-team@latest' %} +### Supporting the open source community +{% data reusables.getting-started.sponsors %} + +### Contacting {% data variables.contact.github_support %} +{% data reusables.getting-started.contact-support %} {% endif %} -### Part 6: Participating in {{ site.data.variables.product.prodname_dotcom }}'s community -{{ site.data.reusables.getting-started.participating-in-community }} - -{{ site.data.reusables.getting-started.open-source-projects }} - -{% if page.version == 'dotcom' %} -{{ site.data.reusables.getting-started.sponsors }} - -{{ site.data.reusables.getting-started.contact-support }} -{% endif %} - -#### Interacting with the {{ site.data.variables.product.prodname_gcf }} -{{ site.data.reusables.support.ask-and-answer-forum }} - -{{ site.data.reusables.getting-started.learning-lab }} {% if page.version == 'dotcom' %} ### Further reading diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md index e562fda4be..64179cc3fc 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md @@ -1,17 +1,18 @@ --- title: Getting started with your GitHub account -intro: 'You can configure the different settings in your user account to best suit your needs.' +intro: 'You can configure the different settings in your {% data variables.product.product_name %} account to best suit your needs.' versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' --- +## Part 1: Configuring your {% data variables.product.product_name %} account -### Part 1: Configuring your {% data variables.product.product_name %} account +As the first steps in starting with {% data variables.product.product_name %}, you'll need to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. -There are several types of accounts on {% data variables.product.product_name %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of many organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +There are several types of accounts on {% data variables.product.product_name %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. -#### Creating an account +### Creating an account To sign up for a {% data variables.product.product_name %} account, navigate to https://github.com/ and follow the prompts. To keep your {% data variables.product.product_name %} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). @@ -22,21 +23,21 @@ To keep your {% data variables.product.product_name %} account secure you should {% endnote %} -{% if page.version == 'free-pro-team@latest' %} -#### Choosing your {% data variables.product.product_name %} product -{% data variables.product.prodname_dotcom %} offers both free and paid products, each with a different set of features. {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} offer features for individual users. {% data variables.product.prodname_team %} offers collaboration and management tools for teams. {% data variables.product.prodname_enterprise %} offers security, compliance, and deployment controls for organizations. +{% if currentVersion == 'free-pro-team@latest' %} +### Choosing your {% data variables.product.product_name %} product +{% data variables.product.prodname_dotcom %} offers both free and paid products, each with a different set of features. {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} offer features for individual users. {% data variables.product.prodname_team %} offers collaboration and management tools for teams. {% data variables.product.prodname_enterprise %} offers security, compliance, and deployment controls for organizations. -For more information, see "[GitHub's products](/github/getting-started-with-github/githubs-products)." +For more information, see "[GitHub's products](/github/getting-started-with-github/learning-about-github/githubs-products)." {% endif %} -{% if page.version == 'free-pro-team@latest' %} -#### Verifying your email address +{% if currentVersion == 'free-pro-team@latest' %} +### Verifying your email address To ensure you can use all of {% data variables.product.product_name %}'s features, verify your email address after signing up for a new account. -For more information, see "[Verifying your email address](/github/getting-started-with-github/verifying-your-email-address)." +For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} -#### Configuring two-factor authentication +### Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. {% note %} @@ -45,144 +46,160 @@ Two-factor authentication, or 2FA, is an extra layer of security used when loggi {% endnote %} -For more information, see "[About two-factor authentication](/github/authenticating-to-github/about-two-factor-authentication)." +For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." -#### Viewing your {% data variables.product.product_name %} profile and contribution graph -Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/about-your-profile)." +### Viewing your {% data variables.product.product_name %} profile and contribution graph +Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)." -Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile)." +Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." -### Part 2: Working with {% data variables.product.product_name %} +## Part 2: Using {% data variables.product.product_name %}'s tools and processes To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything GitHub-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.product_name %} Flavored Markdown. -#### Introduction to Git +### Learning Git +{% data variables.product.product_name %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[GitHub flow](/github/getting-started-with-github/quickstart/github-flow)." +### Setting up Git -##### Learning Git -{% data variables.product.product_name %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[Understanding the GitHub flow](https://guides.github.com/introduction/flow/)." +If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." -##### Setting up and using Git with {% data variables.product.prodname_desktop %} -{% data variables.product.prodname_desktop %} extends and simplifies your GitHub.com workflow, using a visual interface instead of text commands on the command line. + Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/getting-started-with-github/getting-started-with-git/about-remote-repositories)." -After downloading {% data variables.product.prodname_desktop %} and signing into {% data variables.product.prodname_dotcom %}, you can create and clone a tutorial repository. The tutorial will introduce the basics of working with Git and {% data variables.product.prodname_dotcom %}, including installing an editor, creating a branch, making a commit, pushing to {% data variables.product.prodname_dotcom_the_website %}, and creating a pull request. +You can use a credential helper so Git will remember your GitHub credentials every time it talks to GitHub. For more information, see "[Caching your GitHub credentials in Git](/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git)." -For more information, see “[Creating your first repository using GitHub Desktop](/desktop/getting-started-with-github-desktop/creating-your-first-repository-using-github-desktop)." +### Choosing how to interact with {% data variables.product.product_name %} -##### Setting up and using Git on the command line -To use Git on the command line, you'll need to download, install, and configure Git on your computer. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." +Everyone has their own unique workflow for interacting with GitHub; the interfaces and methods you use depend on your preference and what works best for your needs. -When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/using-git/about-remote-repositories)." +For more information about how to authenticate to GitHub with each of these methods, see "[About authentication to GitHub](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". +#### In browser on {% data variables.product.prodname_dotcom_the_website %} +If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests. This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. +#### {% data variables.product.prodname_desktop %} +{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". +#### IDE or File Editor +You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](/github/getting-started-with-github/getting-started-with-git/associating-text-editors-with-git)". -You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." +#### Command line, with or without {% data variables.product.prodname_cli %} +For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. This may be most convenient if you are already working from the command-line, allowing you to avoid switching context. As long as you have installed and configured Git on your computer, you can use Git on the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)". -[INFO ON AUTHENTICATION?] +{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". -#### Ways of working with {% data variables.product.product_name %} - -There are multiple ways you can interact with GitHub - which one you use all depends on your preference and what you need. - -- In browser on GitHub.com -- Desktop -- IDE or File Editor -- Command line with or without Github CLI -- GitHub API - - -#### Writing on {% data variables.product.product_name %} +#### {% data variables.product.prodname_dotcom %} API +{% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". +### Writing on {% data variables.product.product_name %} To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.product_name %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.product_name %}](/github/writing-on-github/about-writing-and-formatting-on-github)." You can learn {% data variables.product.product_name %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. -#### Searching on {% data variables.product.product_name %} +### Searching on {% data variables.product.product_name %} +Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.product_name %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)". -#### Managing files on {% data variables.product.product_name %} +Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.product_name %}](/github/searching-for-information-on-github/searching-on-github)". +### Managing files on {% data variables.product.product_name %} +With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.product_name %}](/github/managing-files-in-a-repository/managing-files-on-github)". -### Part 3: Collaborating on {% data variables.product.product_name %} +If you want to edit a file in another user's repository, we'll automatically fork the repository and open a pull request for you. For more information, see "[Editing files in another user's repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository)". + +## Part 3: Collaborating on {% data variables.product.product_name %} Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. -#### Working with repositories +### Working with repositories -##### Creating a repository +#### Creating a repository A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." -When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." -##### Cloning a repository +#### Cloning a repository +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that GitHub has at that point in time, including all versions of every file and folder for the project. -##### Forking a repository +You can clone your existing repository or clone another person's existing repository to contribute to a project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". -#### Importing your projects +#### Forking a repository +A fork is a copy of a repository that you manage. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. + +Any changes you make in your fork will not effect the upstream repository, unless you submit a pull request to the project owner. You can still fetch updates from the original repository. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". +### Importing your projects If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.product_name %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to GitHub](/github/importing-your-projects-to-github/importing-source-code-to-github)." -#### Managing collaborators and permissions -You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)." +### Managing collaborators and permissions +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." -You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)." +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." -#### Managing repository settings +### Managing repository settings As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." -#### Setting up your project for healthy contributions +### Setting up your project for healthy contributions To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. -By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions)." +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." -You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](github/building-a-strong-community/about-community-profiles-for-public-repositories)." - -{% if page.version == 'free-pro-team@latest' %} -#### Managing security vulnerabilities -You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and CHECK WHAT THIS MEANS[site.data.variables.product.prodname_security_advisories]. For more information, see “[Managing security vulnerabilities in your project -](/github/managing-security-vulnerabilities/managing-security-vulnerabilities-in-your-project)." -{% endif %} - -#### Managing project boards -You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." - -#### Managing notifications -Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications)." - -#### Working with {% data variables.product.prodname_pages %} -You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[Working with {% data variables.product.prodname_pages %}](/github/working-with-github-pages)." - -#### Working with {% data variables.product.prodname_discussions %} - -### Part 4: Customizing and automating your work on {% data variables.product.product_name %} - - - -### Part 5: Building securely on {% data variables.product.product_name %} - -#### Code scanning - -#### Dependabot - -### Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community - - -#### Interacting with the {% data variables.product.prodname_gcf %} - +You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." {% if currentVersion == 'free-pro-team@latest' %} -### Further reading +### Managing security vulnerabilities +You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {% data variables.product.prodname_security_advisories %}. For more information, see “[Managing security advisories for vulnerabilities in your project](/code-security/security-advisories)." +{% endif %} + +### Managing project boards +You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." + +### Managing notifications +Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." + +### Working with {% data variables.product.prodname_pages %} +You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." + +### Using {% data variables.product.prodname_discussions %} +You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". + +## Part 4: Customizing and automating your work on {% data variables.product.product_name %} + +{% data reusables.getting-started.customizing-and-automating %} + +### Using {% data variables.product.prodname_marketplace %} +{% data reusables.getting-started.marketplace %} + +### Using the {% data variables.product.product_name %} APIs +{% data reusables.getting-started.api %} + +### Building {% data variables.product.prodname_actions %} +{% data reusables.getting-started.actions %} + +### Publishing and managing {% data variables.product.prodname_registry %} +{% data reusables.getting-started.packages %} + +## Part 5: Building securely on {% data variables.product.product_name %} +{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.product_name %} security features](/code-security/getting-started/github-security-features)". +### Securing your repository +As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. + +For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)". + +### Managing your dependencies +A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. + +For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)". +## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community + +{% data reusables.getting-started.participating-in-community %} + +### Contributing to open source projects +{% data reusables.getting-started.open-source-projects %} + +### Interacting with the {% data variables.product.prodname_gcf %} +{% data reusables.support.ask-and-answer-forum %} + +### Learning with {% data variables.product.prodname_learning %} +{% data reusables.getting-started.learning-lab %} + +{% if currentVersion == 'free-pro-team@latest' %} +### Supporting the open source community +{% data reusables.getting-started.sponsors %} + +### Contacting {% data variables.contact.github_support %} +{% data reusables.getting-started.contact-support %} +{% endif %} +## Further reading - "[Getting started with {% data variables.product.prodname_team %}](/github/getting-started-with-github/onboarding/getting-started-with-github-team)" -{% endif %} \ No newline at end of file diff --git a/data/reusables/getting-started/actions.md b/data/reusables/getting-started/actions.md new file mode 100644 index 0000000000..b5dbfb4b54 --- /dev/null +++ b/data/reusables/getting-started/actions.md @@ -0,0 +1 @@ +{% data variables.product.prodname_actions %} are individual tasks you can combine to create jobs and customize your workflow. You can create your own actions, and use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. For more information, see “[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." diff --git a/data/reusables/getting-started/api.md b/data/reusables/getting-started/api.md new file mode 100644 index 0000000000..676cdcc3f4 --- /dev/null +++ b/data/reusables/getting-started/api.md @@ -0,0 +1 @@ +There are two versions of the {% data variables.product.product_name %} API: the REST API and the GraphQL API. You can use the {% data variables.product.product_name %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% if currentVersion == 'free-pro-team@latest' %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.product_name %}'s APIs](/developers/overview/about-githubs-apis)". \ No newline at end of file diff --git a/data/reusables/getting-started/contact-support.md b/data/reusables/getting-started/contact-support.md new file mode 100644 index 0000000000..98fb0e3bc2 --- /dev/null +++ b/data/reusables/getting-started/contact-support.md @@ -0,0 +1 @@ +{% data variables.contact.github_support %} can help you troubleshoot issues you run into while using {% data variables.product.prodname_dotcom %}. For more information, see “[About {% data variables.contact.github_support %}](/github/working-with-github-support/about-github-support)." \ No newline at end of file diff --git a/data/reusables/getting-started/customizing-and-automating.md b/data/reusables/getting-started/customizing-and-automating.md new file mode 100644 index 0000000000..632ee23856 --- /dev/null +++ b/data/reusables/getting-started/customizing-and-automating.md @@ -0,0 +1 @@ +You can use tools from the {% data variables.product.prodname_marketplace %}, the {% data variables.product.product_name %} API, and existing {% data variables.product.product_name %} features to customize and automate your work. \ No newline at end of file diff --git a/data/reusables/getting-started/learning-lab.md b/data/reusables/getting-started/learning-lab.md new file mode 100644 index 0000000000..d00d403453 --- /dev/null +++ b/data/reusables/getting-started/learning-lab.md @@ -0,0 +1,5 @@ +You 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. + +To better understand some basic concepts, you can refer to the [{% data variables.product.product_name %} guides](https://guides.github.com). + +For more information, see “[Git and GitHub learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." \ No newline at end of file diff --git a/data/reusables/getting-started/marketplace.md b/data/reusables/getting-started/marketplace.md new file mode 100644 index 0000000000..7a7f5381ba --- /dev/null +++ b/data/reusables/getting-started/marketplace.md @@ -0,0 +1 @@ +{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including [{% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s](/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps), and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). For more information, see "[{% data variables.product.prodname_marketplace %}](/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace)". \ No newline at end of file diff --git a/data/reusables/getting-started/open-source-projects.md b/data/reusables/getting-started/open-source-projects.md new file mode 100644 index 0000000000..1e6fad7ed2 --- /dev/null +++ b/data/reusables/getting-started/open-source-projects.md @@ -0,0 +1,4 @@ +Contributing to open source projects on {% data variables.product.prodname_dotcom %} can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. For more information, see “[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)" in the Open Source Guides. + +You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% if page.version == 'dotcom' %} For more information, see “[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +{% endif %} \ No newline at end of file diff --git a/data/reusables/getting-started/packages.md b/data/reusables/getting-started/packages.md new file mode 100644 index 0000000000..79a65c5c84 --- /dev/null +++ b/data/reusables/getting-started/packages.md @@ -0,0 +1 @@ +{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects. For more information, see “[Introduction to {% data variables.product.prodname_registry %}](/packages/learn-github-packages/introduction-to-github-packages)." \ No newline at end of file diff --git a/data/reusables/getting-started/participating-in-community.md b/data/reusables/getting-started/participating-in-community.md new file mode 100644 index 0000000000..3524681b2d --- /dev/null +++ b/data/reusables/getting-started/participating-in-community.md @@ -0,0 +1 @@ +There are many ways to participate in the {% data variables.product.prodname_dotcom %} community. You can contribute to open source projects, interact with people in the {% data variables.product.prodname_gcf %}, or learn with {% data variables.product.prodname_learning %}. \ No newline at end of file diff --git a/data/reusables/getting-started/sponsors.md b/data/reusables/getting-started/sponsors.md new file mode 100644 index 0000000000..2894fc800b --- /dev/null +++ b/data/reusables/getting-started/sponsors.md @@ -0,0 +1 @@ +{% data variables.product.prodname_sponsors %} allows you to make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on. For more information, see “[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." \ No newline at end of file diff --git a/data/variables/product.yml b/data/variables/product.yml index 0279f84228..247216c1ef 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -122,7 +122,7 @@ prodname_codespaces: 'Codespaces' prodname_github_codespaces: 'GitHub Codespaces' # GitHub resources: blog, jobs, Learning Lab -prodname_gcf: 'GitHub Community Support' +prodname_gcf: 'GitHub Support Community' prodname_blog: 'the GitHub Blog' prodname_jobs: 'GitHub Jobs' prodname_learning: 'GitHub Learning Lab' From 61a11b54f47b7b418e63b50aac1cf537fe1f5f69 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Mon, 14 Jun 2021 17:26:08 -0400 Subject: [PATCH 05/52] fixing team --- .../onboarding/getting-started-with-github-team.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md index 2a16fb2141..c94c25fad5 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md @@ -1,13 +1,13 @@ --- title: Getting started with GitHub Team -intro: 'With {{ site.data.variables.product.prodname_team }} groups of people can collaborate across many projects at the same time in an organization account.' +intro: 'With {% data variables.product.prodname_team %} groups of people can collaborate across many projects at the same time in an organization account.' versions: free-pro-team: '*' --- Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. -## Part 1: Configuring your {{ data variables.product.product_name }} account +## Part 1: Configuring your {% data variables.product.product_name %} account ### Creating an organization, choosing GitHub Team as the product @@ -64,7 +64,7 @@ Organizations are shared accounts where businesses and open-source projects can ### Community: Org-level community health files, moderation tools -## Part 5: Customizing and automating your work on {{ data variables.product.product_name }} +## Part 5: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} @@ -80,7 +80,7 @@ Organizations are shared accounts where businesses and open-source projects can ### Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -## Part 6: Participating in {{ site.data.variables.product.prodname_dotcom }}'s community +## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} ### Contributing to open source projects {% data reusables.getting-started.open-source-projects %} From e1ecf40e2f8720d81f2318d428bb2fca22cc3659 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 15 Jun 2021 10:34:29 -0400 Subject: [PATCH 06/52] update with versioning for ae and enterprise --- ...etting-started-with-your-github-account.md | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md index 64179cc3fc..e675249513 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md @@ -17,18 +17,17 @@ To sign up for a {% data variables.product.product_name %} account, navigate to To keep your {% data variables.product.product_name %} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). +{% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} {% note %} **Note**: Changing your {% data variables.product.product_name %} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your GitHub username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." {% endnote %} - -{% if currentVersion == 'free-pro-team@latest' %} +{% endif %} ### Choosing your {% data variables.product.product_name %} product {% data variables.product.prodname_dotcom %} offers both free and paid products, each with a different set of features. {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} offer features for individual users. {% data variables.product.prodname_team %} offers collaboration and management tools for teams. {% data variables.product.prodname_enterprise %} offers security, compliance, and deployment controls for organizations. For more information, see "[GitHub's products](/github/getting-started-with-github/learning-about-github/githubs-products)." -{% endif %} {% if currentVersion == 'free-pro-team@latest' %} ### Verifying your email address @@ -37,6 +36,7 @@ To ensure you can use all of {% data variables.product.product_name %}'s feature For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} +{% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} ### Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. @@ -47,7 +47,7 @@ Two-factor authentication, or 2FA, is an extra layer of security used when loggi {% endnote %} For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." - +{% endif %} ### Viewing your {% data variables.product.product_name %} profile and contribution graph Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)." @@ -131,12 +131,16 @@ You are the owner of any repository you create in your user account and have ful As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." ### Setting up your project for healthy contributions +{% if currentVersion == 'free-pro-team@latest' %} To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." - +{% endif %} +{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." +{% endif %} {% if currentVersion == 'free-pro-team@latest' %} ### Managing security vulnerabilities You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {% data variables.product.prodname_security_advisories %}. For more information, see “[Managing security advisories for vulnerabilities in your project](/code-security/security-advisories)." @@ -151,16 +155,18 @@ Notifications provide updates about the activity on {% data variables.product.pr ### Working with {% data variables.product.prodname_pages %} You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." +{% if currentVersion == 'free-pro-team@latest' %} ### Using {% data variables.product.prodname_discussions %} You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". - +{% endif %} ## Part 4: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} +{% if currentVersion == 'free-pro-team@latest' %} ### Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} - +{% endif %} ### Using the {% data variables.product.product_name %} APIs {% data reusables.getting-started.api %} @@ -177,10 +183,12 @@ As a repository administrator, you can secure your repositories by configuring r For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)". +{% if currentVersion == 'free-pro-team@latest' %} ### Managing your dependencies A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)". +{% endif %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} @@ -200,6 +208,7 @@ For more information, see "[Securing your software supply chain](/code-security/ ### Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} -{% endif %} + ## Further reading - "[Getting started with {% data variables.product.prodname_team %}](/github/getting-started-with-github/onboarding/getting-started-with-github-team)" +{% endif %} \ No newline at end of file From 4f055f6ae9dd2189cb667f9db9ab1f4ff24aa8d7 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 15 Jun 2021 11:29:10 -0400 Subject: [PATCH 07/52] fixed wrong variables --- ...etting-started-with-your-github-account.md | 48 +++++++++---------- data/reusables/getting-started/api.md | 2 +- .../reusables/getting-started/learning-lab.md | 4 +- .../getting-started/open-source-projects.md | 2 +- .../reusables/support/ask-and-answer-forum.md | 2 +- 5 files changed, 28 insertions(+), 30 deletions(-) diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md index e675249513..d6f3742dd1 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md @@ -1,33 +1,33 @@ --- title: Getting started with your GitHub account -intro: 'You can configure the different settings in your {% data variables.product.product_name %} account to best suit your needs.' +intro: 'You can configure the different settings in your {% data variables.product.prodname_dotcom %} account to best suit your needs.' versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' --- -## Part 1: Configuring your {% data variables.product.product_name %} account +## Part 1: Configuring your {% data variables.product.prodname_dotcom %} account As the first steps in starting with {% data variables.product.product_name %}, you'll need to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. -There are several types of accounts on {% data variables.product.product_name %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +There are several types of accounts on {% data variables.product.prodname_dotcom %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. ### Creating an account -To sign up for a {% data variables.product.product_name %} account, navigate to https://github.com/ and follow the prompts. +To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. -To keep your {% data variables.product.product_name %} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). +To keep your {% data variables.product.prodname_dotcom %} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). {% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} {% note %} -**Note**: Changing your {% data variables.product.product_name %} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your GitHub username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." +**Note**: Changing your {% data variables.product.prodname_dotcom %} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your {% data variables.product.prodname_dotcom %} username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." {% endnote %} {% endif %} -### Choosing your {% data variables.product.product_name %} product +### Choosing your {% data variables.product.prodname_dotcom %} product {% data variables.product.prodname_dotcom %} offers both free and paid products, each with a different set of features. {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} offer features for individual users. {% data variables.product.prodname_team %} offers collaboration and management tools for teams. {% data variables.product.prodname_enterprise %} offers security, compliance, and deployment controls for organizations. -For more information, see "[GitHub's products](/github/getting-started-with-github/learning-about-github/githubs-products)." +For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/learning-about-github/githubs-products)." {% if currentVersion == 'free-pro-team@latest' %} ### Verifying your email address @@ -54,27 +54,25 @@ Your {% data variables.product.product_name %} profile tells people the story of Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes -To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything GitHub-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.product_name %} Flavored Markdown. +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### Learning Git -{% data variables.product.product_name %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[GitHub flow](/github/getting-started-with-github/quickstart/github-flow)." +{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/github/getting-started-with-github/quickstart/github-flow)." ### Setting up Git - If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/getting-started-with-github/getting-started-with-git/about-remote-repositories)." -You can use a credential helper so Git will remember your GitHub credentials every time it talks to GitHub. For more information, see "[Caching your GitHub credentials in Git](/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git)." +You can use a credential helper so Git will remember your {% data variables.product.prodname_dotcom %} credentials every time it talks to {% data variables.product.prodname_dotcom %}. For more information, see "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git)." ### Choosing how to interact with {% data variables.product.product_name %} +Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. -Everyone has their own unique workflow for interacting with GitHub; the interfaces and methods you use depend on your preference and what works best for your needs. - -For more information about how to authenticate to GitHub with each of these methods, see "[About authentication to GitHub](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". +For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". #### In browser on {% data variables.product.prodname_dotcom_the_website %} If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests. This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. #### {% data variables.product.prodname_desktop %} -{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". +{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". #### IDE or File Editor You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](/github/getting-started-with-github/getting-started-with-git/associating-text-editors-with-git)". @@ -86,17 +84,17 @@ For the most granular control and customization of how you use Git and interact #### {% data variables.product.prodname_dotcom %} API {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". ### Writing on {% data variables.product.product_name %} -To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.product_name %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.product_name %}](/github/writing-on-github/about-writing-and-formatting-on-github)." +To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." -You can learn {% data variables.product.product_name %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. +You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. ### Searching on {% data variables.product.product_name %} -Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.product_name %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)". +Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)". -Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.product_name %}](/github/searching-for-information-on-github/searching-on-github)". +Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/searching-on-github)". ### Managing files on {% data variables.product.product_name %} -With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.product_name %}](/github/managing-files-in-a-repository/managing-files-on-github)". +With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)". If you want to edit a file in another user's repository, we'll automatically fork the repository and open a pull request for you. For more information, see "[Editing files in another user's repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository)". @@ -111,7 +109,7 @@ A repository is like a folder for your project. You can have any number of publi When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." #### Cloning a repository -You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that GitHub has at that point in time, including all versions of every file and folder for the project. +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. You can clone your existing repository or clone another person's existing repository to contribute to a project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". @@ -120,7 +118,7 @@ A fork is a copy of a repository that you manage. Most commonly, forks are used Any changes you make in your fork will not effect the upstream repository, unless you submit a pull request to the project owner. You can still fetch updates from the original repository. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". ### Importing your projects -If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.product_name %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to GitHub](/github/importing-your-projects-to-github/importing-source-code-to-github)." +If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." ### Managing collaborators and permissions You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." @@ -167,7 +165,7 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi ### Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} {% endif %} -### Using the {% data variables.product.product_name %} APIs +### Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} ### Building {% data variables.product.prodname_actions %} @@ -177,7 +175,7 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi {% data reusables.getting-started.packages %} ## Part 5: Building securely on {% data variables.product.product_name %} -{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.product_name %} security features](/code-security/getting-started/github-security-features)". +{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)". ### Securing your repository As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. diff --git a/data/reusables/getting-started/api.md b/data/reusables/getting-started/api.md index 676cdcc3f4..2ad31e237f 100644 --- a/data/reusables/getting-started/api.md +++ b/data/reusables/getting-started/api.md @@ -1 +1 @@ -There are two versions of the {% data variables.product.product_name %} API: the REST API and the GraphQL API. You can use the {% data variables.product.product_name %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% if currentVersion == 'free-pro-team@latest' %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.product_name %}'s APIs](/developers/overview/about-githubs-apis)". \ No newline at end of file +There are two versions of the {% data variables.product.prodname_dotcom %} API: the REST API and the GraphQL API. You can use the {% data variables.product.prodname_dotcom %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% if currentVersion == 'free-pro-team@latest' %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.prodname_dotcom %}'s APIs](/developers/overview/about-githubs-apis)". \ No newline at end of file diff --git a/data/reusables/getting-started/learning-lab.md b/data/reusables/getting-started/learning-lab.md index d00d403453..9ff0d3c235 100644 --- a/data/reusables/getting-started/learning-lab.md +++ b/data/reusables/getting-started/learning-lab.md @@ -1,5 +1,5 @@ You 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. -To better understand some basic concepts, you can refer to the [{% data variables.product.product_name %} guides](https://guides.github.com). +To better understand some basic concepts, you can refer to the [{% data variables.product.prodname_dotcom %} guides](https://guides.github.com). -For more information, see “[Git and GitHub learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." \ No newline at end of file +For more information, see “[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." \ No newline at end of file diff --git a/data/reusables/getting-started/open-source-projects.md b/data/reusables/getting-started/open-source-projects.md index 1e6fad7ed2..a18a6b1433 100644 --- a/data/reusables/getting-started/open-source-projects.md +++ b/data/reusables/getting-started/open-source-projects.md @@ -1,4 +1,4 @@ Contributing to open source projects on {% data variables.product.prodname_dotcom %} can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. For more information, see “[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)" in the Open Source Guides. -You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% if page.version == 'dotcom' %} For more information, see “[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% if currentVersion == 'free-pro-team@latest' %} For more information, see “[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." {% endif %} \ No newline at end of file diff --git a/data/reusables/support/ask-and-answer-forum.md b/data/reusables/support/ask-and-answer-forum.md index e5ba6155e7..46abedaf41 100644 --- a/data/reusables/support/ask-and-answer-forum.md +++ b/data/reusables/support/ask-and-answer-forum.md @@ -1 +1 @@ -You can connect with developers around the world in the [{% data variables.product.prodname_gcf %}](https://github.community) to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. +You can connect with developers around the world in the [{% data variables.product.prodname_gcf %}](https://github.community) to ask and answer questions, learn, and interact directly with {% data variables.product.prodname_dotcom %} staff. From f8eba7e2a07722355742066a5e6b49d527f130fc Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 15 Jun 2021 11:48:12 -0400 Subject: [PATCH 08/52] updated intro --- .../onboarding/getting-started-with-your-github-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md index d6f3742dd1..3ed0bb3be9 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md @@ -1,6 +1,6 @@ --- title: Getting started with your GitHub account -intro: 'You can configure the different settings in your {% data variables.product.prodname_dotcom %} account to best suit your needs.' +intro: 'With an account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' versions: free-pro-team: '*' enterprise-server: '*' From f8d79625e3224dac93adab4d161169ce0bd7a857 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 16 Jun 2021 14:31:37 -0400 Subject: [PATCH 09/52] GitHub Team guide updates + enterprise server shell page --- ...ng-started-with-github-enterprise-cloud.md | 6 +- ...g-started-with-github-enterprise-server.md | 79 +++++++++++++++++++ .../getting-started-with-github-team.md | 43 ++++++---- 3 files changed, 107 insertions(+), 21 deletions(-) create mode 100644 content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md index 4b381f4663..b5f75ea6c0 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-cloud.md @@ -1,12 +1,10 @@ --- title: Getting started with GitHub Enterprise Cloud -intro: 'Get Started with setting up and managing your GitHub Enterprise Cloud' +intro: 'Get started with setting up and managing your GitHub Enterprise Cloud' versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' -redirect_from: - - /github/getting-started-with-github/about-github-advanced-security --- ### Account Types @@ -70,7 +68,7 @@ https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgr ### Security -### Integration, costomization, and automation +### Integration, customization, and automation ### Community diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md new file mode 100644 index 0000000000..0eb854c788 --- /dev/null +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md @@ -0,0 +1,79 @@ +--- +title: Getting started with GitHub Enterprise Server +intro: 'Get started with setting up and managing your GitHub Enterprise Server instance' +versions: + free-pro-team: '*' + enterprise-server: '*' + github-ae: '*' +--- + +### Account Types + +GitHub provides two types of Enterprise products: + +- **GitHub Enterprise Cloud** +- **GitHub Enterprise Server** + +The main difference between the products are that GitHub Enterprise Cloud is hosted by GitHub. + +Within the GitHub Enterprise Cloud product, there are two different types of account that can be used: + +- A single org account, for example https://github.com/github, that uses GHEC +- An enterprise account on GHEC that contains multiple orgs + +In either scenario, your users will use their own self-created user account and you'll invite them. + +#### Choosing the type of account + +https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations#organizations-and-enterprise-accounts + +#### Differences + +## Org account + +### Setting up an organization account with access to GHEC + +#### Creating or upgrading an organization account + +To use an organization account with GHEC, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." + +Alternatively, if you have an existing organization account that you would like to upgrade, follow the steps in "[Upgrading your GitHub subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." + +#### Billing for GHEC + +When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." + +If you do decide to purchase GHEC, you'll need to set up your billing account. + +- Manage Billing +- Setting a billing manage +- Setting a billing email. + + +### Managing users and teams + +### Security + +If you upgraded your organization to {% data variables.product.prodname_ghe_cloud %}, you can set up identity and access management for your organization. For more information, see "[Managing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization)." + +https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#next-steps-for-organizations-using-github-enterprise-cloud + +### Other Settings + +## Enterprise account + +### Creating an enterprise account with multiple orgs + +### Managing users + +### Security + +### Integration, customization, and automation + +### Community + +### Other Settings + +#### Single org +#### Enterprise account + diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md index c94c25fad5..013c6890a2 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md @@ -4,41 +4,48 @@ intro: 'With {% data variables.product.prodname_team %} groups of people can col versions: free-pro-team: '*' --- - -Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. - ## Part 1: Configuring your {% data variables.product.product_name %} account +As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. +### Creating an organization and signing up for {% data variables.product.prodname_team %} +Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-github/signing-up-for-a-new-github-account)". -### Creating an organization, choosing GitHub Team as the product +Once your user account is set up, you can create an organization. When you choose to create a new organization, you will be asked to pick a plan for your organization. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +### Managing billing for an organization +You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". -### About billing, managing billing, setting a billing manager, setting a billing email +Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". +{% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization' billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)". +Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". ### About organizations +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)". +Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)". ## Part 2: Adding members and setting up teams - ### Org-level permissions and roles - +https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles ### Managing users in the organization - +https://docs.github.com/en/organizations/managing-membership-in-your-organization ### About and creating teams +https://docs.github.com/en/organizations/organizing-members-into-teams - +https://docs.github.com/en/organizations/collaborating-with-your-team ### Managing team settings +https://docs.github.com/en/organizations/managing-organization-settings? - -### Giving people and teams access to repos - +### Giving people and teams access to repositories, project boards and apps +https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories ## Part 3: Managing security for your organization - +https://docs.github.com/en/organizations/keeping-your-organization-secure +https://docs.github.com/en/organizations/restricting-access-to-your-organizations-data ### Recommending or requiring 2FA @@ -55,14 +62,17 @@ Organizations are shared accounts where businesses and open-source projects can ## Part 4: Setting organization level policies -### Link out to "Managing organization settings" for the full list, call out some helpful policies - +### Managing organization policies +Link out to "Managing organization settings" for the full list, call out some helpful policies +https://docs.github.com/en/organizations/managing-organization-settings ### Repos: Repo creation, visibility changes ### Community: Org-level community health files, moderation tools +https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file +https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community ## Part 5: Customizing and automating your work on {% data variables.product.product_name %} @@ -99,8 +109,7 @@ Organizations are shared accounts where businesses and open-source projects can {% data reusables.getting-started.contact-support %} {% endif %} - -{% if page.version == 'dotcom' %} +{% if currentVersion == 'free-pro-team@latest' %} ### Further reading - "[Getting started with your GitHub account](/github/getting-started-with-github/onboarding/getting-started-with-your-github-account)" {% endif %} \ No newline at end of file From 55af6afecbd29dd0feda3e8d5b944bfbf213f301 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 16 Jun 2021 14:55:49 -0400 Subject: [PATCH 10/52] updated links --- .../getting-started-with-github-enterprise-server.md | 6 +++--- .../onboarding/getting-started-with-github-team.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md index 0eb854c788..61a2c2ab9f 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-enterprise-server.md @@ -14,9 +14,9 @@ GitHub provides two types of Enterprise products: - **GitHub Enterprise Cloud** - **GitHub Enterprise Server** -The main difference between the products are that GitHub Enterprise Cloud is hosted by GitHub. +The main difference between the products are that GitHub Enterprise Server is hosted by GitHub. -Within the GitHub Enterprise Cloud product, there are two different types of account that can be used: +Within the GitHub Enterprise Server product, there are two different types of account that can be used: - A single org account, for example https://github.com/github, that uses GHEC - An enterprise account on GHEC that contains multiple orgs @@ -39,7 +39,7 @@ To use an organization account with GHEC, you will first need to create an organ Alternatively, if you have an existing organization account that you would like to upgrade, follow the steps in "[Upgrading your GitHub subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." -#### Billing for GHEC +#### Billing for GHES When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md index 013c6890a2..18999b1576 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-github-team.md @@ -10,7 +10,7 @@ As the first steps in starting with {% data variables.product.prodname_team %}, ### Creating an organization and signing up for {% data variables.product.prodname_team %} Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-github/signing-up-for-a-new-github-account)". -Once your user account is set up, you can create an organization. When you choose to create a new organization, you will be asked to pick a plan for your organization. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +Once your user account is set up, you can create an organization. When you choose to create a new organization, you will be asked to pick a plan for your organization. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". ### Managing billing for an organization You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". From 23c409cf6706179656d942b03e66a37fe04adec7 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Tue, 22 Jun 2021 14:05:45 -0400 Subject: [PATCH 11/52] Apply suggestions from code review Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> --- .../getting-started-with-your-github-account.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md index 3ed0bb3be9..77c2a257a5 100644 --- a/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md +++ b/content/github/getting-started-with-github/onboarding/getting-started-with-your-github-account.md @@ -15,7 +15,7 @@ There are several types of accounts on {% data variables.product.prodname_dotcom ### Creating an account To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. -To keep your {% data variables.product.prodname_dotcom %} account secure you should generate a strong and unique password with more than 16 characters using a password manager, such as [LastPass](https://lastpass.com/) or [1Password](https://1password.com/). +To keep your {% data variables.product.prodname_dotcom %} account secure you should generate a strong and unique password with more than 16 characters using a password manager. {% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} {% note %} @@ -25,9 +25,9 @@ To keep your {% data variables.product.prodname_dotcom %} account secure you sho {% endnote %} {% endif %} ### Choosing your {% data variables.product.prodname_dotcom %} product -{% data variables.product.prodname_dotcom %} offers both free and paid products, each with a different set of features. {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} offer features for individual users. {% data variables.product.prodname_team %} offers collaboration and management tools for teams. {% data variables.product.prodname_enterprise %} offers security, compliance, and deployment controls for organizations. +You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. -For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/learning-about-github/githubs-products)." +For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/learning-about-github/githubs-products)." {% if currentVersion == 'free-pro-team@latest' %} ### Verifying your email address @@ -49,9 +49,7 @@ Two-factor authentication, or 2FA, is an extra layer of security used when loggi For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} ### Viewing your {% data variables.product.product_name %} profile and contribution graph -Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)." - -Your profile also shows a graph of your public repository contributions over the past year. Additionally, you can choose to show anonymized activity from private repositories. For more information, see “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." +Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. @@ -209,4 +207,4 @@ For more information, see "[Securing your software supply chain](/code-security/ ## Further reading - "[Getting started with {% data variables.product.prodname_team %}](/github/getting-started-with-github/onboarding/getting-started-with-github-team)" -{% endif %} \ No newline at end of file +{% endif %} From d27beff60467072ea2bc959bb737dca55ab8bbd3 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 22 Jun 2021 15:13:01 -0400 Subject: [PATCH 12/52] Fix broken links --- .../get-started/onboarding/getting-started-with-github-team.md | 2 +- .../onboarding/getting-started-with-your-github-account.md | 2 +- content/get-started/onboarding/index.md | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) 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 18999b1576..d1c895f859 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -111,5 +111,5 @@ https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contr {% if currentVersion == 'free-pro-team@latest' %} ### Further reading -- "[Getting started with your GitHub account](/github/getting-started-with-github/onboarding/getting-started-with-your-github-account)" +- "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" {% endif %} \ No newline at end of file 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 77c2a257a5..c98a780f00 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 @@ -206,5 +206,5 @@ For more information, see "[Securing your software supply chain](/code-security/ {% data reusables.getting-started.contact-support %} ## Further reading -- "[Getting started with {% data variables.product.prodname_team %}](/github/getting-started-with-github/onboarding/getting-started-with-github-team)" +- "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" {% endif %} diff --git a/content/get-started/onboarding/index.md b/content/get-started/onboarding/index.md index 9f8182b6bd..6b0d525309 100644 --- a/content/get-started/onboarding/index.md +++ b/content/get-started/onboarding/index.md @@ -8,4 +8,6 @@ versions: children: - /getting-started-with-your-github-account - /getting-started-with-github-team + - /getting-started-with-github-enterprise-cloud + - /getting-started-with-github-enterprise-server --- From cead1ab2f2d3e89b3b3dcdae6c762acd4f32f84b Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 22 Jun 2021 15:29:41 -0400 Subject: [PATCH 13/52] fix links again --- .../getting-started-with-github-enterprise-cloud.md | 2 +- .../getting-started-with-github-enterprise-server.md | 2 +- .../onboarding/getting-started-with-github-team.md | 2 +- .../getting-started-with-your-github-account.md | 10 +++++----- 4 files changed, 8 insertions(+), 8 deletions(-) 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 b5f75ea6c0..b50721fcd7 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 @@ -41,7 +41,7 @@ Alternatively, if you have an existing organization account that you would like #### Billing for GHEC -When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." +When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." If you do decide to purchase GHEC, you'll need to set up your billing account. 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 61a2c2ab9f..642cc0286d 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 @@ -41,7 +41,7 @@ Alternatively, if you have an existing organization account that you would like #### Billing for GHES -When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/github/getting-started-with-github/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." +When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." If you do decide to purchase GHEC, you'll need to set up your billing account. 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 d1c895f859..505eaf7489 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -8,7 +8,7 @@ versions: As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. ### Creating an organization and signing up for {% data variables.product.prodname_team %} -Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/github/getting-started-with-github/signing-up-for-github/signing-up-for-a-new-github-account)". +Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)". Once your user account is set up, you can create an organization. When you choose to create a new organization, you will be asked to pick a plan for your organization. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". 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 c98a780f00..73cdf938f5 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 @@ -27,7 +27,7 @@ To keep your {% data variables.product.prodname_dotcom %} account secure you sho ### Choosing your {% data variables.product.prodname_dotcom %} product You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. -For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/learning-about-github/githubs-products)." +For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." {% if currentVersion == 'free-pro-team@latest' %} ### Verifying your email address @@ -55,11 +55,11 @@ Your {% data variables.product.product_name %} profile tells people the story of To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### Learning Git -{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/github/getting-started-with-github/quickstart/github-flow)." +{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." ### Setting up Git -If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/github/getting-started-with-github/set-up-git)." +If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/set-up-git)." - Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/github/getting-started-with-github/getting-started-with-git/about-remote-repositories)." + Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." You can use a credential helper so Git will remember your {% data variables.product.prodname_dotcom %} credentials every time it talks to {% data variables.product.prodname_dotcom %}. For more information, see "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git)." @@ -72,7 +72,7 @@ If you don't need to work with files locally, {% data variables.product.product_ #### {% data variables.product.prodname_desktop %} {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". #### IDE or File Editor -You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](/github/getting-started-with-github/getting-started-with-git/associating-text-editors-with-git)". +You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](/get-started/getting-started-with-git/associating-text-editors-with-git)". #### Command line, with or without {% data variables.product.prodname_cli %} For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. This may be most convenient if you are already working from the command-line, allowing you to avoid switching context. As long as you have installed and configured Git on your computer, you can use Git on the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)". From 6dff2a000e43fbda7cdad673de8c9f684eb10a5c Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 22 Jun 2021 15:48:03 -0400 Subject: [PATCH 14/52] fix links and versioning --- .../onboarding/getting-started-with-github-enterprise-cloud.md | 2 -- .../onboarding/getting-started-with-your-github-account.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) 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 b50721fcd7..8653ed1100 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 @@ -3,8 +3,6 @@ title: Getting started with GitHub Enterprise Cloud intro: 'Get started with setting up and managing your GitHub Enterprise Cloud' versions: free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' --- ### Account Types 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 73cdf938f5..52b53f0ee4 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 @@ -57,7 +57,7 @@ To best use {% data variables.product.product_name %}, you'll need to set up Git ### Learning Git {% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." ### Setting up Git -If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/set-up-git)." +If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/quickstart/set-up-git)." Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." From 1bae487d1f5ee9c4c68a0cc9f271cad7a6ffbc99 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 22 Jun 2021 16:58:06 -0400 Subject: [PATCH 15/52] Removed some text and added numbers for H3s --- ...g-started-with-github-enterprise-server.md | 5 -- .../getting-started-with-github-team.md | 21 ++--- ...etting-started-with-your-github-account.md | 90 ++++++++----------- 3 files changed, 46 insertions(+), 70 deletions(-) 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 642cc0286d..a02fcdbd85 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 @@ -2,9 +2,7 @@ title: Getting started with GitHub Enterprise Server intro: 'Get started with setting up and managing your GitHub Enterprise Server instance' versions: - free-pro-team: '*' enterprise-server: '*' - github-ae: '*' --- ### Account Types @@ -37,7 +35,6 @@ https://docs.github.com/en/organizations/collaborating-with-groups-in-organizati To use an organization account with GHEC, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." -Alternatively, if you have an existing organization account that you would like to upgrade, follow the steps in "[Upgrading your GitHub subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." #### Billing for GHES @@ -54,8 +51,6 @@ If you do decide to purchase GHEC, you'll need to set up your billing account. ### Security -If you upgraded your organization to {% data variables.product.prodname_ghe_cloud %}, you can set up identity and access management for your organization. For more information, see "[Managing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization)." - https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#next-steps-for-organizations-using-github-enterprise-cloud ### Other Settings 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 505eaf7489..ee689334bb 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -78,34 +78,35 @@ https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contr {% data reusables.getting-started.customizing-and-automating %} -### Using {% data variables.product.prodname_marketplace %} +{% if currentVersion == 'free-pro-team@latest' %} +### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} - -### Using the {% data variables.product.product_name %} APIs +{% endif %} +### {% if currentVersion == 'free-pro-team@latest' %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} -### Building {% data variables.product.prodname_actions %} +### {% if currentVersion == 'free-pro-team@latest' %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### Publishing and managing {% data variables.product.prodname_registry %} +### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} -### Contributing to open source projects +### 1. Contributing to open source projects {% data reusables.getting-started.open-source-projects %} -### Interacting with the {% data variables.product.prodname_gcf %} +### 2. Interacting with the {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### Learning with {% data variables.product.prodname_learning %} +### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} {% if currentVersion == 'free-pro-team@latest' %} -### Supporting the open source community +### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} -### Contacting {% data variables.contact.github_support %} +### 5. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} {% endif %} 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 52b53f0ee4..036b45fea5 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 @@ -12,58 +12,38 @@ As the first steps in starting with {% data variables.product.product_name %}, y There are several types of accounts on {% data variables.product.prodname_dotcom %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. -### Creating an account +### 1. Creating an account To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. To keep your {% data variables.product.prodname_dotcom %} account secure you should generate a strong and unique password with more than 16 characters using a password manager. - -{% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} -{% note %} - -**Note**: Changing your {% data variables.product.prodname_dotcom %} username in the future can have unintended consequences, like some contributions no longer being attributed to you. For more information, see “[Changing your {% data variables.product.prodname_dotcom %} username](/github/setting-up-and-managing-your-github-user-account/changing-your-github-username#changing-your-username)." - -{% endnote %} -{% endif %} -### Choosing your {% data variables.product.prodname_dotcom %} product +### 2. Choosing your {% data variables.product.prodname_dotcom %} product You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." {% if currentVersion == 'free-pro-team@latest' %} -### Verifying your email address -To ensure you can use all of {% data variables.product.product_name %}'s features, verify your email address after signing up for a new account. - -For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." +### 3. Verifying your email address +To ensure you can use all of {% data variables.product.product_name %}'s features, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} -### Configuring two-factor authentication -Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. - -{% note %} - -**Note**: When you configure two-factor authentication, download and save your 2FA recovery codes with your password manager. If you lose access to your phone, you can authenticate to {% data variables.product.product_name %} using your recovery codes. - -{% endnote %} - -For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." +### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Configuring two-factor authentication +Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### Viewing your {% data variables.product.product_name %} profile and contribution graph +### {% if currentVersion == 'free-pro-team@latest' %}5.{% endif %}{% if enterpriseServerVersions contains currentVersion %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. -### Learning Git +### 1. Learning Git {% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." -### Setting up Git +### 2. Setting up Git If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/quickstart/set-up-git)." - Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." +Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." -You can use a credential helper so Git will remember your {% data variables.product.prodname_dotcom %} credentials every time it talks to {% data variables.product.prodname_dotcom %}. For more information, see "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/getting-started-with-git/caching-your-github-credentials-in-git)." - -### Choosing how to interact with {% data variables.product.product_name %} +### 3. Choosing how to interact with {% data variables.product.product_name %} Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". @@ -81,17 +61,17 @@ For the most granular control and customization of how you use Git and interact #### {% data variables.product.prodname_dotcom %} API {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". -### Writing on {% data variables.product.product_name %} +### 4. Writing on {% data variables.product.product_name %} To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. -### Searching on {% data variables.product.product_name %} +### 5. Searching on {% data variables.product.product_name %} Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)". Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/searching-on-github)". -### Managing files on {% data variables.product.product_name %} +### 6. Managing files on {% data variables.product.product_name %} With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)". If you want to edit a file in another user's repository, we'll automatically fork the repository and open a pull request for you. For more information, see "[Editing files in another user's repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository)". @@ -99,7 +79,7 @@ If you want to edit a file in another user's repository, we'll automatically for ## Part 3: Collaborating on {% data variables.product.product_name %} Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. -### Working with repositories +### 1. Working with repositories #### Creating a repository A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." @@ -115,18 +95,18 @@ You can clone your existing repository or clone another person's existing reposi A fork is a copy of a repository that you manage. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. Any changes you make in your fork will not effect the upstream repository, unless you submit a pull request to the project owner. You can still fetch updates from the original repository. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". -### Importing your projects +### 2. Importing your projects If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." -### Managing collaborators and permissions +### 3. Managing collaborators and permissions You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." -### Managing repository settings +### 4. Managing repository settings As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." -### Setting up your project for healthy contributions +### 5. Setting up your project for healthy contributions {% if currentVersion == 'free-pro-team@latest' %} To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. @@ -138,21 +118,21 @@ You can use the community profile for your public repository to ensure your proj By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} {% if currentVersion == 'free-pro-team@latest' %} -### Managing security vulnerabilities +### 6. Managing security vulnerabilities You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {% data variables.product.prodname_security_advisories %}. For more information, see “[Managing security advisories for vulnerabilities in your project](/code-security/security-advisories)." {% endif %} -### Managing project boards +### 7. Managing project boards You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." -### Managing notifications +### 8. Managing notifications Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." -### Working with {% data variables.product.prodname_pages %} +### 9. Working with {% data variables.product.prodname_pages %} You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." {% if currentVersion == 'free-pro-team@latest' %} -### Using {% data variables.product.prodname_discussions %} +### 10. Using {% data variables.product.prodname_discussions %} You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". {% endif %} ## Part 4: Customizing and automating your work on {% data variables.product.product_name %} @@ -160,27 +140,27 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi {% data reusables.getting-started.customizing-and-automating %} {% if currentVersion == 'free-pro-team@latest' %} -### Using {% data variables.product.prodname_marketplace %} +### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} {% endif %} -### Using the {% data variables.product.prodname_dotcom %} API +### {% if currentVersion == 'free-pro-team@latest' %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} -### Building {% data variables.product.prodname_actions %} +### {% if currentVersion == 'free-pro-team@latest' %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### Publishing and managing {% data variables.product.prodname_registry %} +### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 5: Building securely on {% data variables.product.product_name %} {% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)". -### Securing your repository +### 1. Securing your repository As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)". {% if currentVersion == 'free-pro-team@latest' %} -### Managing your dependencies +### 2. Managing your dependencies A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)". @@ -189,20 +169,20 @@ For more information, see "[Securing your software supply chain](/code-security/ {% data reusables.getting-started.participating-in-community %} -### Contributing to open source projects +### 1. Contributing to open source projects {% data reusables.getting-started.open-source-projects %} -### Interacting with the {% data variables.product.prodname_gcf %} +### 2. Interacting with the {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} -### Learning with {% data variables.product.prodname_learning %} +### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} {% if currentVersion == 'free-pro-team@latest' %} -### Supporting the open source community +### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} -### Contacting {% data variables.contact.github_support %} +### 5. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} ## Further reading From 98df00adf31eb3cc1391b6ca24d0ebb8ee5cf0b6 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 22 Jun 2021 17:20:58 -0400 Subject: [PATCH 16/52] Update getting-started-with-your-github-account.md Added table for ways of using GitHub, and removed some extra content --- ...etting-started-with-your-github-account.md | 34 ++++++------------- 1 file changed, 10 insertions(+), 24 deletions(-) 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 036b45fea5..cbb649c763 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 @@ -30,7 +30,7 @@ To ensure you can use all of {% data variables.product.product_name %}'s feature ### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### {% if currentVersion == 'free-pro-team@latest' %}5.{% endif %}{% if enterpriseServerVersions contains currentVersion %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph +### {% if currentVersion == 'free-pro-team@latest' %}5.{% elsif enterpriseServerVersions contains currentVersion %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes @@ -47,20 +47,14 @@ Once you install Git, you can connect to {% data variables.product.product_name Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". -#### In browser on {% data variables.product.prodname_dotcom_the_website %} -If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests. This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. -#### {% data variables.product.prodname_desktop %} -{% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)". -#### IDE or File Editor -You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](/get-started/getting-started-with-git/associating-text-editors-with-git)". -#### Command line, with or without {% data variables.product.prodname_cli %} -For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. This may be most convenient if you are already working from the command-line, allowing you to avoid switching context. As long as you have installed and configured Git on your computer, you can use Git on the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)". - -{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". - -#### {% data variables.product.prodname_dotcom %} API -{% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". +| **Method** | **Description** | **Use Cases** | +| ------------- | ------------- | ------------- | +| In browser on {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| IDE or File Editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. | +| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. As long as you have installed and configured Git on your computer, you can use Git on the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)". {% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This may be most convenient if you are already working from the command-line, allowing you to avoid switching context. | +| {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." @@ -74,8 +68,6 @@ Our search syntax allows you to construct queries using qualifiers to specify wh ### 6. Managing files on {% data variables.product.product_name %} With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)". -If you want to edit a file in another user's repository, we'll automatically fork the repository and open a pull request for you. For more information, see "[Editing files in another user's repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository)". - ## Part 3: Collaborating on {% data variables.product.product_name %} Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. @@ -87,14 +79,10 @@ A repository is like a folder for your project. You can have any number of publi When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." #### Cloning a repository -You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. - -You can clone your existing repository or clone another person's existing repository to contribute to a project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". #### Forking a repository -A fork is a copy of a repository that you manage. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. - -Any changes you make in your fork will not effect the upstream repository, unless you submit a pull request to the project owner. You can still fetch updates from the original repository. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". +A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". ### 2. Importing your projects If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." @@ -111,8 +99,6 @@ As the owner of a repository you can configure several settings, including the r To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." - -You can use the community profile for your public repository to ensure your project has all the recommended files to help people use and contribute to your project. For more information, see “[About community profiles for public repositories](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." {% endif %} {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." From 19a635fce505c1ac95cd326da7656f77e344a4af Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 23 Jun 2021 18:23:28 -0400 Subject: [PATCH 17/52] Finished github-team changes --- ...ng-started-with-github-enterprise-cloud.md | 3 + .../getting-started-with-github-team.md | 59 +++++++++++-------- ...etting-started-with-your-github-account.md | 2 +- 3 files changed, 39 insertions(+), 25 deletions(-) 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 8653ed1100..5251e28d5f 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 @@ -66,6 +66,9 @@ https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgr ### Security +### Allowed IP addresses, approved domains for email addresses + + ### Integration, customization, and automation ### Community 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 ee689334bb..a94113db5f 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -10,7 +10,7 @@ As the first steps in starting with {% data variables.product.prodname_team %}, ### Creating an organization and signing up for {% data variables.product.prodname_team %} Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)". -Once your user account is set up, you can create an organization. When you choose to create a new organization, you will be asked to pick a plan for your organization. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". ### Managing billing for an organization You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". @@ -26,53 +26,64 @@ Organizations are shared accounts where businesses and open-source projects can Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)". ## Part 2: Adding members and setting up teams +After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, project boards, and apps. +### Managing members of your organization +You can invite anyone to be a member of your organization, as long as they have a personal account on GitHub. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." ### Org-level permissions and roles -https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles - -### Managing users in the organization -https://docs.github.com/en/organizations/managing-membership-in-your-organization +Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." ### About and creating teams -https://docs.github.com/en/organizations/organizing-members-into-teams +Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." -https://docs.github.com/en/organizations/collaborating-with-your-team +You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." + +Teams can participate in team discussions on their team page to plan together, give status updates, or talk about any topic. Discussions can be open to all organization members or private to the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." ### Managing team settings -https://docs.github.com/en/organizations/managing-organization-settings? +You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." + +You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." ### Giving people and teams access to repositories, project boards and apps -https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories +You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." +You can also customize access to your organization's project boards and allow individual organization members to manage your organization's GitHub Apps. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." ## Part 3: Managing security for your organization -https://docs.github.com/en/organizations/keeping-your-organization-secure -https://docs.github.com/en/organizations/restricting-access-to-your-organizations-data +You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. -### Recommending or requiring 2FA +### Recommending or requiring two-factor authentication +You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." +### Configuring security features for your organization +You can use a variety of GitHub security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)." -### Allowed IP addresses, approved domains for email addresses +Some security features are only available for public repositories, and for private repositories owned by organizations with an Advanced Security license. For more information, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)." +### Reviewing your organization's audit log and integrations +The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." -### Audit log, integrations - - -### Security vulnerabilities in org-owned repos - +You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." ## Part 4: Setting organization level policies ### Managing organization policies -Link out to "Managing organization settings" for the full list, call out some helpful policies -https://docs.github.com/en/organizations/managing-organization-settings +You can manage permissions and policies for a number of different actions and features in your organization. -### Repos: Repo creation, visibility changes +For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)." +You can also manage the forking policy for the organization, choosing to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." -### Community: Org-level community health files, moderation tools -https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file +For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." -https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community +### Managing repository changes +You can configure permissions for creating, transferring and deleting repositories in your organization, including which types can be created by members. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." + +You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." +### Using organization-level community health files and moderation tools +You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. + +GitHub offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." ## Part 5: Customizing and automating your work on {% data variables.product.product_name %} 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 cbb649c763..b21b712916 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 @@ -173,4 +173,4 @@ For more information, see "[Securing your software supply chain](/code-security/ ## Further reading - "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" -{% endif %} +{% endif %} \ No newline at end of file From e7915043e992e3eb755bb14983ac4259729622d1 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 23 Jun 2021 18:47:18 -0400 Subject: [PATCH 18/52] Added numbering --- .../getting-started-with-github-team.md | 33 ++++++++----------- 1 file changed, 14 insertions(+), 19 deletions(-) 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 a94113db5f..ca08d8245b 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -7,12 +7,12 @@ versions: ## Part 1: Configuring your {% data variables.product.product_name %} account As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. -### Creating an organization and signing up for {% data variables.product.prodname_team %} +### 1. Creating an organization and signing up for {% data variables.product.prodname_team %} Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)". Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". -### Managing billing for an organization +### 2. Managing billing for an organization You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". @@ -20,7 +20,7 @@ Your organization's billing settings page allows you to manage settings like you {% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization' billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)". Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". -### About organizations +### 3. About organizations Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)". Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)". @@ -28,46 +28,43 @@ Organization members can stay up-to-date with recent activity or keep track of i ## Part 2: Adding members and setting up teams After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, project boards, and apps. -### Managing members of your organization +### 1. Managing members of your organization You can invite anyone to be a member of your organization, as long as they have a personal account on GitHub. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." -### Org-level permissions and roles +### 2. Organization permissions and roles Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." -### About and creating teams +### 3. About and creating teams Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." Teams can participate in team discussions on their team page to plan together, give status updates, or talk about any topic. Discussions can be open to all organization members or private to the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." -### Managing team settings +### 4. Managing team settings You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." -### Giving people and teams access to repositories, project boards and apps +### 5. Giving people and teams access to repositories, project boards and apps You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." You can also customize access to your organization's project boards and allow individual organization members to manage your organization's GitHub Apps. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." ## Part 3: Managing security for your organization You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. -### Recommending or requiring two-factor authentication +### 1. Recommending or requiring two-factor authentication You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." -### Configuring security features for your organization +### 2. Configuring security features for your organization You can use a variety of GitHub security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)." Some security features are only available for public repositories, and for private repositories owned by organizations with an Advanced Security license. For more information, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)." - -### Reviewing your organization's audit log and integrations +### 3. Reviewing your organization's audit log and integrations The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." ## Part 4: Setting organization level policies - - -### Managing organization policies +### 1. Managing organization policies You can manage permissions and policies for a number of different actions and features in your organization. For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)." @@ -75,16 +72,14 @@ For example, to protect your organization's data and number of paid licenses, yo You can also manage the forking policy for the organization, choosing to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." - -### Managing repository changes +### 2. Managing repository changes You can configure permissions for creating, transferring and deleting repositories in your organization, including which types can be created by members. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." -### Using organization-level community health files and moderation tools +### 3. Using organization-level community health files and moderation tools You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. GitHub offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." - ## Part 5: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} From 4aa161d2b652319a1aee5439bcedabe7f07f83e3 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Fri, 25 Jun 2021 15:59:08 -0400 Subject: [PATCH 19/52] Finished GitHub Enterprise Cloud draft --- ...ng-started-with-github-enterprise-cloud.md | 186 ++++++++++++++---- ...g-started-with-github-enterprise-server.md | 82 +++----- .../getting-started-with-github-team.md | 4 +- 3 files changed, 179 insertions(+), 93 deletions(-) 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 5251e28d5f..aa90cdad75 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 @@ -1,80 +1,186 @@ --- title: Getting started with GitHub Enterprise Cloud -intro: 'Get started with setting up and managing your GitHub Enterprise Cloud' +intro: 'Get started with setting up and managing your {% data variables.product.prodname_ghe_cloud %} organization or enterprise account' versions: - free-pro-team: '*' + fpt: '*' --- -### Account Types +## Part 1: Choosing your account type -GitHub provides two types of Enterprise products: +{% data variables.product.prodname_dotcom %} provides two types of Enterprise products: -- **GitHub Enterprise Cloud** -- **GitHub Enterprise Server** +- **{% data variables.product.prodname_ghe_cloud %}** +- **{% data variables.product.prodname_ghe_server %}** -The main difference between the products are that GitHub Enterprise Cloud is hosted by GitHub. +The main difference between the products is that {% data variables.product.prodname_ghe_cloud %} is hosted by {% data variables.product.prodname_dotcom %}, while {% data variables.product.prodname_ghe_server %}is self-hosted. -Within the GitHub Enterprise Cloud product, there are two different types of account that can be used: +Within the {% data variables.product.prodname_ghe_cloud %} product, there are two different types of account that you can use: -- A single org account, for example https://github.com/github, that uses GHEC -- An enterprise account on GHEC that contains multiple orgs +- A single organization account +- An enterprise account that contains multiple organizations -In either scenario, your users will use their own self-created user account and you'll invite them. +In either scenario, your users will use their own self-created user account and you'll invite them to join. +### 1. Understanding the differences between an organization account and enterprise account -#### Choosing the type of account +Both organization and enterprise accounts are available with {% data variables.product.prodname_ghe_cloud %}. An organization is a shared account where groups of people can collaborate across many projects at once, and owners and administrators can manage access to data and projects. An enterprise account enables collaboration between multiple organizations, and allows owners to centrally manage policy, billing and security for these organizations. For more information on the differences, see "[Organizations and enterprise accounts](/organizations/collaborating-with-groups-in-organizations/about-organizations#organizations-and-enterprise-accounts)." -https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations#organizations-and-enterprise-accounts +If you choose an enterprise account, keep in mind that some policies can be set only at an organization level, while others can be enforced for all organizations in an enterprise. -#### Differences +Once you choose the account type you would like, you can proceed to setting up your account. In each of the sections in this guide, proceed to either the single organization or enterprise account section based on your account type. -## Org account +## Part 2: Account setup +To get started with {% data variables.product.prodname_ghe_cloud %}, you will want to create your organization or enterprise account and set up and view billing settings, subscriptions and usage. +### Setting up a single organization account with {% data variables.product.prodname_ghe_cloud %} -### Setting up an organization account with access to GHEC +#### 1. About organizations +Organizations are shared accounts where groups of people can collaborate across many projects at once. With {% data variables.product.prodname_ghe_cloud %}, owners and administrators can manage their organization with sophisticated user authentication and management, as well as escalated support and security options. For more information, see "[About organizations](h/organizations/collaborating-with-groups-in-organizations/about-organizations)." +#### 2. Creating or upgrading an organization account -#### Creating or upgrading an organization account +To use an organization account with {% data variables.product.prodname_ghe_cloud %}, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." -To use an organization account with GHEC, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +Alternatively, if you have an existing organization account that you would like to upgrade, follow the steps in "[Upgrading your {% data variables.product.prodname_dotcom %} subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." +#### 3. Setting up and managing billing -Alternatively, if you have an existing organization account that you would like to upgrade, follow the steps in "[Upgrading your GitHub subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#upgrading-your-organizations-subscription)." +When you choose to use an organization account with {% data variables.product.prodname_ghe_cloud %}, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %} before your trial ends, your organization will be downgraded to {% data variables.product.prodname_free_user %} and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." -#### Billing for GHEC +If you do decide to purchase {% data variables.product.prodname_ghe_cloud %}, you'll need to set up your billing account. Your organization's billing settings page allows you to manage settings like your payment method, billing email and billing cycle, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and {% data variables.product.prodname_actions %} minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". -When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." +Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". -If you do decide to purchase GHEC, you'll need to set up your billing account. +### Setting up an enterprise account with {% data variables.product.prodname_ghe_cloud %} +In order to get an enterprise account created for you, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). +#### 1. About enterprise accounts +An enterprise account allows you to centrally manage policy and settings for multiple {% data variables.product.prodname_dotcom %} organizations, including member access, billing and usage and security. For more information, see "[About enterprise accounts](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/about-enterprise-accounts)." +#### 2. Adding organizations to your account +You can create new organizations to manage within your enterprise account. For more information, see "[Adding organizations to your enterprise](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/adding-organizations-to-your-enterprise-account)." -- Manage Billing -- Setting a billing manage -- Setting a billing email. +Contact your {% data variables.product.prodname_dotcom %} sales account representative if you want to transfer an existing organization to your enterprise account. +#### 3. Viewing the subscription and usage for your enterprise account +You can view your current subscription, license usage, invoices, payment history, and other billing information for your enterprise account at any time. Both enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Viewing the subscription and usage for your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." +## Part 3: Managing users and teams with {% data variables.product.prodname_ghe_cloud %} -### Managing users and teams +### Managing users and teams for an organization +You can set permissions and member roles, create and manage teams, and give people access to repositories in your organization. +#### 1. Managing members of your organization +You can invite anyone to be a member of your organization, as long as they have a personal account on {% data variables.product.prodname_dotcom %}. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." +#### 2. Organization permissions and roles +Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." +#### 3. About and creating teams +Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." -### Security +You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." -If you upgraded your organization to {% data variables.product.prodname_ghe_cloud %}, you can set up identity and access management for your organization. For more information, see "[Managing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization)." +Teams can participate in team discussions on their team page to plan together, give status updates, or talk about any topic. Discussions can be open to all organization members or private to the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." +#### 4. Managing team settings +You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." -https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#next-steps-for-organizations-using-github-enterprise-cloud +You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." +#### 5. Giving people and teams access to repositories, project boards and apps +You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." -### Other Settings +You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." -## Enterprise account +### Managing members of an enterprise account +Managing members of an enterprise is separate from managing members or teams in an organization. It is important to note that enterprise owners or administrators cannot access organization-level settings or manage users for organizations in their enterprise unless they are made an organization owner. For more information on managing users and teams for organizations, see the above section, "[Managing users and teams for an organization](#managing-users-and-teams-for-an-organization)." +#### 1. Assigning roles in an enterprise +By default, everyone in an enterprise is a member of the enterprise. There are also administrative roles, including enterprise owner and billing manager, that have different levels of access to enterprise settings and data. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)." +#### 2. Inviting people to manager your enterprise +You can invite people to manage your enterprise as enterprise owners or billing managers, as well as remove those who no longer need access. For more information, see "[Inviting people to manage your enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)." -### Creating an enterprise account with multiple orgs +You can also grant enterprise members the ability to manage support tickets in the support portal. For more information, see "[Managing support entitlements for your enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." +#### 3. Viewing people in your enterprise +To audit access to enterprise-owned resources or user license usage, you can view every enterprise administrator, enterprise member, and outside collaborator in your enterprise. You can see the organizations that a member belongs to and the specific repositories that an outside collaborator has access to. For more information, see "[Viewing people in your enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/viewing-people-in-your-enterprise)." -### Managing users +## Part 4: Managing security with {% data variables.product.prodname_ghe_cloud %} -### Security +### Managing security for a single organization +#### 1. Recommending or requiring two-factor authentication +You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." -### Allowed IP addresses, approved domains for email addresses +#### 2. Configuring security features for your organization +You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +Some security features are only available for public repositories, and for private repositories owned by organizations with an Advanced Security license. For more information, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)." +#### 3. Reviewing your organization's audit log and integrations +The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." -### Integration, customization, and automation +You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." +#### 4. Enabling and enforcing SAML single sign-on for your organization +If you manage your users' identities and applications with an identity provider (IdP), you can configure SAML single-sign-on (SSO) to control and secure access to organization resources like repositories, issues and pull requests. When members of your organization access organization resources that use SAML SSO, {% data variables.product.prodname_dotcom %} will redirect them to your IdP to authenticate. For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." -### Community +Organization owners can choose to disable, enable but not enforce, or enable and enforce SAML SSO. For more information, see "[Enabling and testing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization)" and "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." +#### 5. Managing team synchronization for your organization +Organization owners can enable team synchronization between your identity provider (IdP) and {% data variables.product.prodname_dotcom %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. For more information, see "[Managing team synchronization for your organization](h/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." -### Other Settings +### Managing security for an enterprise account with multiple organizations -#### Single org -#### Enterprise account +#### 1. Requiring two-factor authentication and managing allowed IP addresses for organizations in your enterprise account +Enterprise owners can require that organization members, billing managers, and outside collaborators in all organizations owned by an enterprise account use two-factor authentication to secure their personal accounts. Before doing so, we recommend notifying all who have access to organizations in your enterprise. You can also configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information on enforcing two-factor authentication and allowed IP address lists, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)." +#### 2. Enabling and enforcing SAML single sign-on for organizations in your enterprise account +You can centrally manage access to your enterprise's resources, organization membership and team membership using your IdP and SAM single sign-on (SSO). Enterprise owners can enable SAML SSO across all organizations owned by an enterprise account. For more information, see "[About identity and access management for your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/about-identity-and-access-management-for-your-enterprise-account)". +#### 3. Managing team synchronization +You can enable and manage team sychronization between an identity provider (IdP) and {% data variables.product.prodname_dotcom %} to allow organizations owned by your enterprise account to manage team membership with IdP groups. For more information, see "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/managing-team-synchronization-for-organizations-in-your-enterprise-account)." + +#### 4. Enforcing policies for Advanced Security features in your enterprise account +If you have a GitHub Advanced Security license for your enterprise account, you can enforce policies to manage {% data variables.product.prodname_dotcom %} Advanced Security features for organizations owned by an enterprise account. For more information, see "[Enforcing policies for Advanced Security in your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-policies-for-advanced-security-in-your-enterprise-account)." + +## Part 5: Managing organization and enterprise level policies and settings + +### Managing settings for a single organization +#### 1. Managing organization policies +You can manage permissions and policies for a number of different actions and features in your organization. + +For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)." + +You can also manage the forking policy for the organization, choosing to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." + +For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." +#### 2. Managing repository changes +You can configure permissions for creating, transferring and deleting repositories in your organization, including which types can be created by members. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." + +You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." +#### 3. Using organization-level community health files and moderation tools +You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. + +{% data variables.product.prodname_dotcom %} offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." + +### Managing settings for an enterprise account +#### 1. Managing policies for organizations in your enterprise account + +You can choose to enforce a number of policies for all organizations owned by your enterprise, or choose to allow these policies to be set in each organization. Types of policies you can enforce include repository management, project board, and team policies. For more information, see "[Set organization policies](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account)." +#### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise +You can view actions from all of the organizations owned by your enterprise account in the enterprise audit log. You can also configure webhooks to receive events from organizations owned by your enterprise account. For more information, see "[Viewing the audit logs for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/viewing-the-audit-logs-for-organizations-in-your-enterprise-account)" and "[Configuring webooks for organization events in your enterprise](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account)." + +You can also restrict email notifications for your enterprise account so that enterprise members can only use an email address in a verified or approved domain to receive notifications. For more information, see "[Restricting email notifications for your enterprise account](https://docs.github.com/en/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/restricting-email-notifications-for-your-enterprise-account)." + +## Part 6: Customizing and automating your organization or enterprise's work on {% data variables.product.prodname_dotcom %} +{% data reusables.getting-started.customizing-and-automating %} + +### 1. Using {% data variables.product.prodname_marketplace %} +{% data reusables.getting-started.marketplace %} +### 2. Using the {% data variables.product.prodname_dotcom %} API +{% data reusables.getting-started.api %} +### 3. Building {% data variables.product.prodname_actions %} +{% data reusables.getting-started.actions %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} +{% data reusables.getting-started.packages %} +## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community + +{% data reusables.getting-started.participating-in-community %} +### 1. Contributing to open source projects +{% data reusables.getting-started.open-source-projects %} + +### 2. Interacting with the {% data variables.product.prodname_gcf %} +{% data reusables.support.ask-and-answer-forum %} + +### 3. Learning with {% data variables.product.prodname_learning %} +{% data reusables.getting-started.learning-lab %} +### 4. Supporting the open source community +{% data reusables.getting-started.sponsors %} + +### 5. 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 a02fcdbd85..18d8dd9878 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 @@ -5,8 +5,6 @@ versions: enterprise-server: '*' --- -### Account Types - GitHub provides two types of Enterprise products: - **GitHub Enterprise Cloud** @@ -14,61 +12,43 @@ GitHub provides two types of Enterprise products: The main difference between the products are that GitHub Enterprise Server is hosted by GitHub. -Within the GitHub Enterprise Server product, there are two different types of account that can be used: +## Installing GitHub Enterprise -- A single org account, for example https://github.com/github, that uses GHEC -- An enterprise account on GHEC that contains multiple orgs +Installation content +Management console +Settings: Follow the steps in the installation guide to configure as you want to +High availability +Backups and disaster recoery +Geo-replication +## Security -In either scenario, your users will use their own self-created user account and you'll invite them. +Authenticating users +Compliance +## Organizing your team -#### Choosing the type of account +Explain the types of settings +Creating organizations +Setting permission levels +Adding members to organizations +Creating teams +Giving teams access to repos +## Development and developer workflows -https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations#organizations-and-enterprise-accounts +Git authentication methods +Repository management, permissions, and repo settings +Secure development features -#### Differences +## Integration, customization, automation -## Org account +Apps +API +## Connecting with other GitHub resources -### Setting up an organization account with access to GHEC +If using Cloud, can use GitHub Connect +GitHub Insights +## Learning and support -#### Creating or upgrading an organization account - -To use an organization account with GHEC, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." - - -#### Billing for GHES - -When you choose to use an organization account with GitHub Enterprise Cloud, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase GitHub Enterprise or GitHub Team before your trial ends, your organization will be downgraded to GitHub Free and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." - -If you do decide to purchase GHEC, you'll need to set up your billing account. - -- Manage Billing -- Setting a billing manage -- Setting a billing email. - - -### Managing users and teams - -### Security - -https://docs.github.com/en/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#next-steps-for-organizations-using-github-enterprise-cloud - -### Other Settings - -## Enterprise account - -### Creating an enterprise account with multiple orgs - -### Managing users - -### Security - -### Integration, customization, and automation - -### Community - -### Other Settings - -#### Single org -#### Enterprise account +Social resources including forum +Support +Learning 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 ca08d8245b..da03f943ef 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -55,7 +55,7 @@ You can help to make your organization more secure by recommending or requiring You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." ### 2. Configuring security features for your organization -You can use a variety of GitHub security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)." +You can use a variety of GitHub security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." Some security features are only available for public repositories, and for private repositories owned by organizations with an Advanced Security license. For more information, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)." ### 3. Reviewing your organization's audit log and integrations @@ -117,6 +117,6 @@ GitHub offers multiple tools for moderating and managing your community. For mor {% endif %} {% if currentVersion == 'free-pro-team@latest' %} -### Further reading +## Further reading - "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" {% endif %} \ No newline at end of file From 30b48257e9d6c42b6225f86f2890ff844d3e0d8d Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Fri, 25 Jun 2021 16:15:21 -0400 Subject: [PATCH 20/52] Updated to latest versions of versioning --- ...ng-started-with-github-enterprise-cloud.md | 2 +- ...g-started-with-github-enterprise-server.md | 2 +- .../getting-started-with-github-team.md | 14 ++++---- ...etting-started-with-your-github-account.md | 34 +++++++++---------- 4 files changed, 26 insertions(+), 26 deletions(-) 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 aa90cdad75..3d878a4a30 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 @@ -79,7 +79,7 @@ You can manage code review assignments for your team, change team visibility, ma #### 5. Giving people and teams access to repositories, project boards and apps You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." -You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." +You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." ### Managing members of an enterprise account Managing members of an enterprise is separate from managing members or teams in an organization. It is important to note that enterprise owners or administrators cannot access organization-level settings or manage users for organizations in their enterprise unless they are made an organization owner. For more information on managing users and teams for organizations, see the above section, "[Managing users and teams for an organization](#managing-users-and-teams-for-an-organization)." 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 18d8dd9878..6658795024 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 @@ -2,7 +2,7 @@ title: Getting started with GitHub Enterprise Server intro: 'Get started with setting up and managing your GitHub Enterprise Server instance' versions: - enterprise-server: '*' + ghes: '*' --- GitHub provides two types of Enterprise products: 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 da03f943ef..fd60eeccb6 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -2,7 +2,7 @@ title: Getting started with GitHub Team intro: 'With {% data variables.product.prodname_team %} groups of people can collaborate across many projects at the same time in an organization account.' versions: - free-pro-team: '*' + fpt: '*' --- ## Part 1: Configuring your {% data variables.product.product_name %} account As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. @@ -84,17 +84,17 @@ GitHub offers multiple tools for moderating and managing your community. For mor {% data reusables.getting-started.customizing-and-automating %} -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} {% endif %} -### {% if currentVersion == 'free-pro-team@latest' %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API +### {% ifversion fpt %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} -### {% if currentVersion == 'free-pro-team@latest' %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} +### {% ifversion fpt %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} +### {% ifversion fpt %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community @@ -108,7 +108,7 @@ GitHub offers multiple tools for moderating and managing your community. For mor ### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} @@ -116,7 +116,7 @@ GitHub offers multiple tools for moderating and managing your community. For mor {% data reusables.getting-started.contact-support %} {% endif %} -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ## Further reading - "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" {% endif %} \ No newline at end of file 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 b21b712916..7d7a5cdf90 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 @@ -2,9 +2,9 @@ title: Getting started with your GitHub account intro: 'With an account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' versions: - free-pro-team: '*' - enterprise-server: '*' - github-ae: '*' + fpt: '*' + ghes: '*' + ghae: '*' --- ## Part 1: Configuring your {% data variables.product.prodname_dotcom %} account @@ -21,16 +21,16 @@ You can choose {% data variables.product.prodname_free_user %} or {% data variab For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 3. Verifying your email address To ensure you can use all of {% data variables.product.product_name %}'s features, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} -{% if currentVersion == 'free-pro-team@latest' or enterpriseServerVersions contains currentVersion %} -### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Configuring two-factor authentication +{% ifversion fpt or ghes %} +### {% ifversion fpt %}4.{% else %}3.{% endif %} Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### {% if currentVersion == 'free-pro-team@latest' %}5.{% elsif enterpriseServerVersions contains currentVersion %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph +### {% ifversion fpt %}5.{% elsif ghes %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes @@ -95,15 +95,15 @@ You are the owner of any repository you create in your user account and have ful As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." ### 5. Setting up your project for healthy contributions -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} -{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +{% ifversion ghes or ghae %} By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 6. Managing security vulnerabilities You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {% data variables.product.prodname_security_advisories %}. For more information, see “[Managing security advisories for vulnerabilities in your project](/code-security/security-advisories)." {% endif %} @@ -117,7 +117,7 @@ Notifications provide updates about the activity on {% data variables.product.pr ### 9. Working with {% data variables.product.prodname_pages %} You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 10. Using {% data variables.product.prodname_discussions %} You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". {% endif %} @@ -125,17 +125,17 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi {% data reusables.getting-started.customizing-and-automating %} -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} {% endif %} -### {% if currentVersion == 'free-pro-team@latest' %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API +### {% ifversion fpt %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} -### {% if currentVersion == 'free-pro-team@latest' %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} +### {% ifversion fpt %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### {% if currentVersion == 'free-pro-team@latest' %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} +### {% ifversion fpt %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ## Part 5: Building securely on {% data variables.product.product_name %} @@ -145,7 +145,7 @@ As a repository administrator, you can secure your repositories by configuring r For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)". -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 2. Managing your dependencies A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. @@ -164,7 +164,7 @@ For more information, see "[Securing your software supply chain](/code-security/ ### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -{% if currentVersion == 'free-pro-team@latest' %} +{% ifversion fpt %} ### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} From d09879f6fa01ce5dcc9cad41499bc131186c32c8 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Fri, 25 Jun 2021 16:28:05 -0400 Subject: [PATCH 21/52] fix failing tests --- .../getting-started-with-github-enterprise-cloud.md | 6 +++--- .../getting-started-with-github-enterprise-server.md | 1 - data/reusables/getting-started/api.md | 2 +- data/reusables/getting-started/open-source-projects.md | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) 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 3d878a4a30..42d16d8c06 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 @@ -33,7 +33,7 @@ To get started with {% data variables.product.prodname_ghe_cloud %}, you will wa ### Setting up a single organization account with {% data variables.product.prodname_ghe_cloud %} #### 1. About organizations -Organizations are shared accounts where groups of people can collaborate across many projects at once. With {% data variables.product.prodname_ghe_cloud %}, owners and administrators can manage their organization with sophisticated user authentication and management, as well as escalated support and security options. For more information, see "[About organizations](h/organizations/collaborating-with-groups-in-organizations/about-organizations)." +Organizations are shared accounts where groups of people can collaborate across many projects at once. With {% data variables.product.prodname_ghe_cloud %}, owners and administrators can manage their organization with sophisticated user authentication and management, as well as escalated support and security options. For more information, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations)." #### 2. Creating or upgrading an organization account To use an organization account with {% data variables.product.prodname_ghe_cloud %}, you will first need to create an organization. When prompted to choose a plan, select "Enterprise". For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." @@ -111,7 +111,7 @@ If you manage your users' identities and applications with an identity provider Organization owners can choose to disable, enable but not enforce, or enable and enforce SAML SSO. For more information, see "[Enabling and testing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization)" and "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." #### 5. Managing team synchronization for your organization -Organization owners can enable team synchronization between your identity provider (IdP) and {% data variables.product.prodname_dotcom %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. For more information, see "[Managing team synchronization for your organization](h/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." +Organization owners can enable team synchronization between your identity provider (IdP) and {% data variables.product.prodname_dotcom %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." ### Managing security for an enterprise account with multiple organizations @@ -153,7 +153,7 @@ You can choose to enforce a number of policies for all organizations owned by yo #### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise You can view actions from all of the organizations owned by your enterprise account in the enterprise audit log. You can also configure webhooks to receive events from organizations owned by your enterprise account. For more information, see "[Viewing the audit logs for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/viewing-the-audit-logs-for-organizations-in-your-enterprise-account)" and "[Configuring webooks for organization events in your enterprise](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account)." -You can also restrict email notifications for your enterprise account so that enterprise members can only use an email address in a verified or approved domain to receive notifications. For more information, see "[Restricting email notifications for your enterprise account](https://docs.github.com/en/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/restricting-email-notifications-for-your-enterprise-account)." +You can also restrict email notifications for your enterprise account so that enterprise members can only use an email address in a verified or approved domain to receive notifications. For more information, see "[Restricting email notifications for your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/restricting-email-notifications-for-your-enterprise-account)." ## Part 6: Customizing and automating your organization or enterprise's work on {% data variables.product.prodname_dotcom %} {% data reusables.getting-started.customizing-and-automating %} 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 6658795024..3e0396fde7 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 @@ -39,7 +39,6 @@ Repository management, permissions, and repo settings Secure development features ## Integration, customization, automation - Apps API ## Connecting with other GitHub resources diff --git a/data/reusables/getting-started/api.md b/data/reusables/getting-started/api.md index 2ad31e237f..50a877f742 100644 --- a/data/reusables/getting-started/api.md +++ b/data/reusables/getting-started/api.md @@ -1 +1 @@ -There are two versions of the {% data variables.product.prodname_dotcom %} API: the REST API and the GraphQL API. You can use the {% data variables.product.prodname_dotcom %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% if currentVersion == 'free-pro-team@latest' %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.prodname_dotcom %}'s APIs](/developers/overview/about-githubs-apis)". \ No newline at end of file +There are two versions of the {% data variables.product.prodname_dotcom %} API: the REST API and the GraphQL API. You can use the {% data variables.product.prodname_dotcom %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% ifversion fpt %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.prodname_dotcom %}'s APIs](/developers/overview/about-githubs-apis)". \ No newline at end of file diff --git a/data/reusables/getting-started/open-source-projects.md b/data/reusables/getting-started/open-source-projects.md index a18a6b1433..071f139635 100644 --- a/data/reusables/getting-started/open-source-projects.md +++ b/data/reusables/getting-started/open-source-projects.md @@ -1,4 +1,4 @@ Contributing to open source projects on {% data variables.product.prodname_dotcom %} can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. For more information, see “[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)" in the Open Source Guides. -You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% if currentVersion == 'free-pro-team@latest' %} For more information, see “[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% ifversion fpt %} For more information, see “[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." {% endif %} \ No newline at end of file From 622958dfe93f0df6e65414af9320536e1967b337 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Mon, 28 Jun 2021 10:58:18 -0400 Subject: [PATCH 22/52] Finished GHES guide and cut some text --- ...g-started-with-github-enterprise-server.md | 134 +++++++++++++----- ...etting-started-with-your-github-account.md | 20 ++- 2 files changed, 106 insertions(+), 48 deletions(-) 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 3e0396fde7..132046be3e 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 @@ -1,53 +1,115 @@ --- title: Getting started with GitHub Enterprise Server -intro: 'Get started with setting up and managing your GitHub Enterprise Server instance' +intro: 'Get started with setting up and managing your {% data variables.product.prodname_ghe_server %} instance.' versions: ghes: '*' --- -GitHub provides two types of Enterprise products: +{% data variables.product.prodname_dotcom %} provides two types of Enterprise products: -- **GitHub Enterprise Cloud** -- **GitHub Enterprise Server** +- **{% data variables.product.prodname_ghe_cloud %}** +- **{% data variables.product.prodname_ghe_server %}** -The main difference between the products are that GitHub Enterprise Server is hosted by GitHub. +The main difference between the products is that {% data variables.product.prodname_ghe_cloud %} is hosted by {% data variables.product.prodname_dotcom %}, while {% data variables.product.prodname_ghe_server %} is self-hosted. -## Installing GitHub Enterprise +For an overview of how {% data variables.product.prodname_ghe_server %} works, see "[System overview](/admin/overview/system-overview?learn=deploy_an_instance)." -Installation content -Management console -Settings: Follow the steps in the installation guide to configure as you want to -High availability -Backups and disaster recoery -Geo-replication -## Security +## Part 1: Installing {% data variables.product.prodname_ghe_server %} +To get started with {% data variables.product.prodname_ghe_server %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. +### 1. Creating your enterprise account +Before install {% data variables.product.prodname_ghe_server %}, you will first need to create an enterprise account on GitHub. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +### 2. Installing a {% data variables.product.prodname_ghe_server %} instance +To get started with {% data variables.product.prodname_ghe_server %}, you will need to install your instance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." -Authenticating users -Compliance -## Organizing your team +### 3. Using the Management Console +You will use the Management Console to walk through the initial setup process when first launching your instance. You can also use it to manage virtual appliance settings such as the domain, authentication and SSL. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." -Explain the types of settings -Creating organizations -Setting permission levels -Adding members to organizations -Creating teams -Giving teams access to repos -## Development and developer workflows +### 4. Configuring your {% data variables.product.prodname_ghe_server %} instance +In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage your enterprise. You can configure applications and rate limits, view reports, use command-line utilities, and much more. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise).' -Git authentication methods -Repository management, permissions, and repo settings -Secure development features +You can use the default network settings used by {% data variables.product.prodname_ghe_server %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." -## Integration, customization, automation -Apps -API -## Connecting with other GitHub resources +### 5. Configuring high availability +You can configure your {% data variables.product.prodname_ghe_server %} instance for high availability so that any hardware failures or major network outages don't disrupt service. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." -If using Cloud, can use GitHub Connect -GitHub Insights -## Learning and support +### 6. Designating backups and disaster recovery +You can use {% data variables.product.prodname_ghe_server %} Backup Utilities to configure automated backups of your {% data variables.product.prodname_ghe_server %} instance, so that you can protect your production data. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." -Social resources including forum -Support -Learning +### 7. Geo-replication +{% data variables.product.prodname_ghe_server %} can help to reduce latency between different hosts and locations, if your organization has offices in multiple locations. For more information, see "[About geo-replication](/admin/enterprise-management/configuring-high-availability/about-geo-replication)." +### 8. Managing billing for your enterprise +Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +## Part 2: Organizing and managing your team +As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. + +### 1. Managing users of your enterprise instance +You can manage user settings and audit user activity in your enterprise, including promoting a user to a site administrator, managing dormant and suspended users, and customizing messages that users will see on your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." + +### 2. Creating organizations +You can create new organizations in your enterprise to reflect your company or group's structure. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." + +### 3. Adding members to organizations +You can add members to organizations in your enterprise as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "[Adding people to your organization](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)" and "[Configuring visibility for organization membership](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)." + +### 4. Creating teams +Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "[Creating teams](/admin/user-management/managing-organizations-in-your-enterprise/creating-teams)" and "[Adding people to teams](/admin/user-management/managing-organizations-in-your-enterprise/adding-people-to-teams)." + +### 5. Setting organization and repository permission levels +We recommend giving a limited number of members in each organization an organization owner role, which provides complete administrative access for that organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." + +For organizations where you have admin permissions, you can also customize access to each repository with granular permission levels. For more information, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." + +### 6. Enforcing repository management policies + As an enterprise owner, you can set repository management policies for all organizations in your enterprise, or allow policies to be set in each organization. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." + +## Part 3: Building securely +To make your enterprise as secure as possible, you can configure authentication for users, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable {% data variables.product.prodname_GH_advanced_security %}. +### 1. Authenticating users +You can use {% data variables.product.prodname_ghe_server %}'s built-in authentication method, or you can choose between an established authentication provider, such as CAS, LDAP, or SAML, to integrate your existing accounts and centrally manage user access to your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Authenticating users for your {% data variables.product.prodname_ghe_server %} instance](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance)." + +You can also require two-factor authentication for each of your organizations. For more information, see "[Requiring two factor authentication for an organization](/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization)." + +### 2. Staying in compliance +You can implement required status checks ands commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/enterprise-server@3.1/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." + +#### 3. Configuring security features for your organizations +You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +### 4. Enabling {% data variables.product.prodname_GH_advanced_security %} features +You can upgrade your {% data variables.product.prodname_ghe_server %} license to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see "[{% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." + +## Part 4: Customizing and automating your enterprise's work on {% data variables.product.prodname_dotcom %} +You can customize and automate work in organizations in your enterprise with {% data variables.product.prodname_dotcom %} and {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}. + +### 1. Building {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} +You can build integrations with the {% data variables.product.prodname_dotcom %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. For more information, see "[About apps](/developers/apps/getting-started-with-apps/about-apps)." +### 2. Using the {% data variables.product.prodname_dotcom %} API +{% data reusables.getting-started.api %} +### 3. Building {% data variables.product.prodname_actions %} +{% data reusables.getting-started.actions %} + +For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." + +### 4. Publishing and managing {% data variables.product.prodname_registry %} +{% data reusables.getting-started.packages %} + +For more information on enabling and configuring {% data variables.product.prodname_registry %} for your {% data variables.product.prodname_ghe_server %} instance, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)." +### 5. Using {% data variables.product.prodname_pages %} +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." + +## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources +You can use {% data variables.product.prodname_github_connect %} and {% data variables.product.prodname_insights %} to share resources and understand and improve your processes. + +### 1. Enabling {% data variables.product.prodname_github_connect %} +If you are the owner of both a {% data variables.product.prodname_ghe_server %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between your {% data variables.product.prodname_ghe_server %} instance and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." +### 2. Using {% data variables.product.prodname_insights %} +{% data variables.product.prodname_insights %} is a standalone application that provides analytic reports and metrics based on data from your {% data variables.product.prodname_ghe_server %} instance. You can use these reports to understand and improve your software delivery process. For more information, see "[About {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/installing-and-updating-github-insights/about-github-insights)." + +## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources +Your users 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 your {% data variables.product.prodname_ghe_server %} instance with {% data variables.product.prodname_dotcom %} Enterprise Support. +### 1. Learning with {% data variables.product.prodname_learning %} +Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} 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. Working with {% data variables.product.prodname_dotcom %} Enterprise Support +{% data variables.product.prodname_ghe_server %} includes access to {% data variables.product.prodname_dotcom %} Enterprise Support. {% data variables.product.prodname_dotcom %} Enterprise Support can help you troubleshoot issues that come up on {% data variables.product.prodname_ghe_server %}. You can also choose to sign up for {% data variables.product.prodname_dotcom %} Premium Support for additional features. For more information, see "[About {% data variables.product.prodname_dotcom %} Enterprise Support](/admin/enterprise-support/overview/about-github-enterprise-support)." 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 7d7a5cdf90..313f953031 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 @@ -51,9 +51,9 @@ For more information about how to authenticate to {% data variables.product.prod | **Method** | **Description** | **Use Cases** | | ------------- | ------------- | ------------- | | In browser on {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. | -| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. It allows you to complete most Git commands from your desktop, with visual confirmation of changes you and others have made. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or File Editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git. You can also use extensions and view or change the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line and complete Git commands in the editor. | -| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. As long as you have installed and configured Git on your computer, you can use Git on the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)". {% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This may be most convenient if you are already working from the command-line, allowing you to avoid switching context. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| IDE or File Editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)".

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | | {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." @@ -103,22 +103,18 @@ By adding files like contributing guidelines, a code of conduct, and a license t {% ifversion ghes or ghae %} By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} -{% ifversion fpt %} -### 6. Managing security vulnerabilities -You can discover, discuss, fix, and disclose security vulnerabilities in your repositories with security policies and {% data variables.product.prodname_security_advisories %}. For more information, see “[Managing security advisories for vulnerabilities in your project](/code-security/security-advisories)." -{% endif %} -### 7. Managing project boards -You can use project boards to organize your work with issues and pull requests and manage your workflow across repositories. You can create project boards for specific feature work, comprehensive roadmaps, or even release checklists. Project boards give you the flexibility to create customized workflows that suit your needs. For more information, see "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +### 6. Using GitHub Issues and project boards +You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and [About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." -### 8. Managing notifications +### 7. Managing notifications Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." -### 9. Working with {% data variables.product.prodname_pages %} +### 8. Working with {% data variables.product.prodname_pages %} You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." {% ifversion fpt %} -### 10. Using {% data variables.product.prodname_discussions %} +### 9. Using {% data variables.product.prodname_discussions %} You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". {% endif %} ## Part 4: Customizing and automating your work on {% data variables.product.product_name %} From 2fc736ff1e93d790d8df9eb64d2e55a5ea4fd463 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Mon, 28 Jun 2021 11:29:18 -0400 Subject: [PATCH 23/52] Cutting some text from GHEC --- ...tting-started-with-github-enterprise-cloud.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) 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 42d16d8c06..f3e2560ff5 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 @@ -168,19 +168,15 @@ You can also restrict email notifications for your enterprise account so that en {% data reusables.getting-started.packages %} ## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community -{% data reusables.getting-started.participating-in-community %} -### 1. Contributing to open source projects -{% data reusables.getting-started.open-source-projects %} +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 %} +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. -### 2. Interacting with the {% data variables.product.prodname_gcf %} -{% data reusables.support.ask-and-answer-forum %} - -### 3. Learning with {% data variables.product.prodname_learning %} -{% data reusables.getting-started.learning-lab %} -### 4. Supporting the open source community +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 {% data reusables.getting-started.sponsors %} -### 5. Contacting {% data variables.contact.github_support %} +### 3. 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)." From 4ad702d0dcde6c9a6cdc905c48c6fe74854c57e6 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Tue, 29 Jun 2021 07:39:40 -0400 Subject: [PATCH 24/52] Apply suggestions from code review Co-authored-by: Felicity Chapman --- ...getting-started-with-your-github-account.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) 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 313f953031..a6c6505105 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 @@ -8,9 +8,15 @@ versions: --- ## Part 1: Configuring your {% data variables.product.prodname_dotcom %} account -As the first steps in starting with {% data variables.product.product_name %}, you'll need to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. +{% ifversion fpt %} +The first steps in starting with {% data variables.product.product_name %} are to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. +{% elsif ghes %} +The first steps in starting with {% data variables.product.product_name %}, are to access your account, set up two-factor authentication, and view your profile. +{% elsif ghae %} +The first steps in starting with {% data variables.product.product_name %}, are to access your account and view your profile. +{% endif %} -There are several types of accounts on {% data variables.product.prodname_dotcom %}. Every person who uses {% data variables.product.product_location %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +{% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif}Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. ### 1. Creating an account To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. @@ -23,7 +29,7 @@ For more information on all of {% data variables.product.prodname_dotcom %}'s pl {% ifversion fpt %} ### 3. Verifying your email address -To ensure you can use all of {% data variables.product.product_name %}'s features, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." +To ensure you can use all of the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% ifversion fpt or ghes %} @@ -48,9 +54,9 @@ Everyone has their own unique workflow for interacting with {% data variables.pr For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". -| **Method** | **Description** | **Use Cases** | +| **Method** | **Description** | **Use cases** | | ------------- | ------------- | ------------- | -| In browser on {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. | +| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. | | {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | | IDE or File Editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | | Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)".

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | @@ -169,4 +175,4 @@ For more information, see "[Securing your software supply chain](/code-security/ ## Further reading - "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)" -{% endif %} \ No newline at end of file +{% endif %} From 6611ba6a47be9829646a5e7d8818282cb334f328 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 29 Jun 2021 07:40:35 -0400 Subject: [PATCH 25/52] Create getting-started-with-github-ae.md --- .../getting-started-with-github-ae.md | 84 +++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 content/get-started/onboarding/getting-started-with-github-ae.md diff --git a/content/get-started/onboarding/getting-started-with-github-ae.md b/content/get-started/onboarding/getting-started-with-github-ae.md new file mode 100644 index 0000000000..a433143b87 --- /dev/null +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -0,0 +1,84 @@ +--- +title: Getting started with GitHub AE +intro: 'Get started with setting up and configuring {% data variables.product.prodname_ghe_managed %} for your enterprise.' +versions: + ghae: '*' +--- + +## Part 1: Setting up {% data variables.product.prodname_ghe_managed %} +To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. + +### 1. Creating your {% data variables.product.prodname_ghe_managed %} enterprise account +You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [GitHub's Sales team](/admin/configuration/configuring-your-enterprise/initializing-github-ae). + +After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in GitHub Enterprise Support to create an account. + +### 2. Initializing {% data variables.product.prodname_ghe_managed %} +When your {% data variables.product.prodname_ghe_managed %} enterprise account has been created, you will receive an email to log into GitHub AE and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." + +### 3. Restricting network traffic +You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." + +### 4. Managing identity and access for your enterprise +You can centrally manage access to GitHub AE from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure it, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." + +### 5. Managing billing for your enterprise +Enterprise owners can view billing information for GitHub AE. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." + +## Part 2: Organizing and managing your users +As an enterprise owner for GitHub AE, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. + +### 1. Managing and auditing users of your enterprise +You can manage user settings and audit user activity in your enterprise, including managing dormant users, viewing the audit log for user activity in your enterprise, and customizing messages that users will see on your enterprise. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." + +### 2. Creating organizations +You can create new organizations in your enterprise to reflect your company or group's structure. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." + +### 3. Adding members to organizations +You can add members to organizations in your enterprise as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "[Adding people to your organization](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)" and "[Configuring visibility for organization membership](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)." + +### 4. Creating teams +Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "[Creating teams](/organizations/organizing-members-into-teams/creating-a-team)" and "[Adding people to teams](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)." + +### 5. Setting organization and repository permission levels +We recommend giving a limited number of members in each organization an organization owner role, which provides complete administrative access for that organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." + +For organizations where you have admin permissions, you can also customize access to each repository with granular permission levels. For more information, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." + +### 6. Enforcing repository management policies +As an enterprise owner, you can set repository management policies for all organizations in your enterprise, or allow policies to be set in each organization. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." + +## Part 3: Building securely +To make your enterprise as secure as possible, you can monitor your enterprise and configure security and analysis features for your organizations. + +### 1. Monitoring your enterprise +You can monitor your application with you activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." + +### 2. Configuring security features for your organizations +You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." + +## Part 4: Customizing and automating your enterprise's work on {% data variables.product.prodname_dotcom %} +You can customize and automate work in organizations in your enterprise with the {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, and {% data variables.product.prodname_pages %}. + +### 2. Using the {% data variables.product.prodname_dotcom %} API +{% data reusables.getting-started.api %} + +### 3. Building {% data variables.product.prodname_actions %} +{% data reusables.getting-started.actions %} + +For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." + +### 4. Using {% data variables.product.prodname_pages %} +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." + + +## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources +Your users 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 your {% data variables.product.prodname_ghe_server %} instance with {% data variables.product.prodname_dotcom %} Enterprise Support. + +### 1. Learning with {% data variables.product.prodname_learning %} +Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} 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. Working with {% data variables.product.prodname_dotcom %} Enterprise Support +{% data variables.product.prodname_ghe_managed %} includes access to {% data variables.product.prodname_dotcom %} Enterprise Support. {% data variables.product.prodname_dotcom %} Enterprise Support can help you troubleshoot issues that come up on {% data variables.product.prodname_ghe_managed %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Enterprise Support](/admin/enterprise-support/overview/about-github-enterprise-support)." From 4281ef713525c118aa2851def3323478f1810e01 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 29 Jun 2021 07:46:46 -0400 Subject: [PATCH 26/52] add to index --- .../onboarding/getting-started-with-github-ae.md | 12 ++++++------ content/get-started/onboarding/index.md | 1 + 2 files changed, 7 insertions(+), 6 deletions(-) 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 a433143b87..db2626dfa5 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -9,24 +9,24 @@ versions: To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. ### 1. Creating your {% data variables.product.prodname_ghe_managed %} enterprise account -You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [GitHub's Sales team](/admin/configuration/configuring-your-enterprise/initializing-github-ae). +You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](/admin/configuration/configuring-your-enterprise/initializing-github-ae). -After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in GitHub Enterprise Support to create an account. +After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in {% data variables.product.prodname_dotcom %} Enterprise Support to create an account. ### 2. Initializing {% data variables.product.prodname_ghe_managed %} -When your {% data variables.product.prodname_ghe_managed %} enterprise account has been created, you will receive an email to log into GitHub AE and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." +When your {% data variables.product.prodname_ghe_managed %} enterprise account has been created, you will receive an email to log into {% data variables.product.prodname_ghe_managed %} and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." ### 3. Restricting network traffic You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." ### 4. Managing identity and access for your enterprise -You can centrally manage access to GitHub AE from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure it, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." +You can centrally manage access to {% data variables.product.prodname_ghe_managed %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure it, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." ### 5. Managing billing for your enterprise -Enterprise owners can view billing information for GitHub AE. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +Enterprise owners can view billing information for {% data variables.product.prodname_ghe_managed %}. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." ## Part 2: Organizing and managing your users -As an enterprise owner for GitHub AE, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. +As an enterprise owner for {% data variables.product.prodname_ghe_managed %}, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. ### 1. Managing and auditing users of your enterprise You can manage user settings and audit user activity in your enterprise, including managing dormant users, viewing the audit log for user activity in your enterprise, and customizing messages that users will see on your enterprise. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." diff --git a/content/get-started/onboarding/index.md b/content/get-started/onboarding/index.md index 6b0d525309..328ed08215 100644 --- a/content/get-started/onboarding/index.md +++ b/content/get-started/onboarding/index.md @@ -10,4 +10,5 @@ children: - /getting-started-with-github-team - /getting-started-with-github-enterprise-cloud - /getting-started-with-github-enterprise-server + - /getting-started-with-github-ae --- From 812b12e72ec94b1beb6dfb5a781fb2de62db4fa1 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 29 Jun 2021 07:55:21 -0400 Subject: [PATCH 27/52] fixed numbering --- .../onboarding/getting-started-with-github-ae.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 db2626dfa5..4826dd6de3 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -60,15 +60,15 @@ You can use a variety of {% data variables.product.prodname_dotcom %} security f ## Part 4: Customizing and automating your enterprise's work on {% data variables.product.prodname_dotcom %} You can customize and automate work in organizations in your enterprise with the {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, and {% data variables.product.prodname_pages %}. -### 2. Using the {% data variables.product.prodname_dotcom %} API +### 1. Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} -### 3. Building {% data variables.product.prodname_actions %} +### 2. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." -### 4. Using {% data variables.product.prodname_pages %} +### 3. Using {% data variables.product.prodname_pages %} {% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." From 16cac0eec1a2ad60f97575660888113ff9b38281 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Tue, 29 Jun 2021 14:42:07 -0400 Subject: [PATCH 28/52] Apply suggestions from code review Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com> Co-authored-by: Felicity Chapman --- .../onboarding/getting-started-with-github-ae.md | 2 +- .../getting-started-with-github-enterprise-cloud.md | 4 ++-- .../getting-started-with-github-enterprise-server.md | 8 ++++---- .../onboarding/getting-started-with-github-team.md | 6 +++--- .../getting-started-with-your-github-account.md | 8 ++++---- data/reusables/getting-started/marketplace.md | 2 +- 6 files changed, 15 insertions(+), 15 deletions(-) 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 4826dd6de3..ea8f81f2c1 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -9,7 +9,7 @@ versions: To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. ### 1. Creating your {% data variables.product.prodname_ghe_managed %} enterprise account -You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](/admin/configuration/configuring-your-enterprise/initializing-github-ae). +You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in {% data variables.product.prodname_dotcom %} Enterprise Support to create an account. 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 f3e2560ff5..6b466a4162 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 @@ -12,7 +12,7 @@ versions: - **{% data variables.product.prodname_ghe_cloud %}** - **{% data variables.product.prodname_ghe_server %}** -The main difference between the products is that {% data variables.product.prodname_ghe_cloud %} is hosted by {% data variables.product.prodname_dotcom %}, while {% data variables.product.prodname_ghe_server %}is self-hosted. +The main difference between the products is that {% data variables.product.prodname_ghe_cloud %} is hosted by {% data variables.product.prodname_dotcom %}, while {% data variables.product.prodname_ghe_server %} is self-hosted. Within the {% data variables.product.prodname_ghe_cloud %} product, there are two different types of account that you can use: @@ -95,7 +95,7 @@ To audit access to enterprise-owned resources or user license usage, you can vie ## Part 4: Managing security with {% data variables.product.prodname_ghe_cloud %} ### Managing security for a single organization -#### 1. Recommending or requiring two-factor authentication +#### 1. Requiring two-factor authentication You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." #### 2. Configuring security features for your organization 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 132046be3e..f24b34eb75 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 @@ -17,15 +17,15 @@ For an overview of how {% data variables.product.prodname_ghe_server %} works, s ## Part 1: Installing {% data variables.product.prodname_ghe_server %} To get started with {% data variables.product.prodname_ghe_server %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. ### 1. Creating your enterprise account -Before install {% data variables.product.prodname_ghe_server %}, you will first need to create an enterprise account on GitHub. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +Before you install {% data variables.product.prodname_ghe_server %}, you will first need to create an enterprise account on GitHub by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." ### 2. Installing a {% data variables.product.prodname_ghe_server %} instance To get started with {% data variables.product.prodname_ghe_server %}, you will need to install your instance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." ### 3. Using the Management Console -You will use the Management Console to walk through the initial setup process when first launching your instance. You can also use it to manage virtual appliance settings such as the domain, authentication and SSL. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." +You will use the Management Console to walk through the initial setup process when first launching your instance. You can also use the Management Console to manage virtual appliance settings such as the domain, authentication and SSL. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." ### 4. Configuring your {% data variables.product.prodname_ghe_server %} instance -In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage your enterprise. You can configure applications and rate limits, view reports, use command-line utilities, and much more. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise).' +In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage your enterprise. You can configure applications and rate limits, view reports, use command-line utilities, and much more. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." You can use the default network settings used by {% data variables.product.prodname_ghe_server %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." @@ -71,7 +71,7 @@ You can use {% data variables.product.prodname_ghe_server %}'s built-in authenti You can also require two-factor authentication for each of your organizations. For more information, see "[Requiring two factor authentication for an organization](/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization)." ### 2. Staying in compliance -You can implement required status checks ands commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/enterprise-server@3.1/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." +You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/enterprise-server@3.1/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." #### 3. Configuring security features for your organizations You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." 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 fd60eeccb6..bb17b72800 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -17,7 +17,7 @@ You must manage billing settings, payment method, and paid features and products Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". -{% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization' billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)". +{% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization's billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)". Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". ### 3. About organizations @@ -51,7 +51,7 @@ You can also customize access to your organization's project boards and allow in ## Part 3: Managing security for your organization You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. -### 1. Recommending or requiring two-factor authentication +### 1. Requiring two-factor authentication You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." ### 2. Configuring security features for your organization @@ -119,4 +119,4 @@ GitHub offers multiple tools for moderating and managing your community. For mor {% ifversion fpt %} ## Further reading - "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" -{% endif %} \ No newline at end of file +{% endif %} 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 a6c6505105..2ed3fedf02 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 @@ -37,13 +37,13 @@ To ensure you can use all of the features in your {% data variables.product.prod Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} ### {% ifversion fpt %}5.{% elsif ghes %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph -Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organizations you're part of, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." +Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### 1. Learning Git -{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." +{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." ### 2. Setting up Git If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/quickstart/set-up-git)." @@ -58,11 +58,11 @@ For more information about how to authenticate to {% data variables.product.prod | ------------- | ------------- | ------------- | | Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. | | {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or File Editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | | Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)".

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | | {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} -To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." +To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. diff --git a/data/reusables/getting-started/marketplace.md b/data/reusables/getting-started/marketplace.md index 7a7f5381ba..c7b035dc85 100644 --- a/data/reusables/getting-started/marketplace.md +++ b/data/reusables/getting-started/marketplace.md @@ -1 +1 @@ -{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including [{% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s](/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps), and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). For more information, see "[{% data variables.product.prodname_marketplace %}](/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace)". \ No newline at end of file +{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). For more information, see "[About {% data variables.product.prodname_marketplace %}](/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace)". From 36f617b5f78c149417c664a7c628589b51c19ecc Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 29 Jun 2021 17:32:04 -0400 Subject: [PATCH 29/52] updating based on comments --- ...ng-started-with-github-enterprise-cloud.md | 4 ++++ .../getting-started-with-github-team.md | 15 +++++++------ ...etting-started-with-your-github-account.md | 22 ++++++++++--------- 3 files changed, 24 insertions(+), 17 deletions(-) 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 6b466a4162..918ee76c27 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 @@ -48,7 +48,11 @@ If you do decide to purchase {% data variables.product.prodname_ghe_cloud %}, yo Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". ### Setting up an enterprise account with {% data variables.product.prodname_ghe_cloud %} + {% note %} + In order to get an enterprise account created for you, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). + + {% endnote %} #### 1. About enterprise accounts An enterprise account allows you to centrally manage policy and settings for multiple {% data variables.product.prodname_dotcom %} organizations, including member access, billing and usage and security. For more information, see "[About enterprise accounts](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/about-enterprise-accounts)." #### 2. Adding organizations to your account 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 bb17b72800..d22f6bdbde 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -7,12 +7,15 @@ versions: ## Part 1: Configuring your {% data variables.product.product_name %} account As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. -### 1. Creating an organization and signing up for {% data variables.product.prodname_team %} +### 1. About organizations +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)". + +### 2. Creating an organization and signing up for {% data variables.product.prodname_team %} Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)". Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". -### 2. Managing billing for an organization +### 3. Managing billing for an organization You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". @@ -20,21 +23,20 @@ Your organization's billing settings page allows you to manage settings like you {% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization's billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)". Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". -### 3. About organizations -Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)". -Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)". ## Part 2: Adding members and setting up teams After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, project boards, and apps. ### 1. Managing members of your organization You can invite anyone to be a member of your organization, as long as they have a personal account on GitHub. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." + +Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)". ### 2. Organization permissions and roles Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." ### 3. About and creating teams -Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." +Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews, and teams can be visible or secret. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." @@ -57,7 +59,6 @@ You can view whether your organization members have two-factor authentication en ### 2. Configuring security features for your organization You can use a variety of GitHub security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -Some security features are only available for public repositories, and for private repositories owned by organizations with an Advanced Security license. For more information, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)." ### 3. Reviewing your organization's audit log and integrations The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." 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 2ed3fedf02..13c382471d 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 @@ -21,31 +21,33 @@ The first steps in starting with {% data variables.product.product_name %}, are ### 1. Creating an account To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. -To keep your {% data variables.product.prodname_dotcom %} account secure you should generate a strong and unique password with more than 16 characters using a password manager. +To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)." +{% ifversion fpt %} ### 2. Choosing your {% data variables.product.prodname_dotcom %} product -You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. +You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want. For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." -{% ifversion fpt %} ### 3. Verifying your email address To ensure you can use all of the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% ifversion fpt or ghes %} -### {% ifversion fpt %}4.{% else %}3.{% endif %} Configuring two-factor authentication +### {% ifversion fpt %}4.{% else %}2.{% endif %} Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### {% ifversion fpt %}5.{% elsif ghes %}4.{% else %}3.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph +### {% ifversion fpt %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes -To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.prodname_dotcom_the_website %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### 1. Learning Git {% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." ### 2. Setting up Git -If you plan to use Git locally on your computer, whether through the command line, {% data variables.product.prodname_desktop %}, an IDE or file editor, or the {% data variables.product.prodname_dotcom %} API, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/quickstart/set-up-git)." +If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/quickstart/set-up-git)." + +If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." @@ -56,9 +58,9 @@ For more information about how to authenticate to {% data variables.product.prod | **Method** | **Description** | **Use cases** | | ------------- | ------------- | ------------- | -| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes or workflows that don't require working locally. | -| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with GitHub Desktop](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](https://help-docs-pr-11947.herokuapp.com/en/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | | Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)".

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | | {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} From 9a374d4ff072fa10bd5bd8e6257f23b1032f71c4 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 30 Jun 2021 07:15:27 -0400 Subject: [PATCH 30/52] version firat part for fpt --- .../onboarding/getting-started-with-your-github-account.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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 13c382471d..4efc105374 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 @@ -18,11 +18,12 @@ The first steps in starting with {% data variables.product.product_name %}, are {% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif}Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +{% ifversion fpt %} ### 1. Creating an account To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)." -{% ifversion fpt %} + ### 2. Choosing your {% data variables.product.prodname_dotcom %} product You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want. @@ -33,10 +34,10 @@ To ensure you can use all of the features in your {% data variables.product.prod {% endif %} {% ifversion fpt or ghes %} -### {% ifversion fpt %}4.{% else %}2.{% endif %} Configuring two-factor authentication +### {% ifversion fpt %}4.{% else %}1.{% endif %} Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### {% ifversion fpt %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph +### {% ifversion fpt %}5.{% elsif ghes %}2.{% else %}1.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes From 17fce1cbb5f54efbe69a2566ab9db8e04aea47eb Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 30 Jun 2021 07:37:54 -0400 Subject: [PATCH 31/52] Update getting-started-with-your-github-account.md --- .../onboarding/getting-started-with-your-github-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4efc105374..a1b131e355 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 @@ -16,7 +16,7 @@ The first steps in starting with {% data variables.product.product_name %}, are The first steps in starting with {% data variables.product.product_name %}, are to access your account and view your profile. {% endif %} -{% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif}Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +{% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. {% ifversion fpt %} ### 1. Creating an account From fa23851ff14d502ed3f88ab2483ede315696918d Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Mon, 12 Jul 2021 10:31:14 -0400 Subject: [PATCH 32/52] Fixing some headers --- .../get-started/onboarding/getting-started-with-github-ae.md | 2 +- .../onboarding/getting-started-with-github-enterprise-cloud.md | 1 + .../onboarding/getting-started-with-github-enterprise-server.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) 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 ea8f81f2c1..e5126f6d1f 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -72,7 +72,7 @@ For more information on enabling and configuring {% data variables.product.prodn {% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." -## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources +## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources Your users 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 your {% data variables.product.prodname_ghe_server %} instance with {% data variables.product.prodname_dotcom %} Enterprise Support. ### 1. Learning with {% data variables.product.prodname_learning %} 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 918ee76c27..6f51c9217b 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 @@ -53,6 +53,7 @@ Only organization members with the *owner* or *billing manager* role can access In order to get an enterprise account created for you, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). {% endnote %} + #### 1. About enterprise accounts An enterprise account allows you to centrally manage policy and settings for multiple {% data variables.product.prodname_dotcom %} organizations, including member access, billing and usage and security. For more information, see "[About enterprise accounts](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/about-enterprise-accounts)." #### 2. Adding organizations to your account 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 f24b34eb75..1079389f53 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 @@ -73,7 +73,7 @@ You can also require two-factor authentication for each of your organizations. F ### 2. Staying in compliance You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/enterprise-server@3.1/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." -#### 3. Configuring security features for your organizations +### 3. Configuring security features for your organizations You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." ### 4. Enabling {% data variables.product.prodname_GH_advanced_security %} features You can upgrade your {% data variables.product.prodname_ghe_server %} license to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see "[{% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." From 4be3da2a1cace083ed13c524faa005307277abc6 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Mon, 12 Jul 2021 17:01:26 -0400 Subject: [PATCH 33/52] Some edits --- .../getting-started-with-github-ae.md | 6 +++--- ...ing-started-with-github-enterprise-cloud.md | 18 ++++++++++-------- 2 files changed, 13 insertions(+), 11 deletions(-) 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 e5126f6d1f..cdc32496ee 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -52,7 +52,7 @@ As an enterprise owner, you can set repository management policies for all organ To make your enterprise as secure as possible, you can monitor your enterprise and configure security and analysis features for your organizations. ### 1. Monitoring your enterprise -You can monitor your application with you activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." +You can monitor your application with your activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." ### 2. Configuring security features for your organizations You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." @@ -66,14 +66,14 @@ You can customize and automate work in organizations in your enterprise with the ### 2. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." +For more information on enabling and configuring {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." ### 3. Using {% data variables.product.prodname_pages %} {% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." ## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources -Your users 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 your {% data variables.product.prodname_ghe_server %} instance with {% data variables.product.prodname_dotcom %} Enterprise Support. +Your users 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 %} Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} community and taught by the friendly Learning Lab bot. 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 6f51c9217b..847196da22 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 @@ -28,7 +28,7 @@ If you choose an enterprise account, keep in mind that some policies can be set Once you choose the account type you would like, you can proceed to setting up your account. In each of the sections in this guide, proceed to either the single organization or enterprise account section based on your account type. -## Part 2: Account setup +## Part 2: Setting up your account To get started with {% data variables.product.prodname_ghe_cloud %}, you will want to create your organization or enterprise account and set up and view billing settings, subscriptions and usage. ### Setting up a single organization account with {% data variables.product.prodname_ghe_cloud %} @@ -43,7 +43,7 @@ Alternatively, if you have an existing organization account that you would like When you choose to use an organization account with {% data variables.product.prodname_ghe_cloud %}, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %} before your trial ends, your organization will be downgraded to {% data variables.product.prodname_free_user %} and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." -If you do decide to purchase {% data variables.product.prodname_ghe_cloud %}, you'll need to set up your billing account. Your organization's billing settings page allows you to manage settings like your payment method, billing email and billing cycle, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and {% data variables.product.prodname_actions %} minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". +Your organization's billing settings page allows you to manage settings like your payment method and billing cycle, view information about your subscription, and upgrade your storage and {% data variables.product.prodname_actions %} minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". @@ -53,10 +53,12 @@ Only organization members with the *owner* or *billing manager* role can access In order to get an enterprise account created for you, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). {% endnote %} - + #### 1. About enterprise accounts + An enterprise account allows you to centrally manage policy and settings for multiple {% data variables.product.prodname_dotcom %} organizations, including member access, billing and usage and security. For more information, see "[About enterprise accounts](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/about-enterprise-accounts)." -#### 2. Adding organizations to your account +#### 2. Adding organizations to your enterprise account + You can create new organizations to manage within your enterprise account. For more information, see "[Adding organizations to your enterprise](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/adding-organizations-to-your-enterprise-account)." Contact your {% data variables.product.prodname_dotcom %} sales account representative if you want to transfer an existing organization to your enterprise account. @@ -76,7 +78,6 @@ Teams are groups of organization members that you can create to reflect your com You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." -Teams can participate in team discussions on their team page to plan together, give status updates, or talk about any topic. Discussions can be open to all organization members or private to the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." #### 4. Managing team settings You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." @@ -106,7 +107,6 @@ You can view whether your organization members have two-factor authentication en #### 2. Configuring security features for your organization You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -Some security features are only available for public repositories, and for private repositories owned by organizations with an Advanced Security license. For more information, see "[About GitHub Advanced Security](/get-started/learning-about-github/about-github-advanced-security)." #### 3. Reviewing your organization's audit log and integrations The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." @@ -121,7 +121,9 @@ Organization owners can enable team synchronization between your identity provid ### Managing security for an enterprise account with multiple organizations #### 1. Requiring two-factor authentication and managing allowed IP addresses for organizations in your enterprise account -Enterprise owners can require that organization members, billing managers, and outside collaborators in all organizations owned by an enterprise account use two-factor authentication to secure their personal accounts. Before doing so, we recommend notifying all who have access to organizations in your enterprise. You can also configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information on enforcing two-factor authentication and allowed IP address lists, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)." +Enterprise owners can require that organization members, billing managers, and outside collaborators in all organizations owned by an enterprise account use two-factor authentication to secure their personal accounts. Before doing so, we recommend notifying all who have access to organizations in your enterprise. You can also configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. + +For more information on enforcing two-factor authentication and allowed IP address lists, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)." #### 2. Enabling and enforcing SAML single sign-on for organizations in your enterprise account You can centrally manage access to your enterprise's resources, organization membership and team membership using your IdP and SAM single sign-on (SSO). Enterprise owners can enable SAML SSO across all organizations owned by an enterprise account. For more information, see "[About identity and access management for your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/about-identity-and-access-management-for-your-enterprise-account)". @@ -161,7 +163,7 @@ You can view actions from all of the organizations owned by your enterprise acco You can also restrict email notifications for your enterprise account so that enterprise members can only use an email address in a verified or approved domain to receive notifications. For more information, see "[Restricting email notifications for your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/restricting-email-notifications-for-your-enterprise-account)." ## Part 6: Customizing and automating your organization or enterprise's work on {% data variables.product.prodname_dotcom %} -{% data reusables.getting-started.customizing-and-automating %} +Members of your organization or enterprise can use tools from the {% data variables.product.prodname_marketplace %}, the {% data variables.product.product_name %} API, and existing {% data variables.product.product_name %} features to customize and automate your work. ### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} From a8a977e546c98b17c2c94c8260460a56ba3028d2 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 13 Jul 2021 14:24:34 -0400 Subject: [PATCH 34/52] Added intro text at top of guides to clarify audience, and fixed some punctuation issues --- .../getting-started-with-github-ae.md | 4 +- ...ng-started-with-github-enterprise-cloud.md | 6 ++- ...g-started-with-github-enterprise-server.md | 4 +- .../getting-started-with-github-team.md | 3 ++ ...etting-started-with-your-github-account.md | 51 ++++++++++++------- 5 files changed, 45 insertions(+), 23 deletions(-) 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 cdc32496ee..7b21e0fe00 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -5,6 +5,8 @@ versions: ghae: '*' --- +This guide will walk you through setting up, configuring, and managing settings for your {% data variables.product.prodname_ghe_managed %} account as an enterprise owner or administrator. + ## Part 1: Setting up {% data variables.product.prodname_ghe_managed %} To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. @@ -78,7 +80,7 @@ Your users can learn more about Git and {% data variables.product.prodname_dotco ### 1. Learning with {% data variables.product.prodname_learning %} Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} 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)." +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. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data variables.product.prodname_ghe_managed %} includes access to {% data variables.product.prodname_dotcom %} Enterprise Support. {% data variables.product.prodname_dotcom %} Enterprise Support can help you troubleshoot issues that come up on {% data variables.product.prodname_ghe_managed %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Enterprise Support](/admin/enterprise-support/overview/about-github-enterprise-support)." 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 847196da22..a793a260ee 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 @@ -5,6 +5,8 @@ versions: fpt: '*' --- +This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_ghe_cloud %} account as an organization or enterprise owner. + ## Part 1: Choosing your account type {% data variables.product.prodname_dotcom %} provides two types of Enterprise products: @@ -26,7 +28,7 @@ Both organization and enterprise accounts are available with {% data variables.p If you choose an enterprise account, keep in mind that some policies can be set only at an organization level, while others can be enforced for all organizations in an enterprise. -Once you choose the account type you would like, you can proceed to setting up your account. In each of the sections in this guide, proceed to either the single organization or enterprise account section based on your account type. +Once you choose the account type you would like, you can proceed to setting up your account. In each of the sections in this guide, proceed to either the single organization or enterprise account section based on your account type. ## Part 2: Setting up your account To get started with {% data variables.product.prodname_ghe_cloud %}, you will want to create your organization or enterprise account and set up and view billing settings, subscriptions and usage. @@ -179,7 +181,7 @@ Members of your organization or enterprise can use GitHub's learning and support ### 1. 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)." +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 {% data reusables.getting-started.sponsors %} 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 1079389f53..5a5a04146f 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 @@ -5,6 +5,8 @@ versions: ghes: '*' --- +This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_ghe_server %} instance as an enterprise owner or administrator. + {% data variables.product.prodname_dotcom %} provides two types of Enterprise products: - **{% data variables.product.prodname_ghe_cloud %}** @@ -110,6 +112,6 @@ Your users can learn more about Git and {% data variables.product.prodname_dotco ### 1. Learning with {% data variables.product.prodname_learning %} Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} 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)." +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. Working with {% data variables.product.prodname_dotcom %} Enterprise Support {% data variables.product.prodname_ghe_server %} includes access to {% data variables.product.prodname_dotcom %} Enterprise Support. {% data variables.product.prodname_dotcom %} Enterprise Support can help you troubleshoot issues that come up on {% data variables.product.prodname_ghe_server %}. You can also choose to sign up for {% data variables.product.prodname_dotcom %} Premium Support for additional features. For more information, see "[About {% data variables.product.prodname_dotcom %} Enterprise Support](/admin/enterprise-support/overview/about-github-enterprise-support)." 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 d22f6bdbde..ab6786da04 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -4,6 +4,9 @@ intro: 'With {% data variables.product.prodname_team %} groups of people can col versions: fpt: '*' --- + +This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_team %} account as an organization owner. + ## Part 1: Configuring your {% data variables.product.product_name %} account As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. 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 a1b131e355..0719d476e1 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 @@ -1,11 +1,14 @@ --- title: Getting started with your GitHub account -intro: 'With an account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' +intro: 'With a user account on {% data variables.product.prodname_dotcom %}, you can import or create repositories, collaborate with others, and connect with the {% data variables.product.prodname_dotcom %} community.' versions: fpt: '*' ghes: '*' ghae: '*' --- + +This guide will walk you through setting up your {% data variables.product.prodname_dotcom %} account and getting started with {% data variables.product.prodname_dotcom %}'s features for collaboration and community. + ## Part 1: Configuring your {% data variables.product.prodname_dotcom %} account {% ifversion fpt %} @@ -16,7 +19,7 @@ The first steps in starting with {% data variables.product.product_name %}, are The first steps in starting with {% data variables.product.product_name %}, are to access your account and view your profile. {% endif %} -{% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. +{% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. {% ifversion fpt %} ### 1. Creating an account @@ -33,22 +36,32 @@ For more information on all of {% data variables.product.prodname_dotcom %}'s pl To ensure you can use all of the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} +{% ifversion ghes %} +### 1. Accessing your account +The administrator of your {% data variables.product.product_name %} instance will notify you about how to authenticate and access your account. The process varies depending on the authentication mode they have configured for the instance. +{% endif %} + +{% ifversion ghae %} +### 1. Accessing your account +You will receive an email notification once your enterprise owner for {% data variables.product.product_name %} has set up your account, allowing you to authenticate with SAML single sign-on (SSO) and access your account. +{% endif %} + {% ifversion fpt or ghes %} -### {% ifversion fpt %}4.{% else %}1.{% endif %} Configuring two-factor authentication +### {% ifversion fpt %}4.{% else %}2.{% endif %} Configuring two-factor authentication Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)." {% endif %} -### {% ifversion fpt %}5.{% elsif ghes %}2.{% else %}1.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph -Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see “[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and “[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." +### {% ifversion fpt %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.product_name %} profile and contribution graph +Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and "[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### 1. Learning Git -{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the “[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see “[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." +{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." ### 2. Setting up Git -If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see “[Set up Git](/get-started/quickstart/set-up-git)." +If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "[Set up Git](/get-started/quickstart/set-up-git)." -If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." +If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." @@ -60,7 +73,7 @@ For more information about how to authenticate to {% data variables.product.prod | **Method** | **Description** | **Use cases** | | ------------- | ------------- | ------------- | | Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | -| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see “[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | +| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | | IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | | Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)".

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | | {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | @@ -85,7 +98,7 @@ Any number of people can work together in repositories across {% data variables. #### Creating a repository A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)." -When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see “[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." +When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." #### Cloning a repository You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". @@ -93,34 +106,34 @@ You can clone an existing repository from {% data variables.product.product_name #### Forking a repository A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". ### 2. Importing your projects -If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see “[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." +If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see "[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." ### 3. Managing collaborators and permissions -You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see “[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." +You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)." -You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see “[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." +You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)." ### 4. Managing repository settings -As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see “[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." +As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)." ### 5. Setting up your project for healthy contributions {% ifversion fpt %} -To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see “[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. +To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see "[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides. -By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." +By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} {% ifversion ghes or ghae %} -By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see “[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." +By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} ### 6. Using GitHub Issues and project boards You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and [About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." ### 7. Managing notifications -Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see “[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." +Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." ### 8. Working with {% data variables.product.prodname_pages %} -You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see “[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." +You can use {% data variables.product.prodname_pages %} to create and host a website directly from a {% data variables.product.product_name %} repository. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." {% ifversion fpt %} ### 9. Using {% data variables.product.prodname_discussions %} From 2090f832552bf2c919984744a81a47432547fe1f Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 13 Jul 2021 15:45:30 -0400 Subject: [PATCH 35/52] removing change I had made to product.yml, not related to these guides --- .../onboarding/getting-started-with-your-github-account.md | 4 ++-- data/variables/product.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) 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 0719d476e1..588b6dbdfe 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 @@ -14,9 +14,9 @@ This guide will walk you through setting up your {% data variables.product.prodn {% ifversion fpt %} The first steps in starting with {% data variables.product.product_name %} are to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. {% elsif ghes %} -The first steps in starting with {% data variables.product.product_name %}, are to access your account, set up two-factor authentication, and view your profile. +The first steps in starting with {% data variables.product.product_name %} are to access your account, set up two-factor authentication, and view your profile. {% elsif ghae %} -The first steps in starting with {% data variables.product.product_name %}, are to access your account and view your profile. +The first steps in starting with {% data variables.product.product_name %} are to access your account and view your profile. {% endif %} {% ifversion fpt %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual. diff --git a/data/variables/product.yml b/data/variables/product.yml index a7b2796762..00471cce2a 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -125,7 +125,7 @@ prodname_codespaces: 'Codespaces' prodname_github_codespaces: 'GitHub Codespaces' # GitHub resources: blog, jobs, Learning Lab -prodname_gcf: 'GitHub Support Community' +prodname_gcf: 'GitHub Community Support' prodname_blog: 'the GitHub Blog' prodname_jobs: 'GitHub Jobs' prodname_learning: 'GitHub Learning Lab' From 1ee01c634fe74e5b7aebcbd618ff74f9a676831d Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 13 Jul 2021 17:14:50 -0400 Subject: [PATCH 36/52] Fix quotes and remove some unnecessary words --- .../getting-started-with-github-ae.md | 6 +-- ...ng-started-with-github-enterprise-cloud.md | 8 ++-- ...g-started-with-github-enterprise-server.md | 4 +- .../getting-started-with-github-team.md | 20 +++++----- ...etting-started-with-your-github-account.md | 38 +++++++++---------- data/reusables/getting-started/api.md | 2 +- data/reusables/getting-started/marketplace.md | 2 +- 7 files changed, 40 insertions(+), 40 deletions(-) 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 7b21e0fe00..9e9c99aaa5 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -8,12 +8,12 @@ versions: This guide will walk you through setting up, configuring, and managing settings for your {% data variables.product.prodname_ghe_managed %} account as an enterprise owner or administrator. ## Part 1: Setting up {% data variables.product.prodname_ghe_managed %} -To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. +To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. ### 1. Creating your {% data variables.product.prodname_ghe_managed %} enterprise account You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). -After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in {% data variables.product.prodname_dotcom %} Enterprise Support to create an account. +After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in {% data variables.product.prodname_dotcom %} Enterprise Support to create an account. ### 2. Initializing {% data variables.product.prodname_ghe_managed %} When your {% data variables.product.prodname_ghe_managed %} enterprise account has been created, you will receive an email to log into {% data variables.product.prodname_ghe_managed %} and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." @@ -75,7 +75,7 @@ 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 users 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. +Your users 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 %} Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} community and taught by the friendly Learning Lab bot. 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 a793a260ee..90d579e8b0 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 @@ -45,14 +45,14 @@ Alternatively, if you have an existing organization account that you would like When you choose to use an organization account with {% data variables.product.prodname_ghe_cloud %}, you'll first have access to a [14-day trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud). If you don't purchase {% data variables.product.prodname_enterprise %} or {% data variables.product.prodname_team %} before your trial ends, your organization will be downgraded to {% data variables.product.prodname_free_user %} and lose access to any advanced tooling and features that are only included with paid products. For more information, see "[Finishing your trial](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud#finishing-your-trial)." -Your organization's billing settings page allows you to manage settings like your payment method and billing cycle, view information about your subscription, and upgrade your storage and {% data variables.product.prodname_actions %} minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". +Your organization's billing settings page allows you to manage settings like your payment method and billing cycle, view information about your subscription, and upgrade your storage and {% data variables.product.prodname_actions %} minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)." -Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". +Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." ### Setting up an enterprise account with {% data variables.product.prodname_ghe_cloud %} {% note %} -In order to get an enterprise account created for you, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). +To get an enterprise account created for you, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). {% endnote %} @@ -127,7 +127,7 @@ Enterprise owners can require that organization members, billing managers, and o For more information on enforcing two-factor authentication and allowed IP address lists, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)." #### 2. Enabling and enforcing SAML single sign-on for organizations in your enterprise account -You can centrally manage access to your enterprise's resources, organization membership and team membership using your IdP and SAM single sign-on (SSO). Enterprise owners can enable SAML SSO across all organizations owned by an enterprise account. For more information, see "[About identity and access management for your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/about-identity-and-access-management-for-your-enterprise-account)". +You can centrally manage access to your enterprise's resources, organization membership and team membership using your IdP and SAM single sign-on (SSO). Enterprise owners can enable SAML SSO across all organizations owned by an enterprise account. For more information, see "[About identity and access management for your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/about-identity-and-access-management-for-your-enterprise-account)." #### 3. Managing team synchronization You can enable and manage team sychronization between an identity provider (IdP) and {% data variables.product.prodname_dotcom %} to allow organizations owned by your enterprise account to manage team membership with IdP groups. For more information, see "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/managing-team-synchronization-for-organizations-in-your-enterprise-account)." 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 5a5a04146f..34876410b3 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 @@ -40,7 +40,7 @@ You can use {% data variables.product.prodname_ghe_server %} Backup Utilities to ### 7. Geo-replication {% data variables.product.prodname_ghe_server %} can help to reduce latency between different hosts and locations, if your organization has offices in multiple locations. For more information, see "[About geo-replication](/admin/enterprise-management/configuring-high-availability/about-geo-replication)." ### 8. Managing billing for your enterprise -Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +Billing for all the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." ## Part 2: Organizing and managing your team As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. @@ -100,7 +100,7 @@ For more information on enabling and configuring {% data variables.product.prodn {% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." ## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources -You can use {% data variables.product.prodname_github_connect %} and {% data variables.product.prodname_insights %} to share resources and understand and improve your processes. +You can use {% data variables.product.prodname_github_connect %} and {% data variables.product.prodname_insights %} to share resources and understand and improve your processes. ### 1. Enabling {% data variables.product.prodname_github_connect %} If you are the owner of both a {% data variables.product.prodname_ghe_server %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between your {% data variables.product.prodname_ghe_server %} instance and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." 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 ab6786da04..9bfc62b81a 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -8,24 +8,24 @@ versions: This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_team %} account as an organization owner. ## Part 1: Configuring your {% data variables.product.product_name %} account -As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. +As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing. ### 1. About organizations -Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)". +Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)." ### 2. Creating an organization and signing up for {% data variables.product.prodname_team %} -Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)". +Before creating an organization, you will need to create a user account or log in to your existing {% data variables.product.prodname_dotcom %} account. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)." -Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)". +Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." ### 3. Managing billing for an organization -You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)". +You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)." -Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)". +Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)." -{% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization's billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)". +{% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization's billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)." -Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)". +Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." ## Part 2: Adding members and setting up teams @@ -34,7 +34,7 @@ After creating your organization, you can invite members and set permissions and ### 1. Managing members of your organization You can invite anyone to be a member of your organization, as long as they have a personal account on GitHub. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." -Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)". +Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)." ### 2. Organization permissions and roles Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." @@ -54,7 +54,7 @@ You can give organization members, teams, and outside collaborators different le You can also customize access to your organization's project boards and allow individual organization members to manage your organization's GitHub Apps. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." ## Part 3: Managing security for your organization -You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. +You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. ### 1. Requiring two-factor authentication You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." 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 588b6dbdfe..d977aa04bd 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 @@ -12,7 +12,7 @@ This guide will walk you through setting up your {% data variables.product.prodn ## Part 1: Configuring your {% data variables.product.prodname_dotcom %} account {% ifversion fpt %} -The first steps in starting with {% data variables.product.product_name %} are to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. +The first steps in starting with {% data variables.product.product_name %} are to create an account, choose a product that fits your needs best, verify your email, set up two-factor authentication, and view your profile. {% elsif ghes %} The first steps in starting with {% data variables.product.product_name %} are to access your account, set up two-factor authentication, and view your profile. {% elsif ghae %} @@ -23,7 +23,7 @@ The first steps in starting with {% data variables.product.product_name %} are t {% ifversion fpt %} ### 1. Creating an account -To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. +To sign up for a {% data variables.product.prodname_dotcom %} account, navigate to https://github.com/ and follow the prompts. To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)." @@ -33,7 +33,7 @@ You can choose {% data variables.product.prodname_free_user %} or {% data variab For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)." ### 3. Verifying your email address -To ensure you can use all of the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." +To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)." {% endif %} {% ifversion ghes %} @@ -54,10 +54,10 @@ Two-factor authentication, or 2FA, is an extra layer of security used when loggi Your {% data variables.product.product_name %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and "[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)." ## Part 2: Using {% data variables.product.product_name %}'s tools and processes -To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. +To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown. ### 1. Learning Git -{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." +{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)." ### 2. Setting up Git If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "[Set up Git](/get-started/quickstart/set-up-git)." @@ -66,29 +66,29 @@ If you prefer to use a visual interface, you can download and use {% data variab Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a {% data variables.product.product_name %} repository from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)." ### 3. Choosing how to interact with {% data variables.product.product_name %} -Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. +Everyone has their own unique workflow for interacting with {% data variables.product.prodname_dotcom %}; the interfaces and methods you use depend on your preference and what works best for your needs. -For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)". +For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)." | **Method** | **Description** | **Use cases** | | ------------- | ------------- | ------------- | | Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | | {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | | IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | -| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)".

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)". | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | -| {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)". | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | +| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | +| {% data variables.product.prodname_dotcom %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% data variables.product.prodname_dotcom %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)." You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}. ### 5. Searching on {% data variables.product.product_name %} -Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)". +Our integrated search allows you to find what you are looking for among the many repositories, users and lines of code on {% data variables.product.product_name %}. You can search globally across all of {% data variables.product.product_name %} or limit your search to a particular repository or organization. For more information about the types of searches you can do on {% data variables.product.product_name %}, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/getting-started-with-searching-on-github/about-searching-on-github)." -Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/searching-on-github)". +Our search syntax allows you to construct queries using qualifiers to specify what you want to search for. For more information on the search syntax to use in search, see "[Searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/searching-on-github)." ### 6. Managing files on {% data variables.product.product_name %} -With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)". +With {% data variables.product.product_name %}, you can create, edit, move and delete files in your repository or any repository you have write access to. You can also track the history of changes in a file line by line. For more information, see "[Managing files on {% data variables.product.prodname_dotcom %}](/github/managing-files-in-a-repository/managing-files-on-github)." ## Part 3: Collaborating on {% data variables.product.product_name %} Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. @@ -101,10 +101,10 @@ A repository is like a folder for your project. You can have any number of publi When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)." #### Cloning a repository -You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)". +You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)." #### Forking a repository -A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)". +A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)." ### 2. Importing your projects If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see "[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)." @@ -127,7 +127,7 @@ By adding files like contributing guidelines, a code of conduct, and support res {% endif %} ### 6. Using GitHub Issues and project boards -You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and [About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." ### 7. Managing notifications Notifications provide updates about the activity on {% data variables.product.product_name %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." @@ -137,7 +137,7 @@ You can use {% data variables.product.prodname_pages %} to create and host a web {% ifversion fpt %} ### 9. Using {% data variables.product.prodname_discussions %} -You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". +You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} ## Part 4: Customizing and automating your work on {% data variables.product.product_name %} @@ -157,17 +157,17 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi {% data reusables.getting-started.packages %} ## Part 5: Building securely on {% data variables.product.product_name %} -{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)". +{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." ### 1. Securing your repository As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed. -For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)". +For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)." {% ifversion fpt %} ### 2. Managing your dependencies A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies. -For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)". +For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)." {% endif %} ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community diff --git a/data/reusables/getting-started/api.md b/data/reusables/getting-started/api.md index 50a877f742..29165ae44d 100644 --- a/data/reusables/getting-started/api.md +++ b/data/reusables/getting-started/api.md @@ -1 +1 @@ -There are two versions of the {% data variables.product.prodname_dotcom %} API: the REST API and the GraphQL API. You can use the {% data variables.product.prodname_dotcom %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% ifversion fpt %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.prodname_dotcom %}'s APIs](/developers/overview/about-githubs-apis)". \ No newline at end of file +There are two versions of the {% data variables.product.prodname_dotcom %} API: the REST API and the GraphQL API. You can use the {% data variables.product.prodname_dotcom %} APIs to automate common tasks, [back up your data](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository), or {% ifversion fpt %}[create integrations](/github/customizing-your-github-workflow/exploring-integrations/about-integrations){% else %}create integrations{% endif %} that extend {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.prodname_dotcom %}'s APIs](/developers/overview/about-githubs-apis)." \ No newline at end of file diff --git a/data/reusables/getting-started/marketplace.md b/data/reusables/getting-started/marketplace.md index c7b035dc85..31b86d2397 100644 --- a/data/reusables/getting-started/marketplace.md +++ b/data/reusables/getting-started/marketplace.md @@ -1 +1 @@ -{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). For more information, see "[About {% data variables.product.prodname_marketplace %}](/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace)". +{% data variables.product.prodname_marketplace %} contains integrations that add functionality and improve your workflow. You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). For more information, see "[About {% data variables.product.prodname_marketplace %}](/github/customizing-your-github-workflow/exploring-integrations/about-github-marketplace)." From c683255156a63ff2e10161f8651baa79d511885d Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Fri, 16 Jul 2021 14:06:11 -0400 Subject: [PATCH 37/52] Apply suggestions from Matt's review Co-authored-by: Matt Pollard --- .../getting-started-with-github-ae.md | 24 ++++++++--------- ...g-started-with-github-enterprise-server.md | 26 +++++++++---------- data/reusables/getting-started/actions.md | 2 +- 3 files changed, 25 insertions(+), 27 deletions(-) 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 9e9c99aaa5..452d57e0b5 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -5,10 +5,10 @@ versions: ghae: '*' --- -This guide will walk you through setting up, configuring, and managing settings for your {% data variables.product.prodname_ghe_managed %} account as an enterprise owner or administrator. +This guide will walk you through setting up, configuring, and managing settings for {% data variables.product.product_location %} on {% data variables.product.product_name %} as an enterprise owner. ## Part 1: Setting up {% data variables.product.prodname_ghe_managed %} -To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, manage billing, and configure user authentication and provisioning for your enterprise. +To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, configure user authentication and provisioning, and manage billing for your enterprise. ### 1. Creating your {% data variables.product.prodname_ghe_managed %} enterprise account You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). @@ -16,22 +16,22 @@ You will first need to purchase {% data variables.product.prodname_ghe_managed % After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in {% data variables.product.prodname_dotcom %} Enterprise Support to create an account. ### 2. Initializing {% data variables.product.prodname_ghe_managed %} -When your {% data variables.product.prodname_ghe_managed %} enterprise account has been created, you will receive an email to log into {% data variables.product.prodname_ghe_managed %} and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." +After {% data variables.product.company_short %} creates the owner account for your enterprise on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." ### 3. Restricting network traffic You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." ### 4. Managing identity and access for your enterprise -You can centrally manage access to {% data variables.product.prodname_ghe_managed %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure it, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." +You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." ### 5. Managing billing for your enterprise -Enterprise owners can view billing information for {% data variables.product.prodname_ghe_managed %}. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +Owners of the subscription for your enterprise on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." -## Part 2: Organizing and managing your users -As an enterprise owner for {% data variables.product.prodname_ghe_managed %}, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. +## Part 2: Organizing and managing enterprise members +As an enterprise owner for {% data variables.product.prodname_ghe_managed %}, you can manage settings on user, repository, team, and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. -### 1. Managing and auditing users of your enterprise -You can manage user settings and audit user activity in your enterprise, including managing dormant users, viewing the audit log for user activity in your enterprise, and customizing messages that users will see on your enterprise. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." +### 1. Managing and auditing enterprise members +You can manage settings and audit activity for the members of {% data variables.product.product_location %}. You can manage dormant users, view the audit log for user activity in {% data variables.product.product_location %}, and customize messages that users will see on {% data variables.product.product_location %}. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." ### 2. Creating organizations You can create new organizations in your enterprise to reflect your company or group's structure. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." @@ -51,15 +51,15 @@ For organizations where you have admin permissions, you can also customize acces As an enterprise owner, you can set repository management policies for all organizations in your enterprise, or allow policies to be set in each organization. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." ## Part 3: Building securely -To make your enterprise as secure as possible, you can monitor your enterprise and configure security and analysis features for your organizations. +To increase the security of {% data variables.product.product_location %}, you can monitor {% data variables.product.product_location %} and configure security and analysis features for your organizations. ### 1. Monitoring your enterprise -You can monitor your application with your activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." +You can monitor {% data variables.product.product_location %} with your activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." ### 2. Configuring security features for your organizations You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -## Part 4: Customizing and automating your enterprise's work on {% data variables.product.prodname_dotcom %} +## Part 4: Customizing and automating work on {% data variables.product.product_location %} You can customize and automate work in organizations in your enterprise with the {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, and {% data variables.product.prodname_pages %}. ### 1. Using the {% data variables.product.prodname_dotcom %} API 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 34876410b3..dfd8e2ac6c 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 @@ -1,44 +1,42 @@ --- title: Getting started with GitHub Enterprise Server -intro: 'Get started with setting up and managing your {% data variables.product.prodname_ghe_server %} instance.' +intro: 'Get started with setting up and managing {% data variables.product.product_location %}.' versions: ghes: '*' --- -This guide will walk you through setting up, configuring and managing your {% data variables.product.prodname_ghe_server %} instance as an enterprise owner or administrator. +This guide will walk you through setting up, configuring and managing {% data variables.product.product_location %} as an enterprise administrator. -{% data variables.product.prodname_dotcom %} provides two types of Enterprise products: +{% data variables.product.company_short %} provides two ways to deploy {% data variables.product.prodname_enterprise %}. - **{% data variables.product.prodname_ghe_cloud %}** - **{% data variables.product.prodname_ghe_server %}** -The main difference between the products is that {% data variables.product.prodname_ghe_cloud %} is hosted by {% data variables.product.prodname_dotcom %}, while {% data variables.product.prodname_ghe_server %} is self-hosted. +{% data variables.product.company %} hosts {% data variables.product.prodname_ghe_cloud %}. You can deploy and host {% data variables.product.prodname_ghe_server %} in your own datacenter or a supported cloud provider. -For an overview of how {% data variables.product.prodname_ghe_server %} works, see "[System overview](/admin/overview/system-overview?learn=deploy_an_instance)." +For an overview of how {% data variables.product.prodname_ghe_server %} works, see "[System overview](/admin/overview/system-overview)." ## Part 1: Installing {% data variables.product.prodname_ghe_server %} To get started with {% data variables.product.prodname_ghe_server %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. ### 1. Creating your enterprise account Before you install {% data variables.product.prodname_ghe_server %}, you will first need to create an enterprise account on GitHub by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." -### 2. Installing a {% data variables.product.prodname_ghe_server %} instance -To get started with {% data variables.product.prodname_ghe_server %}, you will need to install your instance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." +### 2. Installing {% data variables.product.prodname_ghe_server %} +To get started with {% data variables.product.prodname_ghe_server %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." ### 3. Using the Management Console -You will use the Management Console to walk through the initial setup process when first launching your instance. You can also use the Management Console to manage virtual appliance settings such as the domain, authentication and SSL. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." +You will use the Management Console to walk through the initial setup process when first launching your instance. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." -### 4. Configuring your {% data variables.product.prodname_ghe_server %} instance -In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage your enterprise. You can configure applications and rate limits, view reports, use command-line utilities, and much more. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." +### 4. Configuring {% data variables.product.product_location %} +In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.product.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." You can use the default network settings used by {% data variables.product.prodname_ghe_server %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." ### 5. Configuring high availability -You can configure your {% data variables.product.prodname_ghe_server %} instance for high availability so that any hardware failures or major network outages don't disrupt service. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." +You can configure your {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." ### 6. Designating backups and disaster recovery -You can use {% data variables.product.prodname_ghe_server %} Backup Utilities to configure automated backups of your {% data variables.product.prodname_ghe_server %} instance, so that you can protect your production data. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." +To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." -### 7. Geo-replication -{% data variables.product.prodname_ghe_server %} can help to reduce latency between different hosts and locations, if your organization has offices in multiple locations. For more information, see "[About geo-replication](/admin/enterprise-management/configuring-high-availability/about-geo-replication)." ### 8. Managing billing for your enterprise Billing for all the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." diff --git a/data/reusables/getting-started/actions.md b/data/reusables/getting-started/actions.md index b5dbfb4b54..6fe3b20843 100644 --- a/data/reusables/getting-started/actions.md +++ b/data/reusables/getting-started/actions.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} are individual tasks you can combine to create jobs and customize your workflow. You can create your own actions, and use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. For more information, see “[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." +With {% data variables.product.prodname_actions %}, you can automate and customize {% data variables.product.product_location %}'s development workflow on {% data variables.product.product_name %}. You can create your own actions, and use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." From fc7ed52893aa06866bb6ca865bf40ead8e15fbf3 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Fri, 16 Jul 2021 16:49:30 -0400 Subject: [PATCH 38/52] Update getting-started-with-github-enterprise-server.md --- .../onboarding/getting-started-with-github-enterprise-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 dfd8e2ac6c..2cea561319 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 @@ -12,7 +12,7 @@ This guide will walk you through setting up, configuring and managing {% data va - **{% data variables.product.prodname_ghe_cloud %}** - **{% data variables.product.prodname_ghe_server %}** -{% data variables.product.company %} hosts {% data variables.product.prodname_ghe_cloud %}. You can deploy and host {% data variables.product.prodname_ghe_server %} in your own datacenter or a supported cloud provider. +{% data variables.product.company_short %} hosts {% data variables.product.prodname_ghe_cloud %}. You can deploy and host {% data variables.product.prodname_ghe_server %} in your own datacenter or a supported cloud provider. For an overview of how {% data variables.product.prodname_ghe_server %} works, see "[System overview](/admin/overview/system-overview)." From 5ed0543cb97d2c6b8884780f81a2b5e8029d1c5a Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Tue, 20 Jul 2021 17:52:42 -0400 Subject: [PATCH 39/52] Adding reusables for enterprise guides and trimming things in other guides --- .../initializing-github-ae.md | 2 +- .../getting-started-with-github-ae.md | 60 +++++++-------- ...ng-started-with-github-enterprise-cloud.md | 12 +-- ...g-started-with-github-enterprise-server.md | 73 +++++++++---------- .../getting-started-with-github-team.md | 28 +++---- ...etting-started-with-your-github-account.md | 3 + .../adding-members-to-organizations.md | 1 + .../configuring-security-features.md | 1 + .../contact-support-enterprise.md | 1 + .../getting-started/creating-organizations.md | 1 + .../getting-started/creating-teams.md | 1 + .../enforcing-repo-management-policies.md | 1 + .../github-pages-enterprise.md | 1 + .../reusables/getting-started/github-pages.md | 1 + .../learning-lab-enterprise.md | 3 + .../reusables/getting-started/learning-lab.md | 2 - .../managing-enterprise-members.md | 1 + .../setting-org-and-repo-permissions.md | 3 + .../github-ae/initialize-enterprise.md | 1 + 19 files changed, 99 insertions(+), 97 deletions(-) create mode 100644 data/reusables/getting-started/adding-members-to-organizations.md create mode 100644 data/reusables/getting-started/configuring-security-features.md create mode 100644 data/reusables/getting-started/contact-support-enterprise.md create mode 100644 data/reusables/getting-started/creating-organizations.md create mode 100644 data/reusables/getting-started/creating-teams.md create mode 100644 data/reusables/getting-started/enforcing-repo-management-policies.md create mode 100644 data/reusables/getting-started/github-pages-enterprise.md create mode 100644 data/reusables/getting-started/github-pages.md create mode 100644 data/reusables/getting-started/learning-lab-enterprise.md create mode 100644 data/reusables/getting-started/managing-enterprise-members.md create mode 100644 data/reusables/getting-started/setting-org-and-repo-permissions.md create mode 100644 data/reusables/github-ae/initialize-enterprise.md diff --git a/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index 304ff5e76b..e01cff790a 100644 --- a/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -13,7 +13,7 @@ redirect_from: Before you can initialize your enterprise, you must purchase {% data variables.product.product_name %}. For more information, contact {% data variables.contact.contact_enterprise_sales %}. -After you purchase {% data variables.product.product_name %}, we'll ask you to provide an email address and username for the person you want to initialize the enterprise. Your dedicated technical account manager in {% data variables.contact.enterprise_support %} will create an account for the enterprise owner and send the enterprise owner an email to log into {% data variables.product.product_name %} and complete the initialization. Make sure the information you provide matches the intended enterprise owner's information in the IdP. For more information about enterprise owners, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-owner)." +{% data reusables.github-ae.initialize-enterprise %} Make sure the information you provide matches the intended enterprise owner's information in the IdP. For more information about enterprise owners, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-owner)." {% note %} 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 452d57e0b5..1691f2d9d6 100644 --- a/content/get-started/onboarding/getting-started-with-github-ae.md +++ b/content/get-started/onboarding/getting-started-with-github-ae.md @@ -1,66 +1,64 @@ --- title: Getting started with GitHub AE -intro: 'Get started with setting up and configuring {% data variables.product.prodname_ghe_managed %} for your enterprise.' +intro: 'Get started with setting up and configuring {% data variables.product.product_name %} for {% data variables.product.product_location %}.' versions: ghae: '*' --- This guide will walk you through setting up, configuring, and managing settings for {% data variables.product.product_location %} on {% data variables.product.product_name %} as an enterprise owner. -## Part 1: Setting up {% data variables.product.prodname_ghe_managed %} -To get started with {% data variables.product.prodname_ghe_managed %}, you can create your enterprise account, initialize {% data variables.product.prodname_ghe_managed %}, configure an IP allow list, configure user authentication and provisioning, and manage billing for your enterprise. +## Part 1: Setting up {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you can create your enterprise account, initialize {% data variables.product.product_name %}, configure an IP allow list, configure user authentication and provisioning, and manage billing for {% data variables.product.product_location %}. -### 1. Creating your {% data variables.product.prodname_ghe_managed %} enterprise account -You will first need to purchase {% data variables.product.prodname_ghe_managed %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). +### 1. Creating your {% data variables.product.product_name %} enterprise account +You will first need to purchase {% data variables.product.product_name %}. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). -After you purchase {% data variables.product.prodname_ghe_managed %}, we will ask you for email address and username details for the person you want to initialize the enterprise, which will then be used by your dedicated technical account manager in {% data variables.product.prodname_dotcom %} Enterprise Support to create an account. +{% data reusables.github-ae.initialize-enterprise %} -### 2. Initializing {% data variables.product.prodname_ghe_managed %} -After {% data variables.product.company_short %} creates the owner account for your enterprise on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." +### 2. Initializing {% data variables.product.product_name %} +After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)." ### 3. Restricting network traffic You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)." -### 4. Managing identity and access for your enterprise +### 4. Managing identity and access for {% data variables.product.product_location %} You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)." -### 5. Managing billing for your enterprise -Owners of the subscription for your enterprise on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +### 5. Managing billing for {% data variables.product.product_location %} +Owners of the subscription for {% data variables.product.product_location %} on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." ## Part 2: Organizing and managing enterprise members -As an enterprise owner for {% data variables.product.prodname_ghe_managed %}, you can manage settings on user, repository, team, and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. +As an enterprise owner for {% data variables.product.product_name %}, you can manage settings on user, repository, team, and organization levels. You can manage members of {% data variables.product.product_location %}, create and manage organizations, set policies for repository management, and create and manage teams. -### 1. Managing and auditing enterprise members -You can manage settings and audit activity for the members of {% data variables.product.product_location %}. You can manage dormant users, view the audit log for user activity in {% data variables.product.product_location %}, and customize messages that users will see on {% data variables.product.product_location %}. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." +### 1. Managing members of {% data variables.product.product_location %} +{% data reusables.getting-started.managing-enterprise-members %} ### 2. Creating organizations -You can create new organizations in your enterprise to reflect your company or group's structure. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +{% data reusables.getting-started.creating-organizations %} ### 3. Adding members to organizations -You can add members to organizations in your enterprise as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "[Adding people to your organization](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)" and "[Configuring visibility for organization membership](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)." +{% data reusables.getting-started.adding-members-to-organizations %} ### 4. Creating teams -Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "[Creating teams](/organizations/organizing-members-into-teams/creating-a-team)" and "[Adding people to teams](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)." +{% data reusables.getting-started.creating-teams %} ### 5. Setting organization and repository permission levels -We recommend giving a limited number of members in each organization an organization owner role, which provides complete administrative access for that organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." - -For organizations where you have admin permissions, you can also customize access to each repository with granular permission levels. For more information, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." +{% data reusables.getting-started.setting-org-and-repo-permissions %} ### 6. Enforcing repository management policies -As an enterprise owner, you can set repository management policies for all organizations in your enterprise, or allow policies to be set in each organization. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." +{% data reusables.getting-started.enforcing-repo-management-policies %} ## Part 3: Building securely To increase the security of {% data variables.product.product_location %}, you can monitor {% data variables.product.product_location %} and configure security and analysis features for your organizations. -### 1. Monitoring your enterprise +### 1. Monitoring {% data variables.product.product_location %} You can monitor {% data variables.product.product_location %} with your activity dashboard and audit logging. For more information, see "[Monitoring activity in your enterprise](/admin/user-management/monitoring-activity-in-your-enterprise)." ### 2. Configuring security features for your organizations -You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +{% data reusables.getting-started.configuring-security-features %} ## Part 4: Customizing and automating work on {% data variables.product.product_location %} -You can customize and automate work in organizations in your enterprise with the {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, and {% data variables.product.prodname_pages %}. +You can customize and automate work in organizations in {% data variables.product.product_location %} with the {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, and {% data variables.product.prodname_pages %}. ### 1. Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} @@ -68,19 +66,15 @@ You can customize and automate work in organizations in your enterprise with the ### 2. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -For more information on enabling and configuring {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." +For more information on enabling and configuring {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)." ### 3. Using {% data variables.product.prodname_pages %} -{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." - - +{% data reusables.getting-started.github-pages-enterprise %} ## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources -Your users 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. +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 %} -Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} 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)." +{% data reusables.getting-started.learning-lab-enterprise %} ### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support -{% data variables.product.prodname_ghe_managed %} includes access to {% data variables.product.prodname_dotcom %} Enterprise Support. {% data variables.product.prodname_dotcom %} Enterprise Support can help you troubleshoot issues that come up on {% data variables.product.prodname_ghe_managed %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Enterprise Support](/admin/enterprise-support/overview/about-github-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 90d579e8b0..6dfe4c53c3 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 @@ -67,9 +67,9 @@ Contact your {% data variables.product.prodname_dotcom %} sales account represen #### 3. Viewing the subscription and usage for your enterprise account You can view your current subscription, license usage, invoices, payment history, and other billing information for your enterprise account at any time. Both enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Viewing the subscription and usage for your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." -## Part 3: Managing users and teams with {% data variables.product.prodname_ghe_cloud %} +## Part 3: Managing your organization or enterprise members and teams with {% data variables.product.prodname_ghe_cloud %} -### Managing users and teams for an organization +### Managing members and teams in your organization You can set permissions and member roles, create and manage teams, and give people access to repositories in your organization. #### 1. Managing members of your organization You can invite anyone to be a member of your organization, as long as they have a personal account on {% data variables.product.prodname_dotcom %}. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." @@ -90,7 +90,7 @@ You can give organization members, teams, and outside collaborators different le You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." ### Managing members of an enterprise account -Managing members of an enterprise is separate from managing members or teams in an organization. It is important to note that enterprise owners or administrators cannot access organization-level settings or manage users for organizations in their enterprise unless they are made an organization owner. For more information on managing users and teams for organizations, see the above section, "[Managing users and teams for an organization](#managing-users-and-teams-for-an-organization)." +Managing members of an enterprise is separate from managing members or teams in an organization. It is important to note that enterprise owners or administrators cannot access organization-level settings or manage members for organizations in their enterprise unless they are made an organization owner. For more information, see the above section, "[Managing members and teams in your organization](#managing-members-and-teams-in-your-organization)." #### 1. Assigning roles in an enterprise By default, everyone in an enterprise is a member of the enterprise. There are also administrative roles, including enterprise owner and billing manager, that have different levels of access to enterprise settings and data. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)." #### 2. Inviting people to manager your enterprise @@ -114,7 +114,7 @@ The audit log for your organization allows you, as an organization owner, to rev You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." #### 4. Enabling and enforcing SAML single sign-on for your organization -If you manage your users' identities and applications with an identity provider (IdP), you can configure SAML single-sign-on (SSO) to control and secure access to organization resources like repositories, issues and pull requests. When members of your organization access organization resources that use SAML SSO, {% data variables.product.prodname_dotcom %} will redirect them to your IdP to authenticate. For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." +If you manage your applications and the identities of your organization members with an identity provider (IdP), you can configure SAML single-sign-on (SSO) to control and secure access to organization resources like repositories, issues and pull requests. When members of your organization access organization resources that use SAML SSO, {% data variables.product.prodname_dotcom %} will redirect them to your IdP to authenticate. For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." Organization owners can choose to disable, enable but not enforce, or enable and enforce SAML SSO. For more information, see "[Enabling and testing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization)" and "[Enforcing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." #### 5. Managing team synchronization for your organization @@ -151,7 +151,7 @@ You can configure permissions for creating, transferring and deleting repositori You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." #### 3. Using organization-level community health files and moderation tools -You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. +You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. {% data variables.product.prodname_dotcom %} offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." @@ -175,6 +175,8 @@ Members of your organization or enterprise can use tools from the {% data variab {% data reusables.getting-started.actions %} ### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} +### 5. Using {% data variables.product.prodname_pages %} +{% data reusables.getting-started.github-pages %} ## 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. 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 2cea561319..b2f985ee8d 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 @@ -14,69 +14,70 @@ This guide will walk you through setting up, configuring and managing {% data va {% data variables.product.company_short %} hosts {% data variables.product.prodname_ghe_cloud %}. You can deploy and host {% data variables.product.prodname_ghe_server %} in your own datacenter or a supported cloud provider. -For an overview of how {% data variables.product.prodname_ghe_server %} works, see "[System overview](/admin/overview/system-overview)." +For an overview of how {% data variables.product.product_name %} works, see "[System overview](/admin/overview/system-overview)." -## Part 1: Installing {% data variables.product.prodname_ghe_server %} -To get started with {% data variables.product.prodname_ghe_server %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. +## Part 1: Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing. ### 1. Creating your enterprise account -Before you install {% data variables.product.prodname_ghe_server %}, you will first need to create an enterprise account on GitHub by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." -### 2. Installing {% data variables.product.prodname_ghe_server %} -To get started with {% data variables.product.prodname_ghe_server %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." +Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)." +### 2. Installing {% data variables.product.product_name %} +To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." ### 3. Using the Management Console -You will use the Management Console to walk through the initial setup process when first launching your instance. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." +You will use the Management Console to walk through the initial setup process when first launching {% data variables.product.product_location %}. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)." ### 4. Configuring {% data variables.product.product_location %} In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.product.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)." -You can use the default network settings used by {% data variables.product.prodname_ghe_server %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." +You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)." ### 5. Configuring high availability -You can configure your {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." +You can configure {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)." -### 6. Designating backups and disaster recovery +### 6. Setting up a staging instance +You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. For more information, see "[Setting up a staging instance](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." + +### 7. Designating backups and disaster recovery To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)." ### 8. Managing billing for your enterprise -Billing for all the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +Billing for all the organizations and {% data variables.product.product_name %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." ## Part 2: Organizing and managing your team -As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage users in your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. +As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage members of your enterprise, create and manage organizations, set policies for repository management, and create and manage teams. -### 1. Managing users of your enterprise instance -You can manage user settings and audit user activity in your enterprise, including promoting a user to a site administrator, managing dormant and suspended users, and customizing messages that users will see on your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." +### 1. Managing members of {% data variables.product.product_location %} +{% data reusables.getting-started.managing-enterprise-members %} ### 2. Creating organizations -You can create new organizations in your enterprise to reflect your company or group's structure. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +{% data reusables.getting-started.creating-organizations %} ### 3. Adding members to organizations -You can add members to organizations in your enterprise as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "[Adding people to your organization](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)" and "[Configuring visibility for organization membership](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)." +{% data reusables.getting-started.adding-members-to-organizations %} ### 4. Creating teams -Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "[Creating teams](/admin/user-management/managing-organizations-in-your-enterprise/creating-teams)" and "[Adding people to teams](/admin/user-management/managing-organizations-in-your-enterprise/adding-people-to-teams)." +{% data reusables.getting-started.creating-teams %} ### 5. Setting organization and repository permission levels -We recommend giving a limited number of members in each organization an organization owner role, which provides complete administrative access for that organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." - -For organizations where you have admin permissions, you can also customize access to each repository with granular permission levels. For more information, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." +{% data reusables.getting-started.setting-org-and-repo-permissions %} ### 6. Enforcing repository management policies - As an enterprise owner, you can set repository management policies for all organizations in your enterprise, or allow policies to be set in each organization. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." +{% data reusables.getting-started.enforcing-repo-management-policies %} ## Part 3: Building securely -To make your enterprise as secure as possible, you can configure authentication for users, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable {% data variables.product.prodname_GH_advanced_security %}. -### 1. Authenticating users -You can use {% data variables.product.prodname_ghe_server %}'s built-in authentication method, or you can choose between an established authentication provider, such as CAS, LDAP, or SAML, to integrate your existing accounts and centrally manage user access to your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Authenticating users for your {% data variables.product.prodname_ghe_server %} instance](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance)." +To increase the security of {% data variables.product.product_location %}, you can configure authentication for enterprise members, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable {% data variables.product.prodname_GH_advanced_security %}. +### 1. Authenticating enterprise members +You can use {% data variables.product.product_name %}'s built-in authentication method, or you can choose between an established authentication provider, such as CAS, LDAP, or SAML, to integrate your existing accounts and centrally manage user access to {% data variables.product.product_location %}. For more information, see "[Authenticating users for {% data variables.product.product_location %}](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance)." You can also require two-factor authentication for each of your organizations. For more information, see "[Requiring two factor authentication for an organization](/admin/user-management/managing-organizations-in-your-enterprise/requiring-two-factor-authentication-for-an-organization)." ### 2. Staying in compliance -You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/enterprise-server@3.1/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." +You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see "[Enforcing policy with pre-receive hooks](/admin/policies/enforcing-policy-with-pre-receive-hooks)" and "[Audit logging](/admin/user-management/monitoring-activity-in-your-enterprise/audit-logging)." ### 3. Configuring security features for your organizations -You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in your enterprise secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +{% data reusables.getting-started.configuring-security-features %} ### 4. Enabling {% data variables.product.prodname_GH_advanced_security %} features -You can upgrade your {% data variables.product.prodname_ghe_server %} license to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see "[{% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." +You can upgrade your {% data variables.product.product_name %} license to include {% data variables.product.prodname_GH_advanced_security %}. This provides extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see "[{% data variables.product.prodname_GH_advanced_security %} for your enterprise](/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." ## Part 4: Customizing and automating your enterprise's work on {% data variables.product.prodname_dotcom %} You can customize and automate work in organizations in your enterprise with {% data variables.product.prodname_dotcom %} and {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_dotcom %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}. @@ -88,28 +89,26 @@ You can build integrations with the {% data variables.product.prodname_dotcom %} ### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." +For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)." ### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -For more information on enabling and configuring {% data variables.product.prodname_registry %} for your {% data variables.product.prodname_ghe_server %} instance, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)." +For more information on enabling and configuring {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)." ### 5. Using {% data variables.product.prodname_pages %} -{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository in your enterprise and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your users at the organization level. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." +{% data reusables.getting-started.github-pages-enterprise %} ## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources You can use {% data variables.product.prodname_github_connect %} and {% data variables.product.prodname_insights %} to share resources and understand and improve your processes. ### 1. Enabling {% data variables.product.prodname_github_connect %} -If you are the owner of both a {% data variables.product.prodname_ghe_server %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between your {% data variables.product.prodname_ghe_server %} instance and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." +If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)." ### 2. Using {% data variables.product.prodname_insights %} -{% data variables.product.prodname_insights %} is a standalone application that provides analytic reports and metrics based on data from your {% data variables.product.prodname_ghe_server %} instance. You can use these reports to understand and improve your software delivery process. For more information, see "[About {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/installing-and-updating-github-insights/about-github-insights)." +{% data variables.product.prodname_insights %} is a standalone application that provides analytic reports and metrics based on data from {% data variables.product.product_location %}. You can use these reports to understand and improve your software delivery process. For more information, see "[About {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/installing-and-updating-github-insights/about-github-insights)." ## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources -Your users 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 your {% data variables.product.prodname_ghe_server %} instance with {% data variables.product.prodname_dotcom %} Enterprise Support. +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 %} -Your users can learn new skills by completing fun, realistic projects in their very own {% data variables.product.prodname_dotcom %} repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the {% data variables.product.prodname_dotcom %} 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)." +{% data reusables.getting-started.learning-lab-enterprise %} ### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support -{% data variables.product.prodname_ghe_server %} includes access to {% data variables.product.prodname_dotcom %} Enterprise Support. {% data variables.product.prodname_dotcom %} Enterprise Support can help you troubleshoot issues that come up on {% data variables.product.prodname_ghe_server %}. You can also choose to sign up for {% data variables.product.prodname_dotcom %} Premium Support for additional features. For more information, see "[About {% data variables.product.prodname_dotcom %} Enterprise Support](/admin/enterprise-support/overview/about-github-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 9bfc62b81a..3c7ced5fb9 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -23,9 +23,7 @@ You must manage billing settings, payment method, and paid features and products Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)." -{% data variables.product.prodname_dotcom %} sends receipts and other billing-related information to your organization's billing email. For more information, see "[Setting your organization's billing email](/billing/managing-your-github-billing-settings/setting-your-billing-email#setting-your-organizations-billing-email)." - -Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is a user who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." +Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is someone who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." ## Part 2: Adding members and setting up teams @@ -42,8 +40,6 @@ Each person in your organization has a role that defines their level of access t Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews, and teams can be visible or secret. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." - -Teams can participate in team discussions on their team page to plan together, give status updates, or talk about any topic. Discussions can be open to all organization members or private to the team. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." ### 4. Managing team settings You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." @@ -71,9 +67,7 @@ You can also review and configure the permission levels for your organization's ### 1. Managing organization policies You can manage permissions and policies for a number of different actions and features in your organization. -For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)." - -You can also manage the forking policy for the organization, choosing to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." +For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. You can also choose to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" and "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." ### 2. Managing repository changes @@ -87,20 +81,20 @@ GitHub offers multiple tools for moderating and managing your community. For mor ## Part 5: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} - -{% ifversion fpt %} ### 1. Using {% data variables.product.prodname_marketplace %} {% data reusables.getting-started.marketplace %} -{% endif %} -### {% ifversion fpt %}2.{% else %}1.{% endif %} Using the {% data variables.product.prodname_dotcom %} API +### 2. Using the {% data variables.product.prodname_dotcom %} API {% data reusables.getting-started.api %} -### {% ifversion fpt %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %} +### 3. Building {% data variables.product.prodname_actions %} {% data reusables.getting-started.actions %} -### {% ifversion fpt %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} +### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} +### 5. Using {% data variables.product.prodname_pages %} +{% data reusables.getting-started.github-pages %} + ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} ### 1. Contributing to open source projects @@ -112,15 +106,11 @@ GitHub offers multiple tools for moderating and managing your community. For mor ### 3. Learning with {% data variables.product.prodname_learning %} {% data reusables.getting-started.learning-lab %} -{% ifversion fpt %} ### 4. Supporting the open source community {% data reusables.getting-started.sponsors %} ### 5. Contacting {% data variables.contact.github_support %} {% data reusables.getting-started.contact-support %} -{% endif %} - -{% ifversion fpt %} ## Further reading + - "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)" -{% endif %} 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 d977aa04bd..bb75f352b4 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 @@ -156,6 +156,9 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi ### {% ifversion fpt %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} +### {% ifversion fpt %}5.{% else %}4.{% endif %} Using {% data variables.product.prodname_pages %} +{% data reusables.getting-started.github-pages %} + ## Part 5: Building securely on {% data variables.product.product_name %} {% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." ### 1. Securing your repository diff --git a/data/reusables/getting-started/adding-members-to-organizations.md b/data/reusables/getting-started/adding-members-to-organizations.md new file mode 100644 index 0000000000..4a3c73eb89 --- /dev/null +++ b/data/reusables/getting-started/adding-members-to-organizations.md @@ -0,0 +1 @@ +You can add members to organizations in {% data variables.product.product_location %} as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "[Adding people to your organization](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)" and "[Configuring visibility for organization membership](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)." \ No newline at end of file diff --git a/data/reusables/getting-started/configuring-security-features.md b/data/reusables/getting-started/configuring-security-features.md new file mode 100644 index 0000000000..3a2863bab4 --- /dev/null +++ b/data/reusables/getting-started/configuring-security-features.md @@ -0,0 +1 @@ +You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in {% data variables.product.product_location %} secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." \ No newline at end of file diff --git a/data/reusables/getting-started/contact-support-enterprise.md b/data/reusables/getting-started/contact-support-enterprise.md new file mode 100644 index 0000000000..4ef73c93cd --- /dev/null +++ b/data/reusables/getting-started/contact-support-enterprise.md @@ -0,0 +1 @@ +{% data variables.product.product_name %} includes access to {% data variables.contact.enterprise_support %}. {% data variables.contact.enterprise_support %} can help you troubleshoot issues that come up on {% data variables.product.product_name %}. {% ifversion ghes %}You can also choose to sign up for {% data variables.product.prodname_dotcom %} Premium Support for additional features. {% endif %}For more information, see "[About {% data variables.contact.enterprise_support %}](/admin/enterprise-support/overview/about-github-enterprise-support)." \ No newline at end of file diff --git a/data/reusables/getting-started/creating-organizations.md b/data/reusables/getting-started/creating-organizations.md new file mode 100644 index 0000000000..f7e4c0b6d1 --- /dev/null +++ b/data/reusables/getting-started/creating-organizations.md @@ -0,0 +1 @@ +You can create new organizations in {% data variables.product.product_location %} to reflect your company or group's structure. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." \ No newline at end of file diff --git a/data/reusables/getting-started/creating-teams.md b/data/reusables/getting-started/creating-teams.md new file mode 100644 index 0000000000..577b1285f6 --- /dev/null +++ b/data/reusables/getting-started/creating-teams.md @@ -0,0 +1 @@ +Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "[Creating teams](/organizations/organizing-members-into-teams/creating-a-team)" and "[Adding people to teams](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)." \ No newline at end of file diff --git a/data/reusables/getting-started/enforcing-repo-management-policies.md b/data/reusables/getting-started/enforcing-repo-management-policies.md new file mode 100644 index 0000000000..531efd9933 --- /dev/null +++ b/data/reusables/getting-started/enforcing-repo-management-policies.md @@ -0,0 +1 @@ +As an enterprise owner, you can set repository management policies for all organizations in {% data variables.product.product_location %}, or allow policies to be set separately in each organization. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." \ No newline at end of file diff --git a/data/reusables/getting-started/github-pages-enterprise.md b/data/reusables/getting-started/github-pages-enterprise.md new file mode 100644 index 0000000000..7c384adc16 --- /dev/null +++ b/data/reusables/getting-started/github-pages-enterprise.md @@ -0,0 +1 @@ +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your enterprise members at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)" and "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." \ No newline at end of file diff --git a/data/reusables/getting-started/github-pages.md b/data/reusables/getting-started/github-pages.md new file mode 100644 index 0000000000..035807ddae --- /dev/null +++ b/data/reusables/getting-started/github-pages.md @@ -0,0 +1 @@ +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository and publishes a website. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." \ No newline at end of file diff --git a/data/reusables/getting-started/learning-lab-enterprise.md b/data/reusables/getting-started/learning-lab-enterprise.md new file mode 100644 index 0000000000..120c7d658f --- /dev/null +++ b/data/reusables/getting-started/learning-lab-enterprise.md @@ -0,0 +1,3 @@ +Your enterprise members can learn new skills by completing fun, realistic projects in their 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)." \ No newline at end of file diff --git a/data/reusables/getting-started/learning-lab.md b/data/reusables/getting-started/learning-lab.md index 9ff0d3c235..efea922312 100644 --- a/data/reusables/getting-started/learning-lab.md +++ b/data/reusables/getting-started/learning-lab.md @@ -1,5 +1,3 @@ You 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. -To better understand some basic concepts, you can refer to the [{% data variables.product.prodname_dotcom %} guides](https://guides.github.com). - For more information, see “[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." \ No newline at end of file diff --git a/data/reusables/getting-started/managing-enterprise-members.md b/data/reusables/getting-started/managing-enterprise-members.md new file mode 100644 index 0000000000..ebd7c11bfe --- /dev/null +++ b/data/reusables/getting-started/managing-enterprise-members.md @@ -0,0 +1 @@ +You can manage settings and audit activity for the members of {% data variables.product.product_location %}. You can {% ifversion ghes %}promote an enterprise member to be a site administrator, {% endif %}manage dormant users, view the audit log for user activity, and customize messages that enterprise members will see. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." \ No newline at end of file diff --git a/data/reusables/getting-started/setting-org-and-repo-permissions.md b/data/reusables/getting-started/setting-org-and-repo-permissions.md new file mode 100644 index 0000000000..46bf2159f6 --- /dev/null +++ b/data/reusables/getting-started/setting-org-and-repo-permissions.md @@ -0,0 +1,3 @@ +We recommend giving a limited number of members in each organization an organization owner role, which provides complete administrative access for that organization. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." + +For organizations where you have admin permissions, you can also customize access to each repository with granular permission levels. For more information, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." \ No newline at end of file diff --git a/data/reusables/github-ae/initialize-enterprise.md b/data/reusables/github-ae/initialize-enterprise.md new file mode 100644 index 0000000000..71dc7714bd --- /dev/null +++ b/data/reusables/github-ae/initialize-enterprise.md @@ -0,0 +1 @@ +After you purchase {% data variables.product.product_name %}, we'll ask you to provide an email address and username for the person you want to initialize the enterprise. Your dedicated technical account manager in {% data variables.contact.enterprise_support %} will create an account for the enterprise owner and send the enterprise owner an email to log into {% data variables.product.product_name %} and complete the initialization. \ No newline at end of file From f9bc621a293fa66bf6a7e26a491d8314eebad455 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 21 Jul 2021 11:00:55 -0400 Subject: [PATCH 40/52] removing extra pages section in guide --- .../get-started/onboarding/getting-started-with-github-team.md | 3 --- .../onboarding/getting-started-with-your-github-account.md | 3 --- data/reusables/getting-started/github-pages.md | 1 - 3 files changed, 7 deletions(-) delete mode 100644 data/reusables/getting-started/github-pages.md 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 3c7ced5fb9..6b945f85e4 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -92,9 +92,6 @@ GitHub offers multiple tools for moderating and managing your community. For mor ### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -### 5. Using {% data variables.product.prodname_pages %} -{% data reusables.getting-started.github-pages %} - ## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community {% data reusables.getting-started.participating-in-community %} ### 1. Contributing to open source projects 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 bb75f352b4..d977aa04bd 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 @@ -156,9 +156,6 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi ### {% ifversion fpt %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} -### {% ifversion fpt %}5.{% else %}4.{% endif %} Using {% data variables.product.prodname_pages %} -{% data reusables.getting-started.github-pages %} - ## Part 5: Building securely on {% data variables.product.product_name %} {% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)." ### 1. Securing your repository diff --git a/data/reusables/getting-started/github-pages.md b/data/reusables/getting-started/github-pages.md deleted file mode 100644 index 035807ddae..0000000000 --- a/data/reusables/getting-started/github-pages.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository and publishes a website. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." \ No newline at end of file From 5c2cfb5f7ef7321a568482f1cefbe43387e99fec Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 21 Jul 2021 11:14:41 -0400 Subject: [PATCH 41/52] Update getting-started-with-github-enterprise-cloud.md --- .../onboarding/getting-started-with-github-enterprise-cloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 6dfe4c53c3..ee6e908e67 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 @@ -176,7 +176,7 @@ Members of your organization or enterprise can use tools from the {% data variab ### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ### 5. Using {% data variables.product.prodname_pages %} -{% data reusables.getting-started.github-pages %} +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository and publishes a website. You can manage the publication of {% data variables.product.prodname_pages %} sites at the organization level. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" and "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." ## 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. From 265f0745654217b64dfab2e02c728206d476aae8 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Wed, 21 Jul 2021 10:40:42 -0500 Subject: [PATCH 42/52] Update `actions-linter` to latest for `concurrency` key support (#20441) * Update version of actions-linter to support 'concurrency' key * Update .github/workflows/workflow-lint.yml * Revert casing of 'fromJson' to 'fromJSON' --- .github/allowed-actions.js | 2 +- .github/workflows/link-check-dotcom.yml | 2 +- .github/workflows/link-check-ghae.yml | 2 +- .github/workflows/link-check-ghes.yml | 2 +- .github/workflows/openapi-schema-check.yml | 2 +- .github/workflows/test.yml | 2 +- .github/workflows/triage-unallowed-contributions.yml | 6 +++--- .github/workflows/workflow-lint.yml | 4 ++-- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index b0721cfde3..d4404be8a8 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -14,7 +14,7 @@ export default [ 'andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84', 'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688', 'crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c', - 'cschleiden/actions-linter@0ff16d6ac5103cca6c92e6cbc922b646baaea5be', + 'cschleiden/actions-linter@5f9827c6b731d2c2480cd3bccf82079bbba832fc', 'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911', 'docker://chinthakagodawita/autoupdate-action:v1', 'dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58', diff --git a/.github/workflows/link-check-dotcom.yml b/.github/workflows/link-check-dotcom.yml index 5e5d0ad3a0..14195faf92 100644 --- a/.github/workflows/link-check-dotcom.yml +++ b/.github/workflows/link-check-dotcom.yml @@ -13,7 +13,7 @@ on: jobs: build: - runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} + runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything diff --git a/.github/workflows/link-check-ghae.yml b/.github/workflows/link-check-ghae.yml index ca31065d1b..0ea37f5fbc 100644 --- a/.github/workflows/link-check-ghae.yml +++ b/.github/workflows/link-check-ghae.yml @@ -13,7 +13,7 @@ on: jobs: build: - runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} + runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything diff --git a/.github/workflows/link-check-ghes.yml b/.github/workflows/link-check-ghes.yml index b42fd433e0..8a5ac63c14 100644 --- a/.github/workflows/link-check-ghes.yml +++ b/.github/workflows/link-check-ghes.yml @@ -13,7 +13,7 @@ on: jobs: build: - runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} + runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything diff --git a/.github/workflows/openapi-schema-check.yml b/.github/workflows/openapi-schema-check.yml index e6cbb5b933..d447ab457a 100644 --- a/.github/workflows/openapi-schema-check.yml +++ b/.github/workflows/openapi-schema-check.yml @@ -14,7 +14,7 @@ on: jobs: check-schema-versions: if: ${{ github.repository == 'github/docs-internal' }} - runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} + runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: - name: Checkout repository code uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6d76a52448..20ee37a2de 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -20,7 +20,7 @@ jobs: test: # Run on self-hosted if the private repo or ubuntu-latest if the public repo # See pull # 17442 in the private repo for context - runs-on: ${{ fromJson('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} + runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} timeout-minutes: 60 strategy: fail-fast: false diff --git a/.github/workflows/triage-unallowed-contributions.yml b/.github/workflows/triage-unallowed-contributions.yml index 8ef98fbb46..1422ddb64e 100644 --- a/.github/workflows/triage-unallowed-contributions.yml +++ b/.github/workflows/triage-unallowed-contributions.yml @@ -87,7 +87,7 @@ jobs: # and no review exists,leave a REQUEST_CHANGES review - name: Request pull request changes # Check for no reviews or reviews that aren't CHANGES_REQUESTED - if: ${{ steps.filter.outputs.notAllowed == 'true' && (!steps.requested-change.outputs.result || fromJson(steps.requested-change.outputs.result).state != 'CHANGES_REQUESTED') }} + if: ${{ steps.filter.outputs.notAllowed == 'true' && (!steps.requested-change.outputs.result || fromJSON(steps.requested-change.outputs.result).state != 'CHANGES_REQUESTED') }} uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d with: github-token: ${{secrets.GITHUB_TOKEN}} @@ -126,7 +126,7 @@ jobs: - name: Dismiss pull request review # Check that unallowed files aren't modified and that a # CHANGES_REQUESTED review already exists - if: ${{ steps.filter.outputs.notAllowed == 'false' && steps.requested-change.outputs.result && fromJson(steps.requested-change.outputs.result).state == 'CHANGES_REQUESTED' }} + if: ${{ steps.filter.outputs.notAllowed == 'false' && steps.requested-change.outputs.result && fromJSON(steps.requested-change.outputs.result).state == 'CHANGES_REQUESTED' }} uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d with: github-token: ${{secrets.GITHUB_TOKEN}} @@ -134,6 +134,6 @@ jobs: await github.pulls.dismissReview({ ...context.repo, pull_number: context.payload.number, - review_id: ${{fromJson(steps.requested-change.outputs.result).id}}, + review_id: ${{fromJSON(steps.requested-change.outputs.result).id}}, message: `✨Looks like you reverted all files we don't accept contributions for. 🙌 A member of the docs team will review your PR soon. 🚂` }) diff --git a/.github/workflows/workflow-lint.yml b/.github/workflows/workflow-lint.yml index 6779e97adf..551180b03b 100644 --- a/.github/workflows/workflow-lint.yml +++ b/.github/workflows/workflow-lint.yml @@ -24,6 +24,6 @@ jobs: uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - name: Run linter - uses: cschleiden/actions-linter@0ff16d6ac5103cca6c92e6cbc922b646baaea5be + uses: cschleiden/actions-linter@5f9827c6b731d2c2480cd3bccf82079bbba832fc with: - workflows: '[".github/workflows/*.yml", "!.github/workflows/staging-deploy-pr.yml", "!.github/workflows/staging-undeploy-pr.yml"]' + workflows: '[".github/workflows/*.yml"]' From 5b2c79edef167c9dbdaf8f988c9221ba3bd214b3 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 21 Jul 2021 12:48:32 -0400 Subject: [PATCH 43/52] last minor changes - fixed typo and streamlined some text --- ...etting-started-with-github-enterprise-cloud.md | 15 ++++++++------- .../getting-started-with-github-team.md | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) 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 ee6e908e67..e19f8fec3a 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 @@ -93,7 +93,7 @@ You can also customize access to your organization's project boards and allow in Managing members of an enterprise is separate from managing members or teams in an organization. It is important to note that enterprise owners or administrators cannot access organization-level settings or manage members for organizations in their enterprise unless they are made an organization owner. For more information, see the above section, "[Managing members and teams in your organization](#managing-members-and-teams-in-your-organization)." #### 1. Assigning roles in an enterprise By default, everyone in an enterprise is a member of the enterprise. There are also administrative roles, including enterprise owner and billing manager, that have different levels of access to enterprise settings and data. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/roles-in-an-enterprise)." -#### 2. Inviting people to manager your enterprise +#### 2. Inviting people to manage your enterprise You can invite people to manage your enterprise as enterprise owners or billing managers, as well as remove those who no longer need access. For more information, see "[Inviting people to manage your enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)." You can also grant enterprise members the ability to manage support tickets in the support portal. For more information, see "[Managing support entitlements for your enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." @@ -103,11 +103,12 @@ To audit access to enterprise-owned resources or user license usage, you can vie ## Part 4: Managing security with {% data variables.product.prodname_ghe_cloud %} ### Managing security for a single organization +You can help keep your organization secure by requiring two-factor authentication, configuring security features, reviewing your organization's audit log and integrations, and enabling SAML single sign-on and team synchronization. #### 1. Requiring two-factor authentication You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." #### 2. Configuring security features for your organization -You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +To keep your organization secure, you can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." #### 3. Reviewing your organization's audit log and integrations The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." @@ -121,7 +122,7 @@ Organization owners can choose to disable, enable but not enforce, or enable and Organization owners can enable team synchronization between your identity provider (IdP) and {% data variables.product.prodname_dotcom %} to allow organization owners and team maintainers to connect teams in your organization with IdP groups. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." ### Managing security for an enterprise account with multiple organizations - +To manage security for your enterprise, you can require two-factor authentication, manage allowed IP addresses, enable SAML single sign-on and team synchronization at an enterprise level, and sign up for and enforce GitHub Advanced Security features. #### 1. Requiring two-factor authentication and managing allowed IP addresses for organizations in your enterprise account Enterprise owners can require that organization members, billing managers, and outside collaborators in all organizations owned by an enterprise account use two-factor authentication to secure their personal accounts. Before doing so, we recommend notifying all who have access to organizations in your enterprise. You can also configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. @@ -138,16 +139,15 @@ If you have a GitHub Advanced Security license for your enterprise account, you ## Part 5: Managing organization and enterprise level policies and settings ### Managing settings for a single organization +To manage and moderate your organization, you can set organization policies, manage permissions for repository changes, and use organization-level community health files. #### 1. Managing organization policies You can manage permissions and policies for a number of different actions and features in your organization. -For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)." - -You can also manage the forking policy for the organization, choosing to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." +For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. You can also choose to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" and "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." #### 2. Managing repository changes -You can configure permissions for creating, transferring and deleting repositories in your organization, including which types can be created by members. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." +You can configure permissions for creating, transferring and deleting repositories in your organization, including which types members can create. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." #### 3. Using organization-level community health files and moderation tools @@ -156,6 +156,7 @@ You can create default community health files, such as a CONTRIBUTING.md file, a {% data variables.product.prodname_dotcom %} offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." ### Managing settings for an enterprise account +To manage and moderate your enterprise, you can set policies for organizations within the enterprise, view audit logs, configure webhooks, and restrict email notifications. #### 1. Managing policies for organizations in your enterprise account You can choose to enforce a number of policies for all organizations owned by your enterprise, or choose to allow these policies to be set in each organization. Types of policies you can enforce include repository management, project board, and team policies. For more information, see "[Set organization policies](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account)." 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 6b945f85e4..e809768837 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -43,7 +43,7 @@ You can create independent teams or have multiple levels of nested teams to refl ### 4. Managing team settings You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." -You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." +In your team's settings, you can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." ### 5. Giving people and teams access to repositories, project boards and apps You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." From 1db13df9a382e2c314bc794c23ac3bab1c2becf1 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 21 Jul 2021 13:38:20 -0400 Subject: [PATCH 44/52] final change - added reusables for cloud and team overlapping content --- ...ng-started-with-github-enterprise-cloud.md | 40 +++++-------------- .../getting-started-with-github-team.md | 39 +++++------------- .../about-and-creating-teams.md | 3 ++ .../configuring-security-features.md | 2 +- ...ng-access-to-repositories-projects-apps.md | 3 ++ .../getting-started/managing-org-members.md | 1 + .../getting-started/managing-org-policies.md | 5 +++ .../getting-started/managing-repo-changes.md | 3 ++ .../getting-started/managing-team-settings.md | 3 ++ .../org-permissions-and-roles.md | 1 + .../getting-started/requiring-2fa.md | 1 + ...eviewing-org-audit-log-and-integrations.md | 3 ++ ...rg-community-files-and-moderation-tools.md | 3 ++ 13 files changed, 49 insertions(+), 58 deletions(-) create mode 100644 data/reusables/getting-started/about-and-creating-teams.md create mode 100644 data/reusables/getting-started/giving-access-to-repositories-projects-apps.md create mode 100644 data/reusables/getting-started/managing-org-members.md create mode 100644 data/reusables/getting-started/managing-org-policies.md create mode 100644 data/reusables/getting-started/managing-repo-changes.md create mode 100644 data/reusables/getting-started/managing-team-settings.md create mode 100644 data/reusables/getting-started/org-permissions-and-roles.md create mode 100644 data/reusables/getting-started/requiring-2fa.md create mode 100644 data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md create mode 100644 data/reusables/getting-started/using-org-community-files-and-moderation-tools.md 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 e19f8fec3a..7cb9f7b796 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 @@ -72,22 +72,15 @@ You can view your current subscription, license usage, invoices, payment history ### Managing members and teams in your organization You can set permissions and member roles, create and manage teams, and give people access to repositories in your organization. #### 1. Managing members of your organization -You can invite anyone to be a member of your organization, as long as they have a personal account on {% data variables.product.prodname_dotcom %}. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." +{% data reusables.getting-started.managing-org-members %} #### 2. Organization permissions and roles -Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." +{% data reusables.getting-started.org-permissions-and-roles %} #### 3. About and creating teams -Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." - -You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." - +{% data reusables.getting-started.about-and-creating-teams %} #### 4. Managing team settings -You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." - -You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." +{% data reusables.getting-started.managing-team-settings %} #### 5. Giving people and teams access to repositories, project boards and apps -You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." - -You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." +{% data reusables.getting-started.giving-access-to-repositories-projects-apps %} ### Managing members of an enterprise account Managing members of an enterprise is separate from managing members or teams in an organization. It is important to note that enterprise owners or administrators cannot access organization-level settings or manage members for organizations in their enterprise unless they are made an organization owner. For more information, see the above section, "[Managing members and teams in your organization](#managing-members-and-teams-in-your-organization)." @@ -105,15 +98,12 @@ To audit access to enterprise-owned resources or user license usage, you can vie ### Managing security for a single organization You can help keep your organization secure by requiring two-factor authentication, configuring security features, reviewing your organization's audit log and integrations, and enabling SAML single sign-on and team synchronization. #### 1. Requiring two-factor authentication -You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." - +{% data reusables.getting-started.requiring-2fa %} #### 2. Configuring security features for your organization -To keep your organization secure, you can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +{% data reusables.getting-started.configuring-security-features %} #### 3. Reviewing your organization's audit log and integrations -The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." - -You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." +{% data reusables.getting-started.reviewing-org-audit-log-and-integrations %} #### 4. Enabling and enforcing SAML single sign-on for your organization If you manage your applications and the identities of your organization members with an identity provider (IdP), you can configure SAML single-sign-on (SSO) to control and secure access to organization resources like repositories, issues and pull requests. When members of your organization access organization resources that use SAML SSO, {% data variables.product.prodname_dotcom %} will redirect them to your IdP to authenticate. For more information, see "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." @@ -141,19 +131,11 @@ If you have a GitHub Advanced Security license for your enterprise account, you ### Managing settings for a single organization To manage and moderate your organization, you can set organization policies, manage permissions for repository changes, and use organization-level community health files. #### 1. Managing organization policies -You can manage permissions and policies for a number of different actions and features in your organization. - -For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. You can also choose to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" and "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." - -For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." +{% data reusables.getting-started.managing-org-policies %} #### 2. Managing repository changes -You can configure permissions for creating, transferring and deleting repositories in your organization, including which types members can create. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." - -You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." +{% data reusables.getting-started.managing-repo-changes %} #### 3. Using organization-level community health files and moderation tools -You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. - -{% data variables.product.prodname_dotcom %} offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." +{% data reusables.getting-started.using-org-community-files-and-moderation-tools %} ### Managing settings for an enterprise account To manage and moderate your enterprise, you can set policies for organizations within the enterprise, view audit logs, configure webhooks, and restrict email notifications. 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 e809768837..9dd0d943ff 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -30,54 +30,37 @@ Only organization members with the *owner* or *billing manager* role can access After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, project boards, and apps. ### 1. Managing members of your organization -You can invite anyone to be a member of your organization, as long as they have a personal account on GitHub. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." +{% data reusables.getting-started.managing-org-members %} -Organization members can stay up-to-date with recent activity or keep track of issues and pull requests by visiting the organization dashboard. For more information, see "[About your organization dashboard](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)." ### 2. Organization permissions and roles -Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." +{% data reusables.getting-started.org-permissions-and-roles %} ### 3. About and creating teams -Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews, and teams can be visible or secret. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." - -You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." +{% data reusables.getting-started.about-and-creating-teams %} ### 4. Managing team settings -You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." - -In your team's settings, you can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." +{% data reusables.getting-started.managing-team-settings %} ### 5. Giving people and teams access to repositories, project boards and apps -You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." - -You can also customize access to your organization's project boards and allow individual organization members to manage your organization's GitHub Apps. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." +{% data reusables.getting-started.giving-access-to-repositories-projects-apps %} ## Part 3: Managing security for your organization You can help to make your organization more secure by recommending or requiring two-factor authentication for your organization members, configuring security features, and reviewing your organization's audit log and integrations. ### 1. Requiring two-factor authentication -You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." +{% data reusables.getting-started.requiring-2fa %} ### 2. Configuring security features for your organization -You can use a variety of GitHub security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep your organization secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +{% data reusables.getting-started.configuring-security-features %} ### 3. Reviewing your organization's audit log and integrations -The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." - -You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." +{% data reusables.getting-started.reviewing-org-audit-log-and-integrations %} ## Part 4: Setting organization level policies ### 1. Managing organization policies -You can manage permissions and policies for a number of different actions and features in your organization. - -For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. You can also choose to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" and "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." - -For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." +{% data reusables.getting-started.managing-org-policies %} ### 2. Managing repository changes -You can configure permissions for creating, transferring and deleting repositories in your organization, including which types can be created by members. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." - -You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." +{% data reusables.getting-started.managing-repo-changes %} ### 3. Using organization-level community health files and moderation tools -You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. - -GitHub offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." +{% data reusables.getting-started.using-org-community-files-and-moderation-tools %} ## Part 5: Customizing and automating your work on {% data variables.product.product_name %} {% data reusables.getting-started.customizing-and-automating %} diff --git a/data/reusables/getting-started/about-and-creating-teams.md b/data/reusables/getting-started/about-and-creating-teams.md new file mode 100644 index 0000000000..7d24c2bd68 --- /dev/null +++ b/data/reusables/getting-started/about-and-creating-teams.md @@ -0,0 +1,3 @@ +Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews, and teams can be visible or secret. For more information, see "[About teams](/organizations/organizing-members-into-teams/about-teams)." + +You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." \ No newline at end of file diff --git a/data/reusables/getting-started/configuring-security-features.md b/data/reusables/getting-started/configuring-security-features.md index 3a2863bab4..d46bcd7afe 100644 --- a/data/reusables/getting-started/configuring-security-features.md +++ b/data/reusables/getting-started/configuring-security-features.md @@ -1 +1 @@ -You can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates, to keep the organizations in {% data variables.product.product_location %} secure. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." \ No newline at end of file +To keep {% ifversion ghes or ghae %}the organizations in {% data variables.product.product_location %}{% else %}your organization{% endif %} secure, you can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." \ No newline at end of file diff --git a/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md b/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md new file mode 100644 index 0000000000..86713dd609 --- /dev/null +++ b/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md @@ -0,0 +1,3 @@ +You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with granular permission levels. For more information, see "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." + +You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." \ No newline at end of file diff --git a/data/reusables/getting-started/managing-org-members.md b/data/reusables/getting-started/managing-org-members.md new file mode 100644 index 0000000000..e2d7fa37e6 --- /dev/null +++ b/data/reusables/getting-started/managing-org-members.md @@ -0,0 +1 @@ +You can invite anyone to be a member of your organization, as long as they have a personal account on {% data variables.product.prodname_dotcom %}. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." \ No newline at end of file diff --git a/data/reusables/getting-started/managing-org-policies.md b/data/reusables/getting-started/managing-org-policies.md new file mode 100644 index 0000000000..dcd2afdeb0 --- /dev/null +++ b/data/reusables/getting-started/managing-org-policies.md @@ -0,0 +1,5 @@ +You can manage permissions and policies for a number of different actions and features in your organization. + +For example, to protect your organization's data and number of paid licenses, you can choose to allow only organization owners to invite outside collaborators to organization repositories. You can also choose to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Setting permissions for adding outside collaborators](/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" and "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." + +For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." \ No newline at end of file diff --git a/data/reusables/getting-started/managing-repo-changes.md b/data/reusables/getting-started/managing-repo-changes.md new file mode 100644 index 0000000000..205fffe2ae --- /dev/null +++ b/data/reusables/getting-started/managing-repo-changes.md @@ -0,0 +1,3 @@ +You can configure permissions for creating, transferring and deleting repositories in your organization, including which types members can create. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." + +You can also restrict or grant the ability to change repository visibility. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." \ No newline at end of file diff --git a/data/reusables/getting-started/managing-team-settings.md b/data/reusables/getting-started/managing-team-settings.md new file mode 100644 index 0000000000..cb5df4efb4 --- /dev/null +++ b/data/reusables/getting-started/managing-team-settings.md @@ -0,0 +1,3 @@ +You can designate a "team maintainer" to manage team settings and discussions, among other privileges. For more information, see "[Giving "team maintainer" permissions to an organization member](/organizations/managing-peoples-access-to-your-organization-with-roles/giving-team-maintainer-permissions-to-an-organization-member)." + +You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." \ No newline at end of file diff --git a/data/reusables/getting-started/org-permissions-and-roles.md b/data/reusables/getting-started/org-permissions-and-roles.md new file mode 100644 index 0000000000..44f272f086 --- /dev/null +++ b/data/reusables/getting-started/org-permissions-and-roles.md @@ -0,0 +1 @@ +Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. For more information, see "[Permission levels for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization)." \ No newline at end of file diff --git a/data/reusables/getting-started/requiring-2fa.md b/data/reusables/getting-started/requiring-2fa.md new file mode 100644 index 0000000000..a567e5ff1d --- /dev/null +++ b/data/reusables/getting-started/requiring-2fa.md @@ -0,0 +1 @@ +You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. For more information, see "[Requiring two-factor authentication in your organization](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)." \ No newline at end of file diff --git a/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md b/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md new file mode 100644 index 0000000000..7beb0fe241 --- /dev/null +++ b/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md @@ -0,0 +1,3 @@ +The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the last 90 days. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." + +You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." \ No newline at end of file diff --git a/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md b/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md new file mode 100644 index 0000000000..92a19f5f9e --- /dev/null +++ b/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md @@ -0,0 +1,3 @@ +You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." + +{% data variables.product.prodname_dotcom %} offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." \ No newline at end of file From dc33e61345ace1ebd28e48c9d3ee0572e2425471 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Wed, 21 Jul 2021 10:47:15 -0700 Subject: [PATCH 45/52] Update Survey.tsx (#20452) --- components/Survey.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/Survey.tsx b/components/Survey.tsx index 2e607c8206..d5423b5c4d 100644 --- a/components/Survey.tsx +++ b/components/Survey.tsx @@ -35,7 +35,7 @@ export const Survey = () => { } return ( -
+

{t`able_to_find`} From 82f5587ca7a1040b6bc59aec6e413f73abe9a1f8 Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 21 Jul 2021 13:51:39 -0400 Subject: [PATCH 46/52] revert change to variable --- data/reusables/support/ask-and-answer-forum.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/support/ask-and-answer-forum.md b/data/reusables/support/ask-and-answer-forum.md index 46abedaf41..e5ba6155e7 100644 --- a/data/reusables/support/ask-and-answer-forum.md +++ b/data/reusables/support/ask-and-answer-forum.md @@ -1 +1 @@ -You can connect with developers around the world in the [{% data variables.product.prodname_gcf %}](https://github.community) to ask and answer questions, learn, and interact directly with {% data variables.product.prodname_dotcom %} staff. +You can connect with developers around the world in the [{% data variables.product.prodname_gcf %}](https://github.community) to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. From 747c0bf6e6a432804da5f2fc52d75655b2995ade Mon Sep 17 00:00:00 2001 From: Sarita Iyer Date: Wed, 21 Jul 2021 14:03:36 -0400 Subject: [PATCH 47/52] small typo --- .../onboarding/getting-started-with-your-github-account.md | 2 +- data/reusables/support/ask-and-answer-forum.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 d977aa04bd..ba1947d96d 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 @@ -176,7 +176,7 @@ For more information, see "[Securing your software supply chain](/code-security/ ### 1. Contributing to open source projects {% data reusables.getting-started.open-source-projects %} -### 2. Interacting with the {% data variables.product.prodname_gcf %} +### 2. Interacting with {% data variables.product.prodname_gcf %} {% data reusables.support.ask-and-answer-forum %} ### 3. Learning with {% data variables.product.prodname_learning %} diff --git a/data/reusables/support/ask-and-answer-forum.md b/data/reusables/support/ask-and-answer-forum.md index e5ba6155e7..21e700f117 100644 --- a/data/reusables/support/ask-and-answer-forum.md +++ b/data/reusables/support/ask-and-answer-forum.md @@ -1 +1 @@ -You can connect with developers around the world in the [{% data variables.product.prodname_gcf %}](https://github.community) to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. +You can connect with developers around the world in [{% data variables.product.prodname_gcf %}](https://github.community) to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. From 57b0a959c198dcb084aa9a2d3be32c048d168489 Mon Sep 17 00:00:00 2001 From: Mike Surowiec Date: Wed, 21 Jul 2021 14:10:49 -0400 Subject: [PATCH 48/52] fix rendering of html entities (#20451) --- components/landing/CodeExampleCard.tsx | 2 +- components/sublanding/ArticleCard.tsx | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/components/landing/CodeExampleCard.tsx b/components/landing/CodeExampleCard.tsx index 1b07eb638d..369aeb1641 100644 --- a/components/landing/CodeExampleCard.tsx +++ b/components/landing/CodeExampleCard.tsx @@ -13,7 +13,7 @@ export const CodeExampleCard = ({ example }: Props) => { href={`https://github.com/${example.href}`} >
-

{example.title}

+

{example.description}

{example.tags.map((tag) => { diff --git a/components/sublanding/ArticleCard.tsx b/components/sublanding/ArticleCard.tsx index dbc6f3b830..a44d2b0d1f 100644 --- a/components/sublanding/ArticleCard.tsx +++ b/components/sublanding/ArticleCard.tsx @@ -9,7 +9,10 @@ export const ArticleCard = ({ card, typeLabel }: Props) => { return (
-

{card.title}

+

{typeLabel}
From a0eff64e4fd3e8165651a2938ab769856bf77e22 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Wed, 21 Jul 2021 14:13:44 -0500 Subject: [PATCH 49/52] Lint `*.yaml` workflows, too (#20445) * Lint .yaml workflows, too * Ignore workflow that uses non-GA-ed feature * Update to the latest actions-linter to fix the partial-expression problem (cschleiden/github-actions-parser#18) --- .github/allowed-actions.js | 2 +- .github/workflows/workflow-lint.yml | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index d4404be8a8..18ac42218f 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -14,7 +14,7 @@ export default [ 'andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84', 'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688', 'crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c', - 'cschleiden/actions-linter@5f9827c6b731d2c2480cd3bccf82079bbba832fc', + 'cschleiden/actions-linter@caffd707beda4fc6083926a3dff48444bc7c24aa', // uses github-actions-parser v0.23.0 'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911', 'docker://chinthakagodawita/autoupdate-action:v1', 'dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58', diff --git a/.github/workflows/workflow-lint.yml b/.github/workflows/workflow-lint.yml index 551180b03b..b641911759 100644 --- a/.github/workflows/workflow-lint.yml +++ b/.github/workflows/workflow-lint.yml @@ -11,9 +11,11 @@ on: - main paths: - '.github/workflows/*.yml' + - '.github/workflows/*.yaml' pull_request: paths: - '.github/workflows/*.yml' + - '.github/workflows/*.yaml' jobs: lint: @@ -24,6 +26,6 @@ jobs: uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - name: Run linter - uses: cschleiden/actions-linter@5f9827c6b731d2c2480cd3bccf82079bbba832fc + uses: cschleiden/actions-linter@caffd707beda4fc6083926a3dff48444bc7c24aa with: - workflows: '[".github/workflows/*.yml"]' + workflows: '[".github/workflows/*.yml", ".github/workflows/*.yaml", "!.github/workflows/remove-from-fr-board.yaml"]' From df38087aed32a2363c992405b13705279456085d Mon Sep 17 00:00:00 2001 From: Mike Surowiec Date: Wed, 21 Jul 2021 15:22:30 -0400 Subject: [PATCH 50/52] Update 404/500 pages to no longer use liquid templates (#20450) * Update 404/500 page rendering to no longer use liquid templates * updating tests * remove unused path Co-authored-by: Grace Park --- components/GenericError.tsx | 118 +++++++++++++++++++++++ middleware/handle-errors.js | 26 +----- middleware/render-page.js | 10 +- next-env.d.ts | 1 + pages/404.tsx | 182 +++++++----------------------------- pages/500.tsx | 158 +------------------------------ pages/_error.tsx | 10 ++ stylesheets/utilities.scss | 4 + tests/browser/browser.js | 4 +- tests/rendering/server.js | 10 +- 10 files changed, 181 insertions(+), 342 deletions(-) create mode 100644 components/GenericError.tsx create mode 100644 pages/_error.tsx diff --git a/components/GenericError.tsx b/components/GenericError.tsx new file mode 100644 index 0000000000..ac853e5b65 --- /dev/null +++ b/components/GenericError.tsx @@ -0,0 +1,118 @@ +import Head from 'next/head' +import Link from 'next/link' +import { useRouter } from 'next/router' + +import { MarkGithubIcon, CommentDiscussionIcon } from '@primer/octicons-react' +import { useVersion } from 'components/hooks/useVersion' + +export function GenericError() { + const { isEnterprise } = useVersion() + + return ( + + ) +} + +export const SimpleHeader = () => { + const router = useRouter() + return ( +
+
+ +
+
+ ) +} + +export const SimpleFooter = () => { + return ( + + ) +} diff --git a/middleware/handle-errors.js b/middleware/handle-errors.js index 8055bad24b..3b3647624f 100644 --- a/middleware/handle-errors.js +++ b/middleware/handle-errors.js @@ -1,9 +1,7 @@ -import fs from 'fs' -import path from 'path' -import { liquid } from '../lib/render-content/index.js' import FailBot from '../lib/failbot.js' import loadSiteData from '../lib/site-data.js' import builtAssets from '../lib/built-asset-urls.js' +import { nextApp } from './next.js' function shouldLogException(error) { const IGNORED_ERRORS = [ @@ -54,15 +52,7 @@ export default async function handleError(error, req, res, next) { // Special handling for when a middleware calls `next(404)` if (error === 404) { - // Again, we can remove this once the 404/500 pages are ready - return res - .status(404) - .send( - await liquid.parseAndRender( - fs.readFileSync(path.join(process.cwd(), './layouts/error-404.html'), 'utf8'), - req.context - ) - ) + return nextApp.render404(req, res) } // If the error contains a status code, just send that back. This is usually @@ -75,15 +65,9 @@ export default async function handleError(error, req, res, next) { console.error('500 error!', req.path) console.error(error) } - // Again, we can remove this once the 404/500 pages are ready - res - .status(500) - .send( - await liquid.parseAndRender( - fs.readFileSync(path.join(process.cwd(), './layouts/error-500.html'), 'utf8'), - req.context - ) - ) + + res.statusCode = 500 + nextApp.renderError(error, req, res, req.path) // Report to Failbot AFTER responding to the user await logException(error, req) diff --git a/middleware/render-page.js b/middleware/render-page.js index 7b7ed47af3..544b5069de 100644 --- a/middleware/render-page.js +++ b/middleware/render-page.js @@ -1,14 +1,11 @@ -import fs from 'fs' -import path from 'path' import { get } from 'lodash-es' -import { liquid } from '../lib/render-content/index.js' import patterns from '../lib/patterns.js' import getMiniTocItems from '../lib/get-mini-toc-items.js' import Page from '../lib/page.js' import statsd from '../lib/statsd.js' import RedisAccessor from '../lib/redis-accessor.js' import { isConnectionDropped } from './halt-on-dropped-connection.js' -import { nextHandleRequest } from './next.js' +import { nextApp, nextHandleRequest } from './next.js' const { HEROKU_RELEASE_VERSION } = process.env @@ -64,10 +61,7 @@ export default async function renderPage(req, res, next) { `\nTried to redirect to ${req.context.redirectNotFound}, but that page was not found.\n` ) } - return res - .status(404) - // We can get rid of reading the layout for 404 once we have the 404 page up and running - .send(modifyOutput(req, await liquid.parseAndRender(fs.readFileSync(path.join(process.cwd(), './layouts/error-404.html'), 'utf8'), req.context))) + return nextApp.render404(req, res) } if (req.method === 'HEAD') { diff --git a/next-env.d.ts b/next-env.d.ts index 7b7aa2c772..c6643fda12 100644 --- a/next-env.d.ts +++ b/next-env.d.ts @@ -1,2 +1,3 @@ /// /// +/// diff --git a/pages/404.tsx b/pages/404.tsx index 16a6b81c02..93dbe3f62a 100644 --- a/pages/404.tsx +++ b/pages/404.tsx @@ -1,158 +1,44 @@ -import { useRouter } from 'next/router' +import { SimpleHeader, SimpleFooter } from 'components/GenericError' import Head from 'next/head' -import Link from 'next/link' - -import { - MarkGithubIcon, - GitPullRequestIcon, - PeopleIcon, - CommentDiscussionIcon, -} from '@primer/octicons-react' +import { CommentDiscussionIcon } from '@primer/octicons-react' import { useVersion } from 'components/hooks/useVersion' -import { AllProductsLink } from 'components/product/AllProductsLink' - -export default function Custom404() { - const router = useRouter() - const { currentVersion, isEnterprise } = useVersion() - - const contribution_href = router.locale - ? `https://github.com/github/docs/edit/main/content/` - : 'https://github.com/github/docs' +const Custom404 = () => { + const { isEnterprise } = useVersion() return ( -
+
- Ooops! + 404 - Page not found -
- - + + + +
+
+

Ooops!

+

It looks like this page doesn't exist.

+

+ We track these errors automatically, but if the problem persists please feel free to + contact us. +

+ + + Contact support + +
-
-
-
-

Ooops

-
It looks like this page doesn't exist.
-
-

Need help?

-
-
-
-
-
-
-
-

Help us make these docs great!

-

- All GitHub docs are open source. See something that's wrong or unclear? Submit a - pull request. -

- - - Make a contribution - -

- Or,{' '} - - learn how to contribute. - -

-
-
- -
-
- -
+ +
) } + +export default Custom404 diff --git a/pages/500.tsx b/pages/500.tsx index 450c1c0640..0b75f32263 100644 --- a/pages/500.tsx +++ b/pages/500.tsx @@ -1,159 +1,5 @@ -import { useRouter } from 'next/router' -import Head from 'next/head' -import Link from 'next/link' - -import { - MarkGithubIcon, - GitPullRequestIcon, - PeopleIcon, - CommentDiscussionIcon, -} from '@primer/octicons-react' -import { useVersion } from 'components/hooks/useVersion' +import { GenericError } from 'components/GenericError' export default function Custom500() { - const router = useRouter() - const { isEnterprise } = useVersion() - const contribution_href = router.locale - ? `https://github.com/github/docs/edit/main/content/` - : 'https://github.com/github/docs' - - return ( -
- - GitHub Documentation - -
-
- - -
-
-
-
-
-
-
-
-
-
-
-

Ooops!

-
- It looks like something went wrong. We track these errors automatically, but if the - problem persists please feel free to contact us. -
-
-
- -
-
-
-
-

Help us make these docs great!

-

- All GitHub docs are open source. See something that's wrong or unclear? Submit a - pull request. -

- - - Make a contribution - -

- Or,{' '} - - learn how to contribute. - -

-
-
- -
-
- -
- ) + return } diff --git a/pages/_error.tsx b/pages/_error.tsx new file mode 100644 index 0000000000..2f6fd315f8 --- /dev/null +++ b/pages/_error.tsx @@ -0,0 +1,10 @@ +import { NextPage } from 'next' +import { GenericError } from 'components/GenericError' + +type Props = {} + +const ErrorPage: NextPage = () => { + return +} + +export default ErrorPage diff --git a/stylesheets/utilities.scss b/stylesheets/utilities.scss index ae042941c4..c50c9cc7c6 100644 --- a/stylesheets/utilities.scss +++ b/stylesheets/utilities.scss @@ -13,3 +13,7 @@ .rotate-180 { transform: rotateX(180deg); } + +.min-h-screen { + min-height: 100vh; +} diff --git a/tests/browser/browser.js b/tests/browser/browser.js index 98ec27e80a..cabac7eae5 100644 --- a/tests/browser/browser.js +++ b/tests/browser/browser.js @@ -46,8 +46,8 @@ describe('browser search', () => { expect(hits.length).toBeGreaterThan(5) await page.setViewport(initialViewport) }) - - it('works on 404 error page', async () => { + // 404 page is statically generated with next, so search is not available, but may possibly be brought back + it.skip('works on 404 error page', async () => { await page.goto('http://localhost:4001/en/404') await page.click('#search-input-container input[type="search"]') await page.type('#search-input-container input[type="search"]', 'actions') diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 904b047fb7..f2bd50c245 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -2,7 +2,6 @@ import lodash from 'lodash-es' import enterpriseServerReleases from '../../lib/enterprise-server-releases.js' import { get, getDOM, head, post } from '../helpers/supertest.js' import { describeViaActionsOnly } from '../helpers/conditional-runs.js' -import path from 'path' import { loadPages } from '../../lib/page-data.js' import builtAssets from '../../lib/built-asset-urls.js' import CspParse from 'csp-parse' @@ -178,7 +177,7 @@ describe('server', () => { const $ = await getDOM('/not-a-real-page') expect($('h1').text()).toBe('Ooops!') expect($.text().includes("It looks like this page doesn't exist.")).toBe(true) - expect($.text().includes('Still need help?')).toBe(true) + expect($.text().includes('We track these errors automatically, but if the problem persists please feel free to contact us.')).toBe(true) expect($.res.statusCode).toBe(404) }) @@ -201,11 +200,8 @@ describe('server', () => { test('renders a 500 page when errors are thrown', async () => { const $ = await getDOM('/_500') expect($('h1').text()).toBe('Ooops!') - expect($('code').text().startsWith('Error: Intentional error')).toBe(true) - expect($('code').text().includes(path.join('node_modules', 'express', 'lib', 'router'))).toBe( - true - ) - expect($.text().includes('Still need help?')).toBe(true) + expect($.text().includes("It looks like something went wrong.")).toBe(true) + expect($.text().includes("We track these errors automatically, but if the problem persists please feel free to contact us.")).toBe(true) expect($.res.statusCode).toBe(500) }) From df301cb5da646d75e249ff9eb2ee86dd6b36836d Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Wed, 21 Jul 2021 15:44:00 -0500 Subject: [PATCH 51/52] Remove all code related to Redis page caching (#20457) Towards simplification for https://github.com/github/docs-engineering/issues/678 --- Procfile | 2 - lib/redis-accessor.js | 138 -------------- middleware/render-page.js | 94 +-------- script/README.md | 7 - script/purge-redis-pages.js | 185 ------------------ script/release-heroku | 31 --- tests/unit/redis-accessor.js | 359 ----------------------------------- 7 files changed, 1 insertion(+), 815 deletions(-) delete mode 100644 lib/redis-accessor.js delete mode 100755 script/purge-redis-pages.js delete mode 100755 script/release-heroku delete mode 100644 tests/unit/redis-accessor.js diff --git a/Procfile b/Procfile index 7575c37989..4bec004287 100644 --- a/Procfile +++ b/Procfile @@ -1,3 +1 @@ web: NODE_ENV=production node server.mjs - -release: NODE_ENV=production script/release-heroku diff --git a/lib/redis-accessor.js b/lib/redis-accessor.js deleted file mode 100644 index 7b92e3442e..0000000000 --- a/lib/redis-accessor.js +++ /dev/null @@ -1,138 +0,0 @@ -import createRedisClient from './redis/create-client.js' -import InMemoryRedis from 'redis-mock' -import { promisify } from 'util' - -const { CI, NODE_ENV, REDIS_URL } = process.env - -// Do not use real a Redis client for CI, tests, or if the REDIS_URL is not provided -const useRealRedis = !CI && NODE_ENV !== 'test' && !!REDIS_URL - -class RedisAccessor { - constructor({ - databaseNumber = 0, - prefix = null, - allowSetFailures = false, - allowGetFailures = false, - name = null, - } = {}) { - const redisClient = useRealRedis - ? createRedisClient({ - url: REDIS_URL, - db: databaseNumber, - name: name || 'redis-accessor', - }) - : InMemoryRedis.createClient() - - this._client = redisClient - - this._prefix = prefix ? prefix.replace(/:+$/, '') + ':' : '' - - // Allow for graceful failures if a Redis SET operation fails? - this._allowSetFailures = allowSetFailures === true - - // Allow for graceful failures if a Redis GET operation fails? - this._allowGetFailures = allowGetFailures === true - } - - /** @private */ - prefix(key) { - if (typeof key !== 'string' || !key) { - throw new TypeError(`Key must be a non-empty string but was: ${JSON.stringify(key)}`) - } - - return this._prefix + key - } - - static translateSetArguments(options = {}) { - const setArgs = [] - - const defaults = { - newOnly: false, - existingOnly: false, - expireIn: null, // No expiration - rollingExpiration: true, - } - const opts = { ...defaults, ...options } - - if (opts.newOnly === true) { - if (opts.existingOnly === true) { - throw new TypeError('Misconfiguration: entry cannot be both new and existing') - } - setArgs.push('NX') - } else if (opts.existingOnly === true) { - setArgs.push('XX') - } - - if (Number.isFinite(opts.expireIn)) { - const ttl = Math.round(opts.expireIn) - if (ttl < 1) { - throw new TypeError('Misconfiguration: cannot set a TTL of less than 1 millisecond') - } - setArgs.push('PX') - setArgs.push(ttl) - } - // otherwise there is no expiration - - if (opts.rollingExpiration === false) { - if (opts.newOnly === true) { - throw new TypeError('Misconfiguration: cannot keep an existing TTL on a new entry') - } - setArgs.push('KEEPTTL') - } - - return setArgs - } - - async set(key, value, options = {}) { - const setAsync = promisify(this._client.set).bind(this._client) - const fullKey = this.prefix(key) - - if (typeof value !== 'string' || !value) { - throw new TypeError(`Value must be a non-empty string but was: ${JSON.stringify(value)}`) - } - - // Handle optional arguments - const setArgs = this.constructor.translateSetArguments(options) - - try { - const result = await setAsync(fullKey, value, ...setArgs) - return result === 'OK' - } catch (err) { - const errorText = `Failed to set value in Redis. -Key: ${fullKey} -Error: ${err.message}` - - if (this._allowSetFailures === true) { - // Allow for graceful failure - console.error(errorText) - return false - } - - throw new Error(errorText) - } - } - - async get(key) { - const getAsync = promisify(this._client.get).bind(this._client) - const fullKey = this.prefix(key) - - try { - const value = await getAsync(fullKey) - return value - } catch (err) { - const errorText = `Failed to get value from Redis. -Key: ${fullKey} -Error: ${err.message}` - - if (this._allowGetFailures === true) { - // Allow for graceful failure - console.error(errorText) - return null - } - - throw new Error(errorText) - } - } -} - -export default RedisAccessor diff --git a/middleware/render-page.js b/middleware/render-page.js index 544b5069de..cfdcb32bcd 100644 --- a/middleware/render-page.js +++ b/middleware/render-page.js @@ -2,56 +2,9 @@ import { get } from 'lodash-es' import patterns from '../lib/patterns.js' import getMiniTocItems from '../lib/get-mini-toc-items.js' import Page from '../lib/page.js' -import statsd from '../lib/statsd.js' -import RedisAccessor from '../lib/redis-accessor.js' import { isConnectionDropped } from './halt-on-dropped-connection.js' import { nextApp, nextHandleRequest } from './next.js' -const { HEROKU_RELEASE_VERSION } = process.env - -const pageCacheDatabaseNumber = 1 - -const pageCache = new RedisAccessor({ - databaseNumber: pageCacheDatabaseNumber, - prefix: (HEROKU_RELEASE_VERSION ? HEROKU_RELEASE_VERSION + ':' : '') + 'rp', - // Allow for graceful failures if a Redis SET operation fails - allowSetFailures: true, - // Allow for graceful failures if a Redis GET operation fails - allowGetFailures: true, - name: 'page-cache', -}) - -// a list of query params that *do* alter the rendered page, and therefore should be cached separately -const cacheableQueries = ['learn'] - -function modifyOutput(req, text) { - return addColorMode(req, addCsrf(req, text)) -} - -function addCsrf(req, text) { - return text.replace('$CSRFTOKEN$', req.csrfToken()) -} - -function addColorMode(req, text) { - let colorMode = 'auto' - let darkTheme = 'dark' - let lightTheme = 'light' - - try { - const cookieValue = JSON.parse(decodeURIComponent(req.cookies.color_mode)) - colorMode = encodeURIComponent(cookieValue.color_mode) || colorMode - darkTheme = encodeURIComponent(cookieValue.dark_theme.name) || darkTheme - lightTheme = encodeURIComponent(cookieValue.light_theme.name) || lightTheme - } catch (e) { - // do nothing - } - - return text - .replace('$COLORMODE$', colorMode) - .replace('$DARKTHEME$', darkTheme) - .replace('$LIGHTTHEME$', lightTheme) -} - export default async function renderPage(req, res, next) { const page = req.context.page // render a 404 page @@ -64,59 +17,14 @@ export default async function renderPage(req, res, next) { return nextApp.render404(req, res) } + // Just finish fast without all the details like Content-Length if (req.method === 'HEAD') { return res.status(200).end() } - // Remove any query string (?...) and/or fragment identifier (#...) - const { pathname, searchParams } = new URL(req.originalUrl, 'https://docs.github.com') - - for (const queryKey in req.query) { - if (!cacheableQueries.includes(queryKey)) { - searchParams.delete(queryKey) - } - } - const originalUrl = pathname + ([...searchParams].length > 0 ? `?${searchParams}` : '') - // Is the request for JSON debugging info? const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production' - // Is in an airgapped session? - const isAirgapped = Boolean(req.cookies.AIRGAP) - - // Is the request for the GraphQL Explorer page? - const isGraphQLExplorer = req.context.currentPathWithoutLanguage === '/graphql/overview/explorer' - - // Serve from the cache if possible - const isCacheable = - // Skip for CI - !process.env.CI && - // Skip for tests - process.env.NODE_ENV !== 'test' && - // Skip for HTTP methods other than GET - req.method === 'GET' && - // Skip for JSON debugging info requests - !isRequestingJsonForDebugging && - // Skip for airgapped sessions - !isAirgapped && - // Skip for the GraphQL Explorer page - !isGraphQLExplorer - - if (isCacheable) { - // Stop processing if the connection was already dropped - if (isConnectionDropped(req, res)) return - - const cachedHtml = await pageCache.get(originalUrl) - if (cachedHtml) { - // Stop processing if the connection was already dropped - if (isConnectionDropped(req, res)) return - - console.log(`Serving from cached version of ${originalUrl}`) - statsd.increment('page.sent_from_cache') - return res.send(modifyOutput(req, cachedHtml)) - } - } - // add page context const context = Object.assign({}, req.context, { page }) diff --git a/script/README.md b/script/README.md index b57a0b720d..8f25a04aef 100644 --- a/script/README.md +++ b/script/README.md @@ -338,13 +338,6 @@ Run this script to manually purge the Fastly cache for all language variants of --- -### [`purge-redis-pages.js`](purge-redis-pages.js) - -Run this script to manually purge the Redis rendered page cache. This will typically only be run by Heroku during the deployment process, as triggered via our Procfile's "release" phase configuration. - ---- - - ### [`reconcile-category-dirs-with-ids.js`](reconcile-category-dirs-with-ids.js) An automated test checks for discrepancies between category directory names and slugified category titles as IDs. diff --git a/script/purge-redis-pages.js b/script/purge-redis-pages.js deleted file mode 100755 index 2c185d0f42..0000000000 --- a/script/purge-redis-pages.js +++ /dev/null @@ -1,185 +0,0 @@ -#!/usr/bin/env node -import xDotenv from 'dotenv' -import { promisify } from 'util' -import createRedisClient from '../lib/redis/create-client.js' - -// [start-readme] -// -// Run this script to manually "soft purge" the Redis rendered page cache -// by shortening the expiration window of entries. -// This will typically only be run by Heroku during the deployment process, -// as triggered via our Procfile's "release" phase configuration. -// -// [end-readme] - -xDotenv.config() - -const { REDIS_URL, HEROKU_RELEASE_VERSION, HEROKU_PRODUCTION_APP } = process.env -const isHerokuProd = HEROKU_PRODUCTION_APP === 'true' -const pageCacheDatabaseNumber = 1 -const keyScanningPattern = HEROKU_RELEASE_VERSION ? '*:rp:*' : 'rp:*' -const scanSetSize = 250 - -const startTime = Date.now() -const expirationDuration = 30 * 60 * 1000 // 30 minutes -const expirationTimestamp = startTime + expirationDuration // 30 minutes from now - -// print keys to be purged without actually purging -const dryRun = ['-d', '--dry-run'].includes(process.argv[2]) - -// verify environment variables -if (!REDIS_URL) { - if (isHerokuProd) { - console.error('Error: you must specify the REDIS_URL environment variable.\n') - process.exit(1) - } else { - console.warn('Warning: you did not specify a REDIS_URL environment variable. Exiting...\n') - process.exit(0) - } -} - -console.log({ - HEROKU_RELEASE_VERSION, - HEROKU_PRODUCTION_APP, -}) - -purgeRenderedPageCache() - -function purgeRenderedPageCache() { - const redisClient = createRedisClient({ - url: REDIS_URL, - db: pageCacheDatabaseNumber, - // These commands ARE important, so let's make sure they are all accounted for - enable_offline_queue: true, - }) - - let iteration = 0 - let potentialKeyCount = 0 - let totalKeyCount = 0 - - // Promise wrappers - const scanAsync = promisify(redisClient.scan).bind(redisClient) - const quitAsync = promisify(redisClient.quit).bind(redisClient) - - // Run it! - return scan() - - // - // Define other subroutines - // - - async function scan(cursor = '0') { - try { - // [0]: Update the cursor position for the next scan - // [1]: Get the SCAN result for this iteration - const [nextCursor, keys] = await scanAsync( - cursor, - 'MATCH', - keyScanningPattern, - 'COUNT', - scanSetSize.toString() - ) - - console.log(`\n[Iteration ${iteration++}] Received ${keys.length} keys...`) - - if (dryRun) { - console.log( - `DRY RUN! This iteration might have set TTL for up to ${ - keys.length - } keys:\n - ${keys.join('\n - ')}` - ) - } - - // NOTE: It is possible for a SCAN cursor iteration to return 0 keys when - // using a MATCH because it is applied after the elements are retrieved - // - // Remember: more or less than COUNT or no keys may be returned - // See http://redis.io/commands/scan#the-count-option - // Also, SCAN may return the same key multiple times - // See http://redis.io/commands/scan#scan-guarantees - // Additionally, you should always have the code that uses the keys - // before the code checking the cursor. - if (keys.length > 0) { - if (dryRun) { - potentialKeyCount += keys.length - } else { - totalKeyCount += await updateTtls(keys) - } - } - - // From : - // 'An iteration starts when the cursor is set to 0, - // and terminates when the cursor returned by the server is 0.' - if (nextCursor === '0') { - const dryRunTrailer = dryRun ? ` (potentially up to ${potentialKeyCount})` : '' - console.log(`\nDone purging keys; affected total: ${totalKeyCount}${dryRunTrailer}`) - console.log(`Time elapsed: ${Date.now() - startTime} ms`) - - // Close the connection - await quitAsync() - return - } - - // Tail recursion - return scan(nextCursor) - } catch (error) { - console.error('An unexpected error occurred!\n' + error.stack) - console.error('\nAborting...') - process.exit(1) - } - } - - // Find existing TTLs to ensure we aren't extending the TTL if it's already set - async function getTtls(keys) { - const pttlPipeline = redisClient.batch() - keys.forEach((key) => pttlPipeline.pttl(key)) - - const pttlPipelineExecAsync = promisify(pttlPipeline.exec).bind(pttlPipeline) - const pttlResults = await pttlPipelineExecAsync() - - if (pttlResults == null || pttlResults.length === 0) { - throw new Error('PTTL results were empty') - } - - return pttlResults - } - - async function updateTtls(keys) { - const pttlResults = await getTtls(keys) - - // Find pertinent keys to have TTLs set - let updatingKeyCount = 0 - const pexpireAtPipeline = redisClient.batch() - - keys.forEach((key, i) => { - // Only operate on -1 values or those later than our desired expiration timestamp - const pttl = pttlResults[i] - // A TTL of -1 means the entry was not configured with any TTL (expiration) - // currently and will remain as a permanent entry unless a TTL is added - const needsShortenedTtl = pttl === -1 || pttl > expirationDuration - const isOldKey = !HEROKU_RELEASE_VERSION || !key.startsWith(`${HEROKU_RELEASE_VERSION}:`) - - if (needsShortenedTtl && isOldKey) { - pexpireAtPipeline.pexpireat(key, expirationTimestamp) - updatingKeyCount += 1 - } - }) - - console.log(`Purging ${updatingKeyCount} keys...`) - - // Only update TTLs if there are records worth updating - if (updatingKeyCount === 0) return - - // Set all the TTLs - const pexpireAtPipelineExecAsync = promisify(pexpireAtPipeline.exec).bind(pexpireAtPipeline) - const pexpireAtResults = await pexpireAtPipelineExecAsync() - - if (pttlResults == null || pttlResults.length === 0) { - throw new Error('PEXPIREAT results were empty') - } - - // Count only the entries whose TTLs were successfully updated - const updatedResults = pexpireAtResults.filter((result) => result === 1) - return updatedResults.length - } -} diff --git a/script/release-heroku b/script/release-heroku deleted file mode 100755 index f070e70744..0000000000 --- a/script/release-heroku +++ /dev/null @@ -1,31 +0,0 @@ -#!/usr/bin/env bash - -# [start-readme] -# -# Light Bash wrapper for the Heroku release command, which sometimes fails -# unexpectedly in staging environments when a Node installation is missing -# -# [end-readme] - -# Check for node but don't fail immediately if it's not present -./script/check-for-node -EXIT_STATUS=$? - -# If node is missing... -if [[ "$EXIT_STATUS" -ne "0" ]]; then - # Fail hard if this is our Heroku production app or if Redis is configured - if [[ "$HEROKU_PRODUCTION_APP" == "true" || -n "$REDIS_URL" ]]; then - echo "Error: cannot execute the release script without Node.js, which is fatal." - echo "Exiting..." - exit $EXIT_STATUS - # Otherwise succeed with only a warning - else - echo "Warning: although Node.js is missing, it is non-critical." - echo "Exiting..." - exit 0 - fi -else - # Execute the release script and exit with its status - node script/purge-redis-pages.js - exit $? -fi diff --git a/tests/unit/redis-accessor.js b/tests/unit/redis-accessor.js deleted file mode 100644 index 58296f1889..0000000000 --- a/tests/unit/redis-accessor.js +++ /dev/null @@ -1,359 +0,0 @@ -import { jest } from '@jest/globals' -import redisMock from 'redis-mock' -import RedisAccessor from '../../lib/redis-accessor.js' - -const { RedisClient: InMemoryRedis } = redisMock - -describe('RedisAccessor', () => { - test('is a constructor', async () => { - expect(typeof RedisAccessor).toBe('function') - - const instance = new RedisAccessor() - expect(instance).toBeInstanceOf(RedisAccessor) - }) - - test('has expected instance properties', async () => { - const instance = new RedisAccessor() - expect(Object.keys(instance).sort()).toEqual([ - '_allowGetFailures', - '_allowSetFailures', - '_client', - '_prefix', - ]) - }) - - test('has expected static methods', async () => { - expect(typeof RedisAccessor.translateSetArguments).toBe('function') - }) - - describe('#_allowGetFailures property', () => { - test('defaults to false', async () => { - const instance = new RedisAccessor() - expect(instance._allowGetFailures).toBe(false) - }) - - test('is expected value', async () => { - const instance = new RedisAccessor({ allowGetFailures: true }) - expect(instance._allowGetFailures).toBe(true) - }) - }) - - describe('#_allowSetFailures property', () => { - test('defaults to false', async () => { - const instance = new RedisAccessor() - expect(instance._allowSetFailures).toBe(false) - }) - - test('is expected value', async () => { - const instance = new RedisAccessor({ allowSetFailures: true }) - expect(instance._allowSetFailures).toBe(true) - }) - }) - - describe('#_client property', () => { - test('is expected Redis client', async () => { - const instance = new RedisAccessor() - expect(instance._client).toBeInstanceOf(InMemoryRedis) - }) - }) - - describe('#_prefix property', () => { - test('defaults to empty string', async () => { - const instance = new RedisAccessor() - expect(instance._prefix).toBe('') - }) - - test('is expected value', async () => { - const instance = new RedisAccessor({ prefix: 'myPrefix' }) - expect(instance._prefix).toBe('myPrefix:') - }) - - test('removes a trailing colon', async () => { - const instance = new RedisAccessor({ prefix: 'myPrefix:' }) - expect(instance._prefix).toBe('myPrefix:') - }) - - test('removes multiple trailing colons', async () => { - const instance = new RedisAccessor({ prefix: 'myPrefix::' }) - expect(instance._prefix).toBe('myPrefix:') - }) - }) - - describe('#prefix method', () => { - test('returns prefixed key', async () => { - const prefix = 'myPrefix' - const instance = new RedisAccessor({ prefix }) - expect(instance.prefix('myKey')).toBe('myPrefix:myKey') - }) - - test('returns original key if no prefix is configured', async () => { - const instance = new RedisAccessor() - expect(instance.prefix('myKey')).toBe('myKey') - }) - - test('throws if no key is provided', async () => { - const instance = new RedisAccessor() - expect(() => instance.prefix()).toThrow( - new TypeError('Key must be a non-empty string but was: undefined') - ) - }) - }) - - describe('.translateSetArguments method', () => { - test('defaults to an empty list of arguments if no options are given', async () => { - expect(RedisAccessor.translateSetArguments()).toEqual([]) - }) - - test('adds argument "NX" if option `newOnly` is set to true', async () => { - expect(RedisAccessor.translateSetArguments({ newOnly: true })).toEqual(['NX']) - }) - - test('adds argument "XX" if option `existingOnly` is set to true', async () => { - expect(RedisAccessor.translateSetArguments({ existingOnly: true })).toEqual(['XX']) - }) - - test('adds argument "PX n" if option `expireIn` is provided with a positive finite integer', async () => { - expect(RedisAccessor.translateSetArguments({ expireIn: 20 })).toEqual(['PX', 20]) - }) - - test('adds argument "PX n" with rounded integer if option `expireIn` is provided with a positive finite non-integer', async () => { - expect(RedisAccessor.translateSetArguments({ expireIn: 20.5 })).toEqual(['PX', 21]) - expect(RedisAccessor.translateSetArguments({ expireIn: 29.1 })).toEqual(['PX', 29]) - }) - - test('adds argument "KEEPTTL" if option `rollingExpiration` is set to false', async () => { - expect(RedisAccessor.translateSetArguments({ rollingExpiration: false })).toEqual(['KEEPTTL']) - }) - - test('adds expected arguments if multiple options are configured', async () => { - expect( - RedisAccessor.translateSetArguments({ - newOnly: true, - expireIn: 20, - }) - ).toEqual(['NX', 'PX', 20]) - - expect( - RedisAccessor.translateSetArguments({ - existingOnly: true, - expireIn: 20, - }) - ).toEqual(['XX', 'PX', 20]) - - expect( - RedisAccessor.translateSetArguments({ - existingOnly: true, - expireIn: 20, - rollingExpiration: false, - }) - ).toEqual(['XX', 'PX', 20, 'KEEPTTL']) - - expect( - RedisAccessor.translateSetArguments({ - existingOnly: true, - rollingExpiration: false, - }) - ).toEqual(['XX', 'KEEPTTL']) - }) - - test('throws a misconfiguration error if options `newOnly` and `existingOnly` are both set to true', async () => { - expect(() => - RedisAccessor.translateSetArguments({ newOnly: true, existingOnly: true }) - ).toThrowError(new TypeError('Misconfiguration: entry cannot be both new and existing')) - }) - - test('throws a misconfiguration error if option `expireIn` is set to a finite number that rounds to less than 1', async () => { - const misconfigurationError = new TypeError( - 'Misconfiguration: cannot set a TTL of less than 1 millisecond' - ) - - expect(() => RedisAccessor.translateSetArguments({ expireIn: 0 })).toThrowError( - misconfigurationError - ) - - expect(() => RedisAccessor.translateSetArguments({ expireIn: -1 })).toThrowError( - misconfigurationError - ) - - expect(() => RedisAccessor.translateSetArguments({ expireIn: 0.4 })).toThrowError( - misconfigurationError - ) - }) - - test('throws a misconfiguration error if option `rollingExpiration` is set to false but `newOnly` is set to true', async () => { - expect(() => - RedisAccessor.translateSetArguments({ newOnly: true, rollingExpiration: false }) - ).toThrowError(new TypeError('Misconfiguration: cannot keep an existing TTL on a new entry')) - }) - }) - - describe('#set method', () => { - test('resolves to true if value was successfully set', async () => { - const instance = new RedisAccessor() - expect(await instance.set('myKey', 'myValue')).toBe(true) - }) - - test('resolves to false if value was not set', async () => { - const instance = new RedisAccessor() - instance._client.set = jest.fn((...args) => args.pop()(null, 'NOT_OK')) - - expect(await instance.set('myKey', 'myValue')).toBe(false) - }) - - test('sends expected key/value to Redis with #_client.set', async () => { - const instance = new RedisAccessor() - const setSpy = jest.spyOn(instance._client, 'set') - - await instance.set('myKey', 'myValue') - expect(setSpy.mock.calls.length).toBe(1) - expect(setSpy.mock.calls[0].slice(0, 2)).toEqual(['myKey', 'myValue']) - }) - - test('resolves to false if Redis replies with an error and `allowSetFailures` option is set to true', async () => { - // Temporarily override `console.error` - const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation() - - const instance = new RedisAccessor({ prefix: 'myPrefix', allowSetFailures: true }) - instance._client.set = jest.fn((...args) => args.pop()(new Error('Redis ReplyError'))) - - const result = await instance.set('myKey', 'myValue') - - expect(result).toBe(false) - expect(consoleErrorSpy).toBeCalledWith( - `Failed to set value in Redis. -Key: myPrefix:myKey -Error: Redis ReplyError` - ) - - // Restore `console.error` - consoleErrorSpy.mockRestore() - }) - - test('rejects if Redis replies with an error and `allowSetFailures` option is not set to true', async () => { - // Temporarily override `console.error` - const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation() - - const instance = new RedisAccessor({ prefix: 'myPrefix' }) - instance._client.set = jest.fn((...args) => args.pop()(new Error('Redis ReplyError'))) - - await expect(instance.set('myKey', 'myValue')).rejects.toThrowError( - new Error(`Failed to set value in Redis. -Key: myPrefix:myKey -Error: Redis ReplyError`) - ) - - expect(consoleErrorSpy).not.toBeCalled() - - // Restore `console.error` - consoleErrorSpy.mockRestore() - }) - - test('rejects if value is an empty string', async () => { - const instance = new RedisAccessor() - - await expect(instance.set('myKey', '')).rejects.toThrow( - new TypeError('Value must be a non-empty string but was: ""') - ) - }) - - test('rejects if value is a non-string value', async () => { - const instance = new RedisAccessor() - - await expect(instance.set('myKey', true)).rejects.toThrow( - new TypeError('Value must be a non-empty string but was: true') - ) - }) - - test('invokes .translateSetArguments before sending values to Redis', async () => { - const argSpy = jest.spyOn(RedisAccessor, 'translateSetArguments') - const instance = new RedisAccessor() - const setSpy = jest.spyOn(instance._client, 'set') - - await instance.set('myKey', 'myValue', { expireIn: 20 }) - expect(argSpy).toBeCalled() - expect(setSpy.mock.calls.length).toBe(1) - expect(setSpy.mock.calls[0].slice(0, 4)).toEqual(['myKey', 'myValue', 'PX', 20]) - - argSpy.mockRestore() - }) - }) - - describe('#get method', () => { - test('resolves to expected value if matching entry exists in Redis', async () => { - const instance = new RedisAccessor() - - await instance.set('myKey', 'myValue') - - const result = await instance.get('myKey') - expect(result).toBe('myValue') - }) - - test('resolves to null if no matching entry exists in Redis', async () => { - const instance = new RedisAccessor() - - const result = await instance.get('fakeKey') - expect(result).toBe(null) - }) - - test('retrieves matching entry from Redis with #_client.get', async () => { - const instance = new RedisAccessor() - let callbackSpy - const originalGet = instance._client.get.bind(instance._client) - instance._client.get = jest.fn((...args) => { - const realCallback = args.pop() - callbackSpy = jest.fn((error, value) => { - realCallback(error, value) - }) - - return originalGet(...args, callbackSpy) - }) - - await instance.set('myKey', 'myValue') - await instance.get('myKey') - - expect(instance._client.get.mock.calls.length).toBe(1) - expect(instance._client.get.mock.calls[0].slice(0, 1)).toEqual(['myKey']) - - expect(callbackSpy).toHaveBeenCalledWith(null, 'myValue') - }) - - test('resolves to null if Redis replies with an error and `allowGetFailures` option is set to true', async () => { - // Temporarily override `console.error` - const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation() - - const instance = new RedisAccessor({ prefix: 'myPrefix', allowGetFailures: true }) - instance._client.get = jest.fn((...args) => args.pop()(new Error('Redis ReplyError'))) - - const result = await instance.get('myKey', 'myValue') - - expect(result).toBe(null) - expect(consoleErrorSpy).toBeCalledWith( - `Failed to get value from Redis. -Key: myPrefix:myKey -Error: Redis ReplyError` - ) - - // Restore `console.error` - consoleErrorSpy.mockRestore() - }) - - test('rejects if Redis replies with an error and `allowGetFailures` option is not set to true', async () => { - // Temporarily override `console.error` - const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation() - - const instance = new RedisAccessor({ prefix: 'myPrefix' }) - instance._client.get = jest.fn((...args) => args.pop()(new Error('Redis ReplyError'))) - - await expect(instance.get('myKey')).rejects.toThrowError( - new Error(`Failed to get value from Redis. -Key: myPrefix:myKey -Error: Redis ReplyError`) - ) - - expect(consoleErrorSpy).not.toBeCalled() - - // Restore `console.error` - consoleErrorSpy.mockRestore() - }) - }) -}) From d9b75d1e58a78205f0a2adfe65165d98f131e3dc Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Wed, 21 Jul 2021 14:22:38 -0700 Subject: [PATCH 52/52] Deprecate 2.21 script updates (#20454) --- .../deprecation-issue.md | 22 ++++------- .../remove-redirects.js | 38 +++++++++++++++++++ script/helpers/get-liquid-conditionals.js | 8 +++- 3 files changed, 52 insertions(+), 16 deletions(-) create mode 100755 script/enterprise-server-deprecations/remove-redirects.js diff --git a/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md b/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md index 85dde8a437..3b23005828 100644 --- a/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md +++ b/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md @@ -37,21 +37,15 @@ In your `docs-internal` checkout: - [ ] Create a new branch: `git checkout -b deprecate-`. - [ ] Edit `lib/enterprise-server-releases.js` by moving the number to be deprecated into the `deprecated` array. - [ ] Run `script/enterprise-server-deprecations/remove-static-files.js` and commit results. -- [ ] Manually remove entries for the deprecated version from `lib/redirects/static/developer-docs-routes-for-supported-versions.json`. - - **Note**: These entries only go up to 2.21. We can remove this step once 2.21 is deprecated. +- [ ] Run `script/enterprise-server-deprecations/remove-redirects.js` and commit results. - [ ] Open a new PR. Make sure to check the following: - [ ] Tests are passing. - [ ] The deprecated version renders on staging as expected. - [ ] The new oldest supported version renders on staging as expected. Also check the banner text. -- [ ] When the PR is approved, merge it in to complete the deprecation. - -## Step 5: Remove outdated Liquid markup and frontmatter - -The following steps are somewhat optional and can be completed at any time. They do not have user impact; they just clear out old Liquid statements for the deprecated version, which makes things easier for content writers. - -In your `docs-internal` checkout: -- [ ] Create a new branch: `git checkout -b remove--markup` -- [ ] Run the script: `script/remove-deprecated-enterprise-version-markup.js --release `. -- [ ] Spot check a few changes. Content, frontmatter, and data files should all have been updated. -- [ ] Open a PR with the results. The diff may be large and complex, so make sure to get a review from `@github/docs-content`. -- [ ] Debug any test failures or unexpected results. +- [ ] Remove the outdated Liquid markup and frontmatter. It's recommended to create a topic branch off of your `deprecate-` branch to isolate the changes for review. + - [ ] In your `docs-internal` checkout, from your `deprecate-` branch: `git checkout -b remove--markup` + - [ ] Run the script: `script/enterprise-server-deprecations/remove-version-markup.js --release `. + - [ ] Spot check a few changes. Content, frontmatter, and data files should all have been updated. + - [ ] Open a PR with the results. The diff may be large and complex, so make sure to get a review from `@github/docs-content`. + - [ ] Debug any test failures or unexpected results. +- [ ] When the PR is approved, merge it in to complete the deprecation. \ No newline at end of file diff --git a/script/enterprise-server-deprecations/remove-redirects.js b/script/enterprise-server-deprecations/remove-redirects.js new file mode 100755 index 0000000000..dc08d03f6f --- /dev/null +++ b/script/enterprise-server-deprecations/remove-redirects.js @@ -0,0 +1,38 @@ +#!/usr/bin/env node + +import fs from 'fs' +import path from 'path' +import program from 'commander' +import readJsonFile from '../../lib/read-json-file.js' +import { deprecated } from '../../lib/enterprise-server-releases.js' +const DEVELOPER_REDIRECTS_FILEPATH = 'lib/redirects/static/developer.json' +const developerRedirects = readJsonFile(`./${DEVELOPER_REDIRECTS_FILEPATH}`) + +// [start-readme] +// +// Run this script after an Enterprise deprecation to remove redirects +// for the deprecated version. See the Enterprise deprecation issue template for instructions. +// +// [end-readme] + +program + .description( + 'Remove developer redirects for deprecated versions. The redirects for deprecated versions live in the respective directory in the github/help-docs-archived-enterprise-versions repository.' + ) + .option('-r, --release ', 'Enterprise Server release number. Example: 2.19. Default: latest deprecated release number.') + .parse(process.argv) + +// Default to latest deprecated release +const release = program.opts().release || deprecated[0] + +const supportedRedirects = {} + +Object.keys(developerRedirects).forEach(elem => { + const includesVersion = elem.includes(`enterprise/${release}`) + || elem.includes(`enterprise-server@${release}`) + if ( includesVersion ) return + + supportedRedirects[elem] = developerRedirects[elem] +}) + +fs.writeFileSync(path.join(process.cwd(), DEVELOPER_REDIRECTS_FILEPATH), JSON.stringify(supportedRedirects, null, 2)) diff --git a/script/helpers/get-liquid-conditionals.js b/script/helpers/get-liquid-conditionals.js index ab27f650a7..bf93670949 100644 --- a/script/helpers/get-liquid-conditionals.js +++ b/script/helpers/get-liquid-conditionals.js @@ -71,7 +71,6 @@ function groupTokens (tokens, tagName, endTagName, newArray = []) { const startIndex = tokens.findIndex(token => token.conditional === tagName) // The end tag name is currently in a separate token, but we want to group it with the start tag and content. const endIndex = tokens.findIndex(token => token.conditional === endTagName) - // Once all tags are grouped and removed from `tokens`, this findIndex will not find anything, // so we can return the grouped result at this point. if (startIndex === -1) return newArray @@ -123,7 +122,12 @@ function handleNestedTags (condBlockArr, endIndex, tagName, endTagName, tokens) } function hasUnhandledNestedTags (condBlockArr, tagName, endTagName) { - const startTags = condBlockArr.filter(t => t.conditional === tagName) + const startTags = condBlockArr.filter(t => { + // some blocks that start with ifversion still have if tags nested inside + return tagName === 'ifversion' + ? t.conditional === tagName || t.conditional === 'if' + : t.conditional === tagName + }) const endTags = condBlockArr.filter(t => t.conditional === endTagName) const hasMoreStartTagsThanEndTags = startTags.length > endTags.length