diff --git a/content/copilot/about-github-copilot.md b/content/copilot/about-github-copilot.md index d88c1f989b53..74b0abdc959b 100644 --- a/content/copilot/about-github-copilot.md +++ b/content/copilot/about-github-copilot.md @@ -17,22 +17,22 @@ Using the chat feature, you can ask {% data variables.product.prodname_copilot_s ## Assistance where you need it {% data variables.product.prodname_copilot %} is available: -- In your IDE -- In {% data variables.product.prodname_mobile %}, as a chat interface -- On the command line, through the {% data variables.product.prodname_cli %} -- On {% data variables.product.prodname_dotcom_the_website %}, with a subscription to {% data variables.product.prodname_copilot_enterprise_short %} +* In your IDE +* In {% data variables.product.prodname_mobile %}, as a chat interface +* On the command line, through the {% data variables.product.prodname_cli %} +* On {% data variables.product.prodname_dotcom_the_website %}, with a subscription to {% data variables.product.prodname_copilot_enterprise_short %} ## {% data variables.product.prodname_copilot %} features {% data variables.product.prodname_copilot_short %} includes a suite of features, such as: -- **Code completion** - {% data variables.product.prodname_copilot_short %} suggests code as you type. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)." +* **Code completion** - {% data variables.product.prodname_copilot_short %} suggests code as you type. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)." -- **Chat** - Ask {% data variables.product.prodname_copilot_short %} for help with your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide){% ifversion ghec %}" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom){% endif %}." +* **Chat** - Ask {% data variables.product.prodname_copilot_short %} for help with your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide){% ifversion ghec %}" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom){% endif %}." -- **Pull request summaries** _({% data variables.product.prodname_copilot_enterprise_short %} only)_ - Get {% data variables.product.prodname_copilot_short %} to describe the changes in a pull request. For more information, see {% ifversion ghec %}"[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)."{% else %}"[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries)."{% endif %} +* **Pull request summaries** _({% data variables.product.prodname_copilot_enterprise_short %} only)_ - Get {% data variables.product.prodname_copilot_short %} to describe the changes in a pull request. For more information, see {% ifversion ghec %}"[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)."{% else %}"[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries)."{% endif %} -- **Knowledge bases** _({% data variables.product.prodname_copilot_enterprise_short %} only)_ - Create and manage collections of documentation to use as a context for chatting with {% data variables.product.prodname_copilot_short %}. For more information, see {% ifversion ghec %}"[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/managing-copilot-knowledge-bases)."{% else %}"[AUTOTITLE](/copilot/github-copilot-enterprise/managing-copilot-knowledge-bases)."{% endif %} +* **Knowledge bases** _({% data variables.product.prodname_copilot_enterprise_short %} only)_ - Create and manage collections of documentation to use as a context for chatting with {% data variables.product.prodname_copilot_short %}. For more information, see {% ifversion ghec %}"[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/managing-copilot-knowledge-bases)."{% else %}"[AUTOTITLE](/copilot/github-copilot-enterprise/managing-copilot-knowledge-bases)."{% endif %} For a full list of the features and functionality available on each {% data variables.product.prodname_copilot %} plan, see "[AUTOTITLE](/copilot/copilot-individual/github-copilot-individual-feature-set)", "[AUTOTITLE](/copilot/copilot-business/github-copilot-business-feature-set)", or "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/github-copilot-enterprise-feature-set)." @@ -40,18 +40,18 @@ For a full list of the features and functionality available on each {% data vari You can access {% data variables.product.prodname_copilot %} as part of one of the following paid plans: -- **{% data variables.product.prodname_copilot_individuals_short %}** - Get access to {% data variables.product.prodname_copilot %} in an IDE, or on the command line, for your personal or independent use. You can try {% data variables.product.prodname_copilot %} for free with a one-time 30-day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)." +* **{% data variables.product.prodname_copilot_individuals_short %}** - Get access to {% data variables.product.prodname_copilot %} in an IDE, or on the command line, for your personal or independent use. You can try {% data variables.product.prodname_copilot %} for free with a one-time 30-day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)." If you're a verified student, teacher, or maintainer of a popular open source project, {% data variables.product.prodname_copilot %} is free to use. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." -- **{% data variables.product.prodname_copilot_business_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an organization. Owners of the organization can manage access for individual members or for teams. For more information, see "[AUTOTITLE](/copilot/copilot-business/about-github-copilot-business)." -- **{% data variables.product.prodname_copilot_enterprise_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an enterprise. Enterprise owners can allow some or all organizations in the enterprise to access {% data variables.product.prodname_copilot %}. If an organization has access to {% data variables.product.prodname_copilot_short %}, owners of the organization can grant access to {% data variables.product.prodname_copilot_enterprise_short %} for some or all members of the organization. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)." +* **{% data variables.product.prodname_copilot_business_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an organization. Owners of the organization can manage access for individual members or for teams. For more information, see "[AUTOTITLE](/copilot/copilot-business/about-github-copilot-business)." +* **{% data variables.product.prodname_copilot_enterprise_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an enterprise. Enterprise owners can allow some or all organizations in the enterprise to access {% data variables.product.prodname_copilot %}. If an organization has access to {% data variables.product.prodname_copilot_short %}, owners of the organization can grant access to {% data variables.product.prodname_copilot_enterprise_short %} for some or all members of the organization. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)." With {% data variables.product.prodname_copilot_enterprise_short %}, in addition to accessing {% data variables.product.prodname_copilot_short %} in an IDE or on the command line, you can use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}. This includes the ability to: - - Chat with {% data variables.product.prodname_copilot_short %} to get help with your code, or to ask general tech-related questions. - - Create tailored knowledge bases to use as the context for chat. - - Generate automatic summaries of pull requests. + * Chat with {% data variables.product.prodname_copilot_short %} to get help with your code, or to ask general tech-related questions. + * Create tailored knowledge bases to use as the context for chat. + * Generate automatic summaries of pull requests. > [!NOTE] > {% data reusables.copilot.copilot-one-account-short %} diff --git a/content/copilot/copilot-business/about-github-copilot-business.md b/content/copilot/copilot-business/about-github-copilot-business.md index c14bbf57f494..03e477c8541f 100644 --- a/content/copilot/copilot-business/about-github-copilot-business.md +++ b/content/copilot/copilot-business/about-github-copilot-business.md @@ -41,15 +41,15 @@ After setting up a subscription, you can enable {% data variables.product.prodna As a member of an organization, you can request access to {% data variables.product.prodname_copilot_for_business %} from your organization's owners. This can be done in a couple of different ways: -- From the [{% data variables.product.prodname_copilot %} settings](https://github.com/settings/copilot) for your personal account +* From the [{% data variables.product.prodname_copilot %} settings](https://github.com/settings/copilot) for your personal account ![Screenshot of the {% data variables.product.prodname_copilot %} settings page. A button labelled "Ask admin for access" is outlined in dark orange.](/assets/images/help/copilot/request-cfb-access-settings.png) -- From an empty repository in the organization +* From an empty repository in the organization ![Screenshot from the top of an empty repository with the option ask admin for access to {% data variables.product.prodname_copilot_for_business %}.](/assets/images/help/copilot/request-cfb-access-empty-repo.png) ## Further reading -- "[{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq)" -- "[{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/)" +* "[{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq)" +* "[{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/)" diff --git a/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md b/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md index 73b2e70a46a9..c98f426bf1fd 100644 --- a/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md +++ b/content/copilot/copilot-business/enabling-and-setting-up-github-copilot-business.md @@ -23,8 +23,8 @@ To use {% data variables.product.prodname_copilot_for_business %}, you need to s **Note:** -- You must be an enterprise owner to enable {% data variables.product.prodname_copilot_business_short %} for your enterprise. -- If you set up a {% data variables.product.prodname_copilot_business_short %} subscription for your organization account, you can skip this section. +* You must be an enterprise owner to enable {% data variables.product.prodname_copilot_business_short %} for your enterprise. +* If you set up a {% data variables.product.prodname_copilot_business_short %} subscription for your organization account, you can skip this section. {% endnote %} @@ -51,5 +51,5 @@ To give people or teams within your organization access to {% data variables.pro If members of your organization will be using {% data variables.product.prodname_copilot %} on your company's corporate network, you may need to configure network settings so that members can use {% data variables.product.prodname_copilot %} successfully. -- If you use an HTTP proxy server on your network, you can configure {% data variables.product.prodname_copilot %} to connect via this server. To successfully intercept and inspect {% data variables.product.prodname_copilot %}'s secure connection, you may need to install custom SSL certificates on your users' machines. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot)." -- If you use a firewall, you may need to add certain domains to the firewall's allowlist. For more information, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot)." +* If you use an HTTP proxy server on your network, you can configure {% data variables.product.prodname_copilot %} to connect via this server. To successfully intercept and inspect {% data variables.product.prodname_copilot %}'s secure connection, you may need to install custom SSL certificates on your users' machines. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot)." +* If you use a firewall, you may need to add certain domains to the firewall's allowlist. For more information, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot)." diff --git a/content/copilot/copilot-individual/about-github-copilot-individual.md b/content/copilot/copilot-individual/about-github-copilot-individual.md index 82f67e7c2300..a7166c349597 100644 --- a/content/copilot/copilot-individual/about-github-copilot-individual.md +++ b/content/copilot/copilot-individual/about-github-copilot-individual.md @@ -74,31 +74,31 @@ A Suggestion is the code, functions, or other output returned to you by {% data User Engagement Data, Prompts and Suggestions are used by {% data variables.product.company_short %} and Microsoft to improve {% data variables.product.prodname_copilot %} and related services and to conduct product and academic research. -- Enhancing {% data variables.product.prodname_copilot %}: The data collected is utilized to improve {% data variables.product.prodname_copilot %} by evaluating different strategies for processing and predicting suggestions that users may find valuable. -- Developing related developer products and services: The insights gained from the data help in the development and improvement of other developer tools and services offered by {% data variables.product.company_short %} and Microsoft. -- Detecting abuse and policy violations: The data is examined to investigate and identify any potential misuse or violation of the Acceptable Use Policies associated with {% data variables.product.prodname_copilot %}. -- Conducting experiments and research: The data is used for conducting experiments and research related to developers and their utilization of developer tools and services. This aids in gaining valuable insights into user behavior and preferences. -- Evaluating {% data variables.product.prodname_copilot %}: The impact of {% data variables.product.prodname_copilot %} on users is assessed by measuring its positive effects and benefits. -- Improving code generation models: The collected data is employed to refine and enhance the underlying models responsible for generating code. This is achieved by utilizing both positive and negative examples. -- Fine-tuning ranking and sorting algorithms: The data helps in the optimization and improvement of algorithms used for ranking and sorting suggestions, thereby enhancing the overall user experience. +* Enhancing {% data variables.product.prodname_copilot %}: The data collected is utilized to improve {% data variables.product.prodname_copilot %} by evaluating different strategies for processing and predicting suggestions that users may find valuable. +* Developing related developer products and services: The insights gained from the data help in the development and improvement of other developer tools and services offered by {% data variables.product.company_short %} and Microsoft. +* Detecting abuse and policy violations: The data is examined to investigate and identify any potential misuse or violation of the Acceptable Use Policies associated with {% data variables.product.prodname_copilot %}. +* Conducting experiments and research: The data is used for conducting experiments and research related to developers and their utilization of developer tools and services. This aids in gaining valuable insights into user behavior and preferences. +* Evaluating {% data variables.product.prodname_copilot %}: The impact of {% data variables.product.prodname_copilot %} on users is assessed by measuring its positive effects and benefits. +* Improving code generation models: The collected data is employed to refine and enhance the underlying models responsible for generating code. This is achieved by utilizing both positive and negative examples. +* Fine-tuning ranking and sorting algorithms: The data helps in the optimization and improvement of algorithms used for ranking and sorting suggestions, thereby enhancing the overall user experience. ### How is the transmitted Code Snippets data protected? To ensure the protection of sensitive data such as user edit actions, source code snippets, and repository URLs/file paths, several protective measures are implemented. These measures include: -- Encryption of transmitted data: All data is encrypted both during transit and while at rest, ensuring that it remains secure and inaccessible to unauthorized parties. -- Strict access control: Access to the data is tightly regulated and limited to specific individuals, including: - - Named {% data variables.product.company_short %} personnel working on the {% data variables.product.prodname_copilot %} team or the {% data variables.product.company_short %} platform health team. - - Microsoft personnel involved with the {% data variables.product.prodname_copilot %} team. -- Role-based access controls and multi-factor authentication: People who require access to code snippet data must adhere to role-based access controls. Additionally, multi-factor authentication is implemented to add an extra layer of security, ensuring that only authorized individuals can access the data. +* Encryption of transmitted data: All data is encrypted both during transit and while at rest, ensuring that it remains secure and inaccessible to unauthorized parties. +* Strict access control: Access to the data is tightly regulated and limited to specific individuals, including: + * Named {% data variables.product.company_short %} personnel working on the {% data variables.product.prodname_copilot %} team or the {% data variables.product.company_short %} platform health team. + * Microsoft personnel involved with the {% data variables.product.prodname_copilot %} team. +* Role-based access controls and multi-factor authentication: People who require access to code snippet data must adhere to role-based access controls. Additionally, multi-factor authentication is implemented to add an extra layer of security, ensuring that only authorized individuals can access the data. ### How can users of {% data variables.product.prodname_copilot_for_individuals %} control use of their Code Snippets Data? {% data variables.product.prodname_copilot %} gives you choices about how it uses the data it collects. -- User Engagement Data: User Engagement Data, including pseudonymous identifiers and general usage data, is necessary for the proper functioning of {% data variables.product.prodname_copilot %}. This data is collected, processed, and shared with Microsoft while you use {% data variables.product.prodname_copilot %}. -- Retention of Prompts and Suggestions: You have the option to decide whether Prompts and Suggestions, when using {% data variables.product.prodname_copilot %} in your code editor, are retained by {% data variables.product.company_short %} and shared with Microsoft. These preferences can be adjusted in the [{% data variables.product.prodname_copilot %} settings](https://github.com/settings/copilot). -- Requesting Deletion: If you wish to delete Prompts and Suggestions associated with your {% data variables.product.company_short %} identity, contact {% data variables.contact.contact_support %}. +* User Engagement Data: User Engagement Data, including pseudonymous identifiers and general usage data, is necessary for the proper functioning of {% data variables.product.prodname_copilot %}. This data is collected, processed, and shared with Microsoft while you use {% data variables.product.prodname_copilot %}. +* Retention of Prompts and Suggestions: You have the option to decide whether Prompts and Suggestions, when using {% data variables.product.prodname_copilot %} in your code editor, are retained by {% data variables.product.company_short %} and shared with Microsoft. These preferences can be adjusted in the [{% data variables.product.prodname_copilot %} settings](https://github.com/settings/copilot). +* Requesting Deletion: If you wish to delete Prompts and Suggestions associated with your {% data variables.product.company_short %} identity, contact {% data variables.contact.contact_support %}. ### Will my private code be shared with other users? @@ -106,6 +106,6 @@ No. We follow responsible practices in accordance with our [Privacy Statement](/ ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)"{% ifversion ghec %} -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/){% endif %} -- "[{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)"{% ifversion ghec %} +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/){% endif %} +* "[{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq)" diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/about-github-copilot-chat-in-github-mobile.md b/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/about-github-copilot-chat-in-github-mobile.md index 5be13f0f347f..3a91c22c6b44 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/about-github-copilot-chat-in-github-mobile.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/about-github-copilot-chat-in-github-mobile.md @@ -27,5 +27,5 @@ The primary supported language for {% data variables.product.prodname_copilot_mo ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile.md b/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile.md index 15bd8cfa816a..ceaba864d932 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile.md @@ -20,28 +20,28 @@ redirect_from: {% ifversion ghec %} In {% data variables.product.prodname_mobile %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask: -- General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)." -- Questions asked in the context of your project. For more information, see "[Asking questions about a specific repository](#asking-exploratory-questions-about-a-repository)." -- Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)."{% endif %} +* General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)." +* Questions asked in the context of your project. For more information, see "[Asking questions about a specific repository](#asking-exploratory-questions-about-a-repository)." +* Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)."{% endif %} ## Limitations The following {% ifversion fpt%}limitation applies{% else %} limitations apply{% endif %} to {% data variables.product.prodname_copilot_mobile_short %}: {% ifversion ghec%} -- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository.{% endif %} -- The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question. +* Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository.{% endif %} +* The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question. ## Prerequisites To use {% data variables.product.prodname_copilot_mobile_short %} you will need the following. -- **Subscription to {% data variables.product.prodname_copilot %}**: You must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." +* **Subscription to {% data variables.product.prodname_copilot %}**: You must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." If you do not have a {% data variables.product.prodname_copilot %} subscription, you can purchase a {% data variables.product.prodname_copilot_individuals_short %} subscription directly in the iOS version of {% data variables.product.prodname_mobile %}, or in the Google Play Store for the Android version of {% data variables.product.prodname_mobile %}. -- **Access to {% data variables.product.prodname_copilot_mobile_short %}**: If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_cli_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/enabling-github-copilot-chat-for-github-mobile)." -- **Enable {% data variables.product.prodname_copilot_short %} features for your device**: {% data variables.product.prodname_copilot_short %} needs to be enabled from within {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot#enabling-or-disabling-copilot-in-github-mobile)." +* **Access to {% data variables.product.prodname_copilot_mobile_short %}**: If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_cli_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/enabling-github-copilot-chat-for-github-mobile)." +* **Enable {% data variables.product.prodname_copilot_short %} features for your device**: {% data variables.product.prodname_copilot_short %} needs to be enabled from within {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot#enabling-or-disabling-copilot-in-github-mobile)." ## Asking a general question about software development @@ -56,11 +56,11 @@ You can ask a general question about software development{% ifversion ghec %} th 1. At the bottom of the page, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and send the message. Some examples of general questions you could ask are: - - What are the advantages of the Go programming language? - - What is Agile software development? - - What is the most popular JavaScript framework? - - Give me some examples of regular expressions. - - Write a bash script to output today's date. + * What are the advantages of the Go programming language? + * What is Agile software development? + * What is the most popular JavaScript framework? + * Give me some examples of regular expressions. + * Write a bash script to output today's date. 1. Within a conversation thread, you can ask follow-up questions. {% data variables.product.prodname_copilot_short %} will answer within the context of the conversation. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment. @@ -79,11 +79,11 @@ You can ask questions about a specific repository, to get help with understandin For example, if you chose the repository you are working in as the context, you could ask: - - What is the main purpose of this repo? What problem does it solve or what functionality does it provide? - - What web frameworks are used in this project? - - Where is rate limiting implemented in our API? - - How is the code organized? Explain the project architecture. - - Are there any specific environment requirements for working on this project? + * What is the main purpose of this repo? What problem does it solve or what functionality does it provide? + * What web frameworks are used in this project? + * Where is rate limiting implemented in our API? + * How is the code organized? Explain the project architecture. + * Are there any specific environment requirements for working on this project? > [!IMPORTANT] > {% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. However, only members of an enterprise with a {% data variables.product.prodname_copilot_enterprise %} subscription can index a repository for semantic code search. Without indexing, {% data variables.product.prodname_copilot_mobile_short %} may not be able to provide the most relevant answers to your questions. @@ -98,22 +98,22 @@ You can chat with {% data variables.product.prodname_copilot_short %} about a fi 1. In {% data variables.product.prodname_mobile %}, navigate to a repository and open a file. 1. Do one of the following: - - To ask a question about the entire file, tap the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) in the bottom right corner of the file view. - - To ask a question about specific lines within the file, select and copy the lines you want to ask about. Then tap the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) and paste the copied lines in the {% data variables.product.prodname_copilot_chat_short %} input field. + * To ask a question about the entire file, tap the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) in the bottom right corner of the file view. + * To ask a question about specific lines within the file, select and copy the lines you want to ask about. Then tap the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) and paste the copied lines in the {% data variables.product.prodname_copilot_chat_short %} input field. 1. Type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and send the message. For example, if you are asking about the entire file, you could enter: - - Explain this file. - - How could I improve this code? - - How can I test this script? + * Explain this file. + * How could I improve this code? + * How can I test this script? If you are asking about specific lines, you could enter: - - How could I improve this class? - - Add error handling to this code. - - Write a unit test for this method. + * How could I improve this class? + * Add error handling to this code. + * Write a unit test for this method. {% data variables.product.prodname_copilot_short %} responds to your request in the panel. diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom.md b/content/copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom.md index ea48c8b91ba3..a2586b1ee1f6 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-github/about-github-copilot-chat-in-githubcom.md @@ -159,9 +159,9 @@ When leveraging Bing, {% data variables.product.prodname_copilot_short %} will u For details of how to use {% data variables.product.prodname_copilot_chat_dotcom %}, see: -- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +* "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md b/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md index f4c1ec4c447d..f3187a692a91 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md @@ -24,18 +24,18 @@ redirect_from: On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask: -- General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)." -- Exploratory questions asked in the context of a specific repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)." -- Questions asked in the context of a specific repository, file or symbol. For more information, see "[Asking a question about a specific file or symbol](#asking-a-question-about-a-specific-file-or-symbol)." -- Questions asked in the context of a knowledge base (that is, Markdown documentation across one or more repositories). For more information, see "[Asking a question about a knowledge base](#asking-a-question-about-a-knowledge-base)." -- Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)." -- Questions about a pull request diff. For more information, see "[Finding out about the changes in a pull request](#finding-out-about-the-changes-in-a-pull-request)." -- Questions about a specific issue. For more information, see "[Asking a question about a specific issue](#asking-a-question-about-a-specific-issue)." +* General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)." +* Exploratory questions asked in the context of a specific repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)." +* Questions asked in the context of a specific repository, file or symbol. For more information, see "[Asking a question about a specific file or symbol](#asking-a-question-about-a-specific-file-or-symbol)." +* Questions asked in the context of a knowledge base (that is, Markdown documentation across one or more repositories). For more information, see "[Asking a question about a knowledge base](#asking-a-question-about-a-knowledge-base)." +* Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)." +* Questions about a pull request diff. For more information, see "[Finding out about the changes in a pull request](#finding-out-about-the-changes-in-a-pull-request)." +* Questions about a specific issue. For more information, see "[Asking a question about a specific issue](#asking-a-question-about-a-specific-issue)." ### Limitations -- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)." -- The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question. +* Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)." +* The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question. ## Prerequisites @@ -91,11 +91,11 @@ Depending on the question you ask, and your enterprise and organization settings 1. At the bottom of the panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press Enter. Some examples of general questions you could ask are: - - What are the advantages of the Go programming language? - - What is Agile software development? - - What is the most popular JavaScript framework? - - Give me some examples of regular expressions. - - Write a bash script to output today's date. + * What are the advantages of the Go programming language? + * What is Agile software development? + * What is the most popular JavaScript framework? + * Give me some examples of regular expressions. + * Write a bash script to output today's date. {% data reusables.copilot.stop-response-generation %} 1. If {% data variables.product.prodname_copilot_short %} uses a Bing search to answer your question, "Results from Bing" is displayed above the response. Click this to see the search results that {% data variables.product.prodname_copilot_short %} used to answer your question. @@ -131,11 +131,11 @@ Depending on the question you ask, and your enterprise and organization settings For example, you could ask: - - When was the most recent release? - - Where is rate limiting implemented in our API? - - How does the WidgetFactory class work? - - Where is the code for converting an organization member to be an outside collaborator? - - Where are SAT tokens generated? + * When was the most recent release? + * Where is rate limiting implemented in our API? + * How does the WidgetFactory class work? + * Where is the code for converting an organization member to be an outside collaborator? + * Where are SAT tokens generated? {% data variables.product.prodname_copilot_short %} replies in the chat panel. @@ -196,9 +196,9 @@ When you enter a query, {% data variables.product.prodname_copilot_short %} sear For example, if you chose a knowledge base with your organization's internal developer documentation, you could ask: - - How do I deploy a new application? - - What's the process for creating a new REST API? - - What are our best practices for logging? + * How do I deploy a new application? + * What's the process for creating a new REST API? + * What are our best practices for logging? {% data reusables.copilot.stop-response-generation %} 1. The response will typically contain numbered references to files that {% data variables.product.prodname_copilot_short %} uses to generate the answer, from the knowledge base you selected. To list the sources that were used, click **NUMBER references**. @@ -219,11 +219,11 @@ You can chat with {% data variables.product.prodname_copilot_short %} about a fi 1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository and open a file. 1. Do one of the following: - - To ask a question about the entire file, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) at the top right of the file view. + * To ask a question about the entire file, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) at the top right of the file view. ![Screenshot of the {% data variables.product.prodname_copilot_short %} button, highlighted with a dark orange outline, at the top of the file view.](/assets/images/help/copilot/copilot-button-for-file.png) - - To ask a question about specific lines within the file: + * To ask a question about specific lines within the file: 1. Select the lines by clicking the line number for the first line you want to select, holding down Shift and clicking the line number for the last line you want to select. 1. To ask your own question about the selected lines, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) to the right of your selection. @@ -236,15 +236,15 @@ You can chat with {% data variables.product.prodname_copilot_short %} about a fi For example, if you are asking about the entire file, you could enter: - - Explain this file. - - How could I improve this code? - - How can I test this script? + * Explain this file. + * How could I improve this code? + * How can I test this script? If you are asking about specific lines, you could enter: - - Explain the function at the selected lines. - - How could I improve this class? - - Add error handling to this code. - - Write a unit test for this method. + * Explain the function at the selected lines. + * How could I improve this class? + * Add error handling to this code. + * Write a unit test for this method. {% data variables.product.prodname_copilot_short %} responds to your request in the panel. @@ -266,8 +266,8 @@ You can ask {% data variables.product.prodname_copilot_short %} to explain what' 1. Click the **Files changed** tab. 1. Do one of the following: - - To ask a question about a file that's being changed by a pull request, click {% octicon "kebab-horizontal" aria-label="Show options" %} at the top right of the file, then click **Ask {% data variables.product.prodname_copilot_short %} about this diff**. - - To ask a question about specific lines within a file in the pull request: + * To ask a question about a file that's being changed by a pull request, click {% octicon "kebab-horizontal" aria-label="Show options" %} at the top right of the file, then click **Ask {% data variables.product.prodname_copilot_short %} about this diff**. + * To ask a question about specific lines within a file in the pull request: 1. Select the lines by clicking the line number for the first line you want to select, holding down Shift and clicking the line number for the last line you want to select. 1. To ask your own question about the selected lines, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) to the right of your selection. @@ -276,10 +276,10 @@ You can ask {% data variables.product.prodname_copilot_short %} to explain what' 1. If you clicked the {% data variables.product.prodname_copilot_short %} icon, or you chose **Ask {% data variables.product.prodname_copilot_short %} about this diff**, type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press Enter. For example, you could enter: - - Why has this module been included? - - What is `actorData` in this line? - - Explain this `do..end` block. - - What's the purpose of this file? + * Why has this module been included? + * What is `actorData` in this line? + * Explain this `do..end` block. + * What's the purpose of this file? {% data reusables.copilot.stop-response-generation %} @@ -299,9 +299,9 @@ You can ask {% data variables.product.prodname_copilot_short %} to summarize or 1. At the bottom of the {% data variables.product.prodname_copilot_short %} chat panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press Enter. For example, you could enter: - - Explain this issue - - Recommend next steps for this issue - - What are the acceptance criteria for this issue? + * Explain this issue + * Recommend next steps for this issue + * What are the acceptance criteria for this issue? {% tip %} @@ -323,9 +323,9 @@ You can ask {% data variables.product.prodname_copilot_short %} to explain the c 1. At the bottom of the {% data variables.product.prodname_copilot_short %} chat panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press Enter. For example, you could enter: - - Summarize the changes in this commit - - Who committed these changes? - - When was this commit made? + * Summarize the changes in this commit + * Who committed these changes? + * When was this commit made? > [!TIP] > If you know the SHA for a commit, instead of navigating to the commit, you can ask {% data variables.product.prodname_copilot_short %} about the commit from any page in the repository on {% data variables.product.prodname_dotcom_the_website %} by including the SHA in your message. For example, `What changed in commit a778e0eab?` @@ -342,9 +342,9 @@ You can ask {% data variables.product.prodname_copilot_short %} a question about For example, you could enter: - - What does this repo do? - - Where is authentication implemented in this codebase? - - How does license file detection work in this repo? + * What does this repo do? + * Where is authentication implemented in this codebase? + * How does license file detection work in this repo? 1. Click **Ask {% data variables.product.prodname_copilot_short %}**. diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-ides/about-github-copilot-chat-in-your-ide.md b/content/copilot/github-copilot-chat/copilot-chat-in-ides/about-github-copilot-chat-in-your-ide.md index c31c2af2cede..af71ea44917b 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-ides/about-github-copilot-chat-in-your-ide.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-ides/about-github-copilot-chat-in-your-ide.md @@ -47,8 +47,8 @@ This can be a useful tool for programmers, as it can provide guidance and suppor ### Leveraging a web search to answer a question > [!NOTE] -> - Bing search integration in {% data variables.product.prodname_copilot_chat_short %} is currently in beta and is subject to change. -> - The `@github` chat participant in {% data variables.product.prodname_vscode_shortname %} is currently in preview and is subject to change. For more information, see "[Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms)." +> * Bing search integration in {% data variables.product.prodname_copilot_chat_short %} is currently in beta and is subject to change. +> * The `@github` chat participant in {% data variables.product.prodname_vscode_shortname %} is currently in preview and is subject to change. For more information, see "[Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms)." When you use the `@github` chat participant, {% data variables.product.prodname_copilot_chat %} can use a Bing search to help answer your question if this has been enabled by your administrator. diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md b/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md index 29198207d128..bca0edc91383 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md @@ -16,7 +16,7 @@ shortTitle: Use Copilot Chat ## Prerequisites -- **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." +* **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." {% data reusables.copilot.vscode-prerequisites %} {% data reusables.copilot.chat-access-denied %} @@ -47,11 +47,11 @@ You can use special keywords to help {% data variables.product.prodname_copilot_ Use chat participants to scope your prompt to a specific domain. To use a chat participant, type `@` in the chat prompt box, followed by a chat participant name. Chat participants include: -- `@workspace`: Has context about the code in your workspace. Use `@workspace` when you want {% data variables.product.prodname_copilot_short %} to consider the structure of your project, how different parts of your code interact, or design patterns in your project. See "[Ask questions about your project](#ask-questions-about-your-project)." -- `@vscode`: Has context about {% data variables.product.prodname_vscode %} commands and features. Use `@vscode` when you want help with {% data variables.product.prodname_vscode %}. See "[Ask questions about {% data variables.product.prodname_vscode %}](#ask-questions-about-visual-studio-code)." -- `@terminal`: Has context about the {% data variables.product.prodname_vscode %} terminal shell and its contents. Use `@terminal` when you want help creating or debugging terminal commands. See "[Ask questions about the command line](#ask-questions-about-the-command-line)." +* `@workspace`: Has context about the code in your workspace. Use `@workspace` when you want {% data variables.product.prodname_copilot_short %} to consider the structure of your project, how different parts of your code interact, or design patterns in your project. See "[Ask questions about your project](#ask-questions-about-your-project)." +* `@vscode`: Has context about {% data variables.product.prodname_vscode %} commands and features. Use `@vscode` when you want help with {% data variables.product.prodname_vscode %}. See "[Ask questions about {% data variables.product.prodname_vscode %}](#ask-questions-about-visual-studio-code)." +* `@terminal`: Has context about the {% data variables.product.prodname_vscode %} terminal shell and its contents. Use `@terminal` when you want help creating or debugging terminal commands. See "[Ask questions about the command line](#ask-questions-about-the-command-line)." {% ifversion ghec %} -- `@github`: Allows you to use {% data variables.product.prodname_dotcom %}-specific {% data variables.product.prodname_copilot_short %} skills. See "[Using {% data variables.product.prodname_dotcom %} skills for {% data variables.product.prodname_copilot_short %}](#using-github-skills-for-copilot)." +* `@github`: Allows you to use {% data variables.product.prodname_dotcom %}-specific {% data variables.product.prodname_copilot_short %} skills. See "[Using {% data variables.product.prodname_dotcom %} skills for {% data variables.product.prodname_copilot_short %}](#using-github-skills-for-copilot)." {% endif %} To see all available chat participants, type `@` in the chat prompt box. See also [Chat participants](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-participants) in the {% data variables.product.prodname_vscode %} documentation. @@ -60,10 +60,10 @@ To see all available chat participants, type `@` in the chat prompt box. See als Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. Slash commands include: -- `/tests`: Generate unit tests for the selected code -- `/fix`: Propose a fix for problems in the selected code -- `/explain`: Explain the selected code -- `/clear`: Start a new chat +* `/tests`: Generate unit tests for the selected code +* `/fix`: Propose a fix for problems in the selected code +* `/explain`: Explain the selected code +* `/clear`: Start a new chat To see all available slash commands, type `/` in the chat prompt box. See also [Slash commands](https://code.visualstudio.com/docs/copilot/copilot-chat#_slash-commands) in the {% data variables.product.prodname_vscode %} documentation. @@ -71,9 +71,9 @@ To see all available slash commands, type `/` in the chat prompt box. See also [ Use chat variables to include specific context in your prompt. To use a chat variable, type `#` in the chat prompt box, followed by a chat variable. Chat variables include: -- `#file`: Include a specific file as context in the chat. -- `#git`: Include information about the current Git repository. -- `#terminalLastCommand`: Include the last run command in the active {% data variables.product.prodname_vscode %} terminal. +* `#file`: Include a specific file as context in the chat. +* `#git`: Include information about the current Git repository. +* `#terminalLastCommand`: Include the last run command in the active {% data variables.product.prodname_vscode %} terminal. To see all available chat variables, type `#` in the chat prompt box. See also [Chat variables](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-variables) in the {% data variables.product.prodname_vscode %} documentation. @@ -85,31 +85,31 @@ You can ask {% data variables.product.prodname_copilot_chat_short %} specific qu You can ask {% data variables.product.prodname_copilot_chat_short %} general software questions. For example: -- `tell me about nodejs web server frameworks` -- `how to create an express app` -- `@terminal how to update an npm package` (uses the @terminal [chat participant](#chat-participants)) +* `tell me about nodejs web server frameworks` +* `how to create an express app` +* `@terminal how to update an npm package` (uses the @terminal [chat participant](#chat-participants)) ### Ask questions about your project You can ask {% data variables.product.prodname_copilot_chat_short %} questions about your project. -- `what sorting algorithm does this function use` -- `@workspace how are notifications scheduled` -- `#file:gameReducer.js #file:gameInit.js how are these files related` +* `what sorting algorithm does this function use` +* `@workspace how are notifications scheduled` +* `#file:gameReducer.js #file:gameInit.js how are these files related` To give {% data variables.product.prodname_copilot_short %} the correct context, try some of these strategies: -- Highlight relevant lines of code -- Use chat variables like `#selection`, `#file`, `#editor`, `#codebase`, or `#git` -- Use the `@workspace` chat participant +* Highlight relevant lines of code +* Use chat variables like `#selection`, `#file`, `#editor`, `#codebase`, or `#git` +* Use the `@workspace` chat participant ### Write code You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example: -- `write a function to sum all numbers in a list` -- `add error handling to this function` -- `@workspace add form validation, similar to the newsletter page` +* `write a function to sum all numbers in a list` +* `add error handling to this function` +* `@workspace add form validation, similar to the newsletter page` When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code, or to insert the code at your cursor, into a new file, or into the terminal. @@ -117,15 +117,15 @@ When {% data variables.product.prodname_copilot_short %} returns a code block, t Use the `/new` slash command to set up a new project. For example: -- `/new react app with typescript` -- `/new python django web application` -- `/new node.js express server` +* `/new react app with typescript` +* `/new python django web application` +* `/new node.js express server` Copilot will suggest a directory structure and provide a button to create the suggested files and contents. To preview a suggested file, select the file name in the suggested directory structure. Use the `/newNotebook` slash command to set up a new Jupyter notebook. For example: -- `/newNotebook retrieve the titanic dataset and use Seaborn to plot the data` +* `/newNotebook retrieve the titanic dataset and use Seaborn to plot the data` ### Fix, improve, and refactor code @@ -133,36 +133,36 @@ If your active file contains an error, use the `/fix` slash command to ask {% da You can also make general requests to improve or refactor your code. -- `how would you improve this code?` -- `translate this code to C#` -- `add error handling to this function` +* `how would you improve this code?` +* `translate this code to C#` +* `add error handling to this function` ### Write tests Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example: -- `/tests` -- `/tests using the Jest framework` -- `/tests ensure the function rejects an empty list` +* `/tests` +* `/tests using the Jest framework` +* `/tests ensure the function rejects an empty list` The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example: -- `Add tests for a JavaScript function that should sum a list of integers` +* `Add tests for a JavaScript function that should sum a list of integers` ### Ask questions about {% data variables.product.prodname_vscode %} Use the `@vscode` chat participant to ask specific questions about {% data variables.product.prodname_vscode %}. For example: -- `@vscode tell me how to debug a node.js app` -- `@vscode how do I change my {% data variables.product.prodname_vscode %} colors` -- `@vscode how can I change key bindings` +* `@vscode tell me how to debug a node.js app` +* `@vscode how do I change my {% data variables.product.prodname_vscode %} colors` +* `@vscode how can I change key bindings` ### Ask questions about the command line Use the `@terminal` chat participant to ask specific questions about the command line. For example: -- `@terminal find the largest file in the src directory` -- `@terminal #terminalLastCommand` to explain the last command and any errors +* `@terminal find the largest file in the src directory` +* `@terminal #terminalLastCommand` to explain the last command and any errors {% ifversion ghec %} @@ -172,16 +172,16 @@ Use the `@terminal` chat participant to ask specific questions about the command **Notes**: -- This feature is only available if you have a {% data variables.product.prodname_copilot_enterprise_short %} subscription. -- The `@github` chat participant is currently in beta and is subject to change. +* This feature is only available if you have a {% data variables.product.prodname_copilot_enterprise_short %} subscription. +* The `@github` chat participant is currently in beta and is subject to change. {% endnote %} {% data variables.product.prodname_copilot_short %} has a collection of {% data variables.product.prodname_dotcom %}-specific skills that it can use to answer your questions. To access these skills in {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}, include `@github` in your question. When you add `@github` to a question, {% data variables.product.prodname_copilot_short %} dynamically selects an appropriate skill, based on the content of your question. You can also explicitly ask {% data variables.product.prodname_copilot_chat_short %} to use a particular skill. You can do this in two ways: -- Use natural language to ask {% data variables.product.prodname_copilot_chat_short %} to use a skill. For example, `@github Search the web to find the latest GPT4 model from OpenAI.` -- To specifically invoke a web search you can include the `#web` variable in your question. For example, `@github #web What is the latest LTS of Node.js?` +* Use natural language to ask {% data variables.product.prodname_copilot_chat_short %} to use a skill. For example, `@github Search the web to find the latest GPT4 model from OpenAI.` +* To specifically invoke a web search you can include the `#web` variable in your question. For example, `@github #web What is the latest LTS of Node.js?` ### Currently available skills @@ -220,9 +220,9 @@ You can tell {% data variables.product.prodname_copilot_short %} to answer a que In addition to submitting prompts through the chat view, you can submit prompts in other ways: -- **Inline**: To start an inline chat directly in the editor or integrated terminal, enter Command+i (Mac) / Ctrl+i (Windows/Linux). -- **Quick chat**: To open the quick chat dropdown, enter Shift+Command+i (Mac) / Shift+Ctrl+i (Windows/Linux) -- **Smart actions**: To submit prompts via the context menu, right click in your editor, select **Copilot** in the menu that appears, then select one of the actions. Smart actions can also be accessed via the sparkle icon that sometimes appears when you select a line of code. +* **Inline**: To start an inline chat directly in the editor or integrated terminal, enter Command+i (Mac) / Ctrl+i (Windows/Linux). +* **Quick chat**: To open the quick chat dropdown, enter Shift+Command+i (Mac) / Shift+Ctrl+i (Windows/Linux) +* **Smart actions**: To submit prompts via the context menu, right click in your editor, select **Copilot** in the menu that appears, then select one of the actions. Smart actions can also be accessed via the sparkle icon that sometimes appears when you select a line of code. See [inline chat](https://code.visualstudio.com/docs/copilot/copilot-chat#_inline-chat), [quick chat](https://code.visualstudio.com/docs/copilot/copilot-chat#_quick-chat), and [chat smart actions](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-smart-actions) in the {% data variables.product.prodname_vscode %} documentation for more details. @@ -234,14 +234,14 @@ To leave feedback about the {% data variables.product.prodname_copilot_chat %} e ## Further reading -- [Using Copilot Chat in VS Code](https://code.visualstudio.com/docs/copilot/copilot-chat) and [Getting started with GitHub Copilot Chat in VS Code](https://code.visualstudio.com/docs/copilot/getting-started-chat) in the {% data variables.product.prodname_vscode %} documentation +* [Using Copilot Chat in VS Code](https://code.visualstudio.com/docs/copilot/copilot-chat) and [Getting started with GitHub Copilot Chat in VS Code](https://code.visualstudio.com/docs/copilot/getting-started-chat) in the {% data variables.product.prodname_vscode %} documentation {% ifversion ghec %} -- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)" +* "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)" {% endif %} -- "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat)" -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)"{% ifversion ghec %} -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center){% endif %} -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq) +* "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)"{% ifversion ghec %} +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center){% endif %} +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq) {% endvscode %} @@ -249,11 +249,19 @@ To leave feedback about the {% data variables.product.prodname_copilot_chat %} e ## Prerequisites +<<<<<<< HEAD +* **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." +* **{% data variables.product.prodname_vs %} 2022 version 17.8 or higher**. See [Install Visual Studio](https://learn.microsoft.com/visualstudio/install/install-visual-studio) in the {% data variables.product.prodname_vs %} documentation. +* **{% data variables.product.prodname_copilot %} extension**. See [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the {% data variables.product.prodname_vs %} documentation. +* **{% data variables.product.prodname_copilot_chat %} extension**. See [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the {% data variables.product.prodname_vs %} documentation. +* **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vs %}**. If you experience authentication issues, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor)." +======= - **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." - **{% data variables.product.prodname_vs %} 2022 version 17.8 or later**. See [Install Visual Studio](https://learn.microsoft.com/visualstudio/install/install-visual-studio) in the {% data variables.product.prodname_vs %} documentation. - **{% data variables.product.prodname_copilot %} extension**. See [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the {% data variables.product.prodname_vs %} documentation. - **{% data variables.product.prodname_copilot_chat %} extension**. See [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the {% data variables.product.prodname_vs %} documentation. - **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vs %}**. If you experience authentication issues, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor)." +>>>>>>> main {% data reusables.copilot.chat-access-denied %} @@ -277,10 +285,10 @@ You can use special keywords to help {% data variables.product.prodname_copilot_ Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. Slash commands include: -- `/tests`: Generate unit tests for the selected code -- `/fix`: Propose a fix for problems in the selected code -- `/explain`: Explain the selected code -- `/optimize`: Analyze and improve the runtime of the selected code +* `/tests`: Generate unit tests for the selected code +* `/fix`: Propose a fix for problems in the selected code +* `/explain`: Explain the selected code +* `/optimize`: Analyze and improve the runtime of the selected code To see all available slash commands, type `/` in the chat prompt box. See also [Slash commands](https://learn.microsoft.com/visualstudio/ide/copilot-chat-context#slash-commands) in the {% data variables.product.prodname_vs %} documentation. @@ -288,10 +296,10 @@ To see all available slash commands, type `/` in the chat prompt box. See also [ By default, {% data variables.product.prodname_copilot_chat_short %} will reference the file that you have open or the code that you have selected. You can also use `#` followed by a file name, file name and line numbers, or `solution` to reference a specific file, lines, or solution. For example: -- Reference a specific file: `Where are the tests in #MyFile.cs?` -- Reference multiple files: `How are these files related #MyFile.cs #MyFile2.cs` -- Reference specific lines in a file: `Explain this function #MyFile.cs: 66-72?` -- Reference the current file: `Is there a delete method in this #solution` +* Reference a specific file: `Where are the tests in #MyFile.cs?` +* Reference multiple files: `How are these files related #MyFile.cs #MyFile2.cs` +* Reference specific lines in a file: `Explain this function #MyFile.cs: 66-72?` +* Reference the current file: `Is there a delete method in this #solution` See also [Reference](https://learn.microsoft.com/visualstudio/ide/copilot-chat-context#reference) in the {% data variables.product.prodname_vs %} documentation. @@ -303,30 +311,30 @@ You can ask {% data variables.product.prodname_copilot_chat_short %} specific qu You can ask {% data variables.product.prodname_copilot_chat_short %} general software questions. For example: -- `tell me about nodejs web server frameworks` -- `how to create an express app` -- `how to update an npm package` +* `tell me about nodejs web server frameworks` +* `how to create an express app` +* `how to update an npm package` ### Ask questions about your project You can ask {% data variables.product.prodname_copilot_chat_short %} questions about your project. To give {% data variables.product.prodname_copilot_short %} the correct context, try some of these strategies: -- Highlight relevant lines of code -- Open the relevant file -- Use `#file` to tell {% data variables.product.prodname_copilot_short %} to reference specific files -- Use `#solution` to tell {% data variables.product.prodname_copilot_short %} to reference the active file +* Highlight relevant lines of code +* Open the relevant file +* Use `#file` to tell {% data variables.product.prodname_copilot_short %} to reference specific files +* Use `#solution` to tell {% data variables.product.prodname_copilot_short %} to reference the active file For example: -- `what sorting algorithm does this function use` -- `#file:gameReducer.js what happens when a new game is requested` +* `what sorting algorithm does this function use` +* `#file:gameReducer.js what happens when a new game is requested` ### Write code You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example: -- `write a function to sum all numbers in a list` -- `add error handling to this function` +* `write a function to sum all numbers in a list` +* `add error handling to this function` When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code, insert the code into a new file, or preview the code output. @@ -336,21 +344,21 @@ If your active file contains an error, use the `/fix` slash command to ask {% da You can also make general requests to improve or refactor your code. -- `how would you improve this code?` -- `translate this code to C#` -- `add error handling to this function` +* `how would you improve this code?` +* `translate this code to C#` +* `add error handling to this function` ### Write tests Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example: -- `/tests` -- `/tests using the Jest framework` -- `/tests ensure the function rejects an empty list` +* `/tests` +* `/tests using the Jest framework` +* `/tests ensure the function rejects an empty list` The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example: -- `Add tests for a JavaScript function that should sum a list of integers` +* `Add tests for a JavaScript function that should sum a list of integers` {% ifversion ghec %} @@ -399,20 +407,20 @@ To share feedback about {% data variables.product.prodname_copilot_chat_short %} ![Screenshot of the share feedback button in {% data variables.product.prodname_vs %}.](/assets/images/help/copilot/vs-share-feedback-button.png) 1. Choose the option that best describes your feedback. - - To report a bug, click **Report a problem**. - - To request a feature, click **Suggest a feature**. + * To report a bug, click **Report a problem**. + * To request a feature, click **Suggest a feature**. ## Further reading -- [Using {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vs %} in the Microsoft Learn documentation](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-chat?view=vs-2022#use-copilot-chat-in-visual-studio) -- [Tips to improve {% data variables.product.prodname_copilot_chat %} results in the Microsoft Learn documentation](https://learn.microsoft.com/en-us/visualstudio/ide/copilot-chat-context?view=vs-2022) +* [Using {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vs %} in the Microsoft Learn documentation](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-chat?view=vs-2022#use-copilot-chat-in-visual-studio) +* [Tips to improve {% data variables.product.prodname_copilot_chat %} results in the Microsoft Learn documentation](https://learn.microsoft.com/en-us/visualstudio/ide/copilot-chat-context?view=vs-2022) {% ifversion ghec %} -- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)" +* "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)" {% endif %} -- "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat)" -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)"{% ifversion ghec %} -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center){% endif %} -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq) +* "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)"{% ifversion ghec %} +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center){% endif %} +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq) {% endvisualstudio %} @@ -420,10 +428,33 @@ To share feedback about {% data variables.product.prodname_copilot_chat_short %} ## Prerequisites +<<<<<<< HEAD +* **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." +* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: + * IntelliJ IDEA (Ultimate, Community, Educational) + * Android Studio + * AppCode + * CLion + * DataGrip + * DataSpell + * GoLand + * MPS + * PhpStorm + * PyCharm (Professional, Community, Educational) + * Rider + * RubyMine + * RustRover + * WebStorm + + See the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder to download. +* **{% data variables.product.prodname_copilot %} plugin**. See the [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace. For installation instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." +* **Sign in to {% data variables.product.company_short %} in your JetBrains IDE**. For authentication instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." +======= - **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." - **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: {% data reusables.copilot.jetbrains-compatible-ides %} +>>>>>>> main {% data reusables.copilot.jetbrains-plugin-prerequisites %} @@ -453,10 +484,10 @@ You can use special keywords to help {% data variables.product.prodname_copilot_ Use slash commands to avoid writing complex prompts for common scenarios. To use a slash command, type `/` in the chat prompt box, followed by a command. Slash commands include: -- `/tests`: Generate unit tests for the selected code -- `/fix`: Propose a fix for problems in the selected code -- `/explain`: Explain the selected code -- `/help`: Learn more about using {% data variables.product.prodname_copilot_chat_short %} +* `/tests`: Generate unit tests for the selected code +* `/fix`: Propose a fix for problems in the selected code +* `/explain`: Explain the selected code +* `/help`: Learn more about using {% data variables.product.prodname_copilot_chat_short %} To see all available slash commands, type `/` in the chat prompt box. @@ -472,29 +503,29 @@ You can ask {% data variables.product.prodname_copilot_chat_short %} specific qu You can ask {% data variables.product.prodname_copilot_chat_short %} general software questions. For example: -- `tell me about nodejs web server frameworks` -- `how to create an express app` -- `how to update an npm package` +* `tell me about nodejs web server frameworks` +* `how to create an express app` +* `how to update an npm package` ### Ask questions about your project You can ask {% data variables.product.prodname_copilot_chat_short %} questions about your project. To give {% data variables.product.prodname_copilot_short %} the correct context, try some of these strategies: -- Highlight relevant lines of code. -- Open the relevant file. -- Add the file as a reference. See [File references](#file-references). +* Highlight relevant lines of code. +* Open the relevant file. +* Add the file as a reference. See [File references](#file-references). For example: -- `what sorting algorithm does this function use` -- `how are these files related` (with references to the files in question) +* `what sorting algorithm does this function use` +* `how are these files related` (with references to the files in question) ### Write code You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example: -- `write a function to sum all numbers in a list` -- `add error handling to this function` +* `write a function to sum all numbers in a list` +* `add error handling to this function` When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code or to insert the code at your cursor. @@ -504,21 +535,21 @@ If your active file contains an error, use the `/fix` slash command to ask {% da You can also make general requests to improve or refactor your code. -- `how would you improve this code?` -- `translate this code to C#` -- `add error handling to this function` +* `how would you improve this code?` +* `translate this code to C#` +* `add error handling to this function` ### Write tests Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example: -- `/tests` -- `/tests using the Jest framework` -- `/tests ensure the function rejects an empty list` +* `/tests` +* `/tests using the Jest framework` +* `/tests ensure the function rejects an empty list` The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example: -- `Add tests for a JavaScript function that should sum a list of integers` +* `Add tests for a JavaScript function that should sum a list of integers` ## Additional ways to access {% data variables.product.prodname_copilot_chat_short %} @@ -539,10 +570,10 @@ To share feedback about {% data variables.product.prodname_copilot_chat_short %} ## Further reading {% ifversion ghec %}- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% endif %} -- "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat)" -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) "{% ifversion ghec %} -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center){% endif %} -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq) +* "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) "{% ifversion ghec %} +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center){% endif %} +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq) {% endjetbrains %} diff --git a/content/copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions.md b/content/copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions.md index 2d86fd528a85..36b7bebc84d4 100644 --- a/content/copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions.md +++ b/content/copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions.md @@ -22,9 +22,9 @@ After you install a {% data variables.product.prodname_copilot_extension_short % {% data variables.product.prodname_copilot_extensions_short %} provide several benefits, including: -- Interaction with external tools using natural language -- Reduced context switching -- Customization of your {% data variables.product.prodname_copilot_chat_short %} experience for your developer flow +* Interaction with external tools using natural language +* Reduced context switching +* Customization of your {% data variables.product.prodname_copilot_chat_short %} experience for your developer flow **{% data variables.product.prodname_copilot_extensions_short %} are included in all {% data variables.product.prodname_copilot_short %} subscriptions**, and can be used with: diff --git a/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization.md b/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization.md index 70c92521448b..2b917efee780 100644 --- a/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization.md +++ b/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization.md @@ -18,8 +18,8 @@ Before you install any {% data variables.product.prodname_copilot_extensions_sho Any organization owner can install {% data variables.product.prodname_copilot_extensions_short %} for their organization, but your organization must meet the following criteria to use an installed {% data variables.product.prodname_copilot_extension_short %}: -- Your organization is enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}. -- Your organization has an active {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription. +* Your organization is enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}. +* Your organization has an active {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription. > [!NOTE] Anyone can install a {% data variables.product.prodname_copilot_extension_short %} on their personal account. However, if they get access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, they will only be able to use the extension if it is installed at the organization level. diff --git a/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account.md b/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account.md index 55bf196dd3f4..cb1c8db840d5 100644 --- a/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account.md +++ b/content/copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account.md @@ -15,8 +15,8 @@ type: how_to Anyone can install {% data variables.product.prodname_copilot_extensions_short %} for their personal account, but you must meet the following criteria to use a {% data variables.product.prodname_copilot_extension_short %} you install: -- You are enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}. -- You have an active {% data variables.product.prodname_copilot_individuals_short %} subscription. +* You are enrolled in the limited public beta for {% data variables.product.prodname_copilot_extensions_short %}. +* You have an active {% data variables.product.prodname_copilot_individuals_short %} subscription. > [!NOTE] If you have access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription, {% data variables.product.prodname_copilot_extensions_short %} are installed by organization owners at the organization level, and you do not need to install the extension on your personal account. To start using {% data variables.product.prodname_copilot_extensions_short %} installed in your organization, see "[AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions)." diff --git a/content/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions.md b/content/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions.md index ab93bd5c544a..8f051ea5ff7c 100644 --- a/content/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions.md +++ b/content/copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions.md @@ -27,9 +27,9 @@ Additionally, after you install a {% data variables.product.prodname_copilot_ext {% data reusables.enterprise-accounts.copilot-tab %} {% data reusables.enterprise-accounts.copilot-policies-tab %} 1. In the "{% data variables.product.prodname_copilot_extensions_short %}" section, select the dropdown menu, then click one of the following options: - - **No policy**: organizations within your enterprise can set their own policies for {% data variables.product.prodname_copilot_extensions_short %}. - - **Enabled**: {% data variables.product.prodname_copilot_extensions_short %} are enabled for all organizations in your enterprise. - - **Disabled**: {% data variables.product.prodname_copilot_extensions_short %} are disabled for all organizations in your enterprise. + * **No policy**: organizations within your enterprise can set their own policies for {% data variables.product.prodname_copilot_extensions_short %}. + * **Enabled**: {% data variables.product.prodname_copilot_extensions_short %} are enabled for all organizations in your enterprise. + * **Disabled**: {% data variables.product.prodname_copilot_extensions_short %} are disabled for all organizations in your enterprise. {% endif %} @@ -54,8 +54,8 @@ After you have installed a {% data variables.product.prodname_copilot_extension_ 1. Optionally, to filter your installed {% data variables.product.prodname_github_apps %} for {% data variables.product.prodname_copilot_extensions_short %}, select the **Filter:** dropdown menu, then click **{% data variables.product.prodname_copilot_extensions_short %}**. 1. Next to the {% data variables.product.prodname_copilot_extension_short %} you want to review or modify, click **Configure**. 1. In the "Permissions" section, review the permissions listed for the {% data variables.product.prodname_copilot_extension_short %}. Optionally, you can block the {% data variables.product.prodname_copilot_extension_short %}'s access to your organization in one of two ways: - - To indefinitely suspend the {% data variables.product.prodname_copilot_extension_short %}'s access to resources in your organization while keeping the extension installed, in the "Danger zone" section, click **Suspend**. - - To uninstall a {% data variables.product.prodname_copilot_extension_short %} completely, in the "Danger zone" section, click **Uninstall**. + * To indefinitely suspend the {% data variables.product.prodname_copilot_extension_short %}'s access to resources in your organization while keeping the extension installed, in the "Danger zone" section, click **Suspend**. + * To uninstall a {% data variables.product.prodname_copilot_extension_short %} completely, in the "Danger zone" section, click **Uninstall**. ## Next steps diff --git a/content/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions.md b/content/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions.md index d11ad65ecda1..443d2f1e5176 100644 --- a/content/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions.md +++ b/content/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions.md @@ -25,26 +25,26 @@ If you have access to {% data variables.product.prodname_copilot_short %} throug ## Using {% data variables.product.prodname_copilot_extensions %} 1. To start using a {% data variables.product.prodname_copilot_extension_short %}, open any of the following {% data variables.product.prodname_copilot_chat_short %} interfaces: - - {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=vscode#asking-your-first-question)." - - {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=visualstudio#asking-your-first-question-1)."{% ifversion ghec %} - - {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %} (if you have a {% data variables.product.prodname_copilot_enterprise_short %} subscription). See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)."{% endif %} + * {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=vscode#asking-your-first-question)." + * {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=visualstudio#asking-your-first-question-1)."{% ifversion ghec %} + * {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %} (if you have a {% data variables.product.prodname_copilot_enterprise_short %} subscription). See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)."{% endif %} 1. To see a list of all {% data variables.product.prodname_copilot_extensions_short %} available in your {% data variables.product.prodname_copilot_chat_short %} conversation, in the {% data variables.product.prodname_copilot_chat_short %} text box, type `@`. > [!NOTE] If you are using {% data variables.product.prodname_copilot_chat_short %} in an IDE, and you or your organization owner install a {% data variables.product.prodname_copilot_extension_short %} while your IDE is open, you need to restart your IDE to begin using the {% data variables.product.prodname_copilot_extension_short %}. 1. In the list of available {% data variables.product.prodname_copilot_extensions_short %}, click the one you want to use. 1. To begin interacting with the {% data variables.product.prodname_copilot_extension_short %}, in the {% data variables.product.prodname_copilot_chat_short %} text box, ask the extension to answer a question or perform an action, then press Enter. For each new request, be sure to include `@EXTENSION-NAME` at the beginning of your sentence. - - If you did not install the {% data variables.product.prodname_copilot_extension_short %} yourself, and it is your first time using the {% data variables.product.prodname_copilot_extension_short %}, you will be asked to authorize the extension. See "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." - - If you ask a {% data variables.product.prodname_copilot_extension_short %} to perform an action, you need to confirm the extension has your permission to act on your behalf before it will complete the task. After carefully reviewing the proposed action, in the confirmation dialog, click **Allow** or **Dismiss**. + * If you did not install the {% data variables.product.prodname_copilot_extension_short %} yourself, and it is your first time using the {% data variables.product.prodname_copilot_extension_short %}, you will be asked to authorize the extension. See "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)." + * If you ask a {% data variables.product.prodname_copilot_extension_short %} to perform an action, you need to confirm the extension has your permission to act on your behalf before it will complete the task. After carefully reviewing the proposed action, in the confirmation dialog, click **Allow** or **Dismiss**. ## Tips for using {% data variables.product.prodname_copilot_extensions %} -- When you are using a {% data variables.product.prodname_copilot_extension_short %}, consider how you would interact with the tool outside of {% data variables.product.prodname_copilot_chat_short %}, then use natural language to ask questions and assign tasks that integrate the capabilities of the tool with {% data variables.product.prodname_dotcom %}. For example, [Sentry](https://sentry.io/welcome/) is an application monitoring software with a {% data variables.product.prodname_copilot_extension_short %}. The following are some example prompts for the Sentry extension for {% data variables.product.prodname_copilot %}: - - `@sentry list my most recent issues` - - `@sentry tell me more about issue ISSUE-ID-OR-ISSUE-LINK` - - `@sentry create a {% data variables.product.prodname_dotcom %} issue for the most recent Sentry issue and assign it to @DEVELOPER` +* When you are using a {% data variables.product.prodname_copilot_extension_short %}, consider how you would interact with the tool outside of {% data variables.product.prodname_copilot_chat_short %}, then use natural language to ask questions and assign tasks that integrate the capabilities of the tool with {% data variables.product.prodname_dotcom %}. For example, [Sentry](https://sentry.io/welcome/) is an application monitoring software with a {% data variables.product.prodname_copilot_extension_short %}. The following are some example prompts for the Sentry extension for {% data variables.product.prodname_copilot %}: + * `@sentry list my most recent issues` + * `@sentry tell me more about issue ISSUE-ID-OR-ISSUE-LINK` + * `@sentry create a {% data variables.product.prodname_dotcom %} issue for the most recent Sentry issue and assign it to @DEVELOPER` For information on the best ways to use a specific {% data variables.product.prodname_copilot_extension_short %}, read the description of the extension on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=apps&copilot_app=true). -- Interactions with one {% data variables.product.prodname_copilot_extension_short %} will never be shared with another {% data variables.product.prodname_copilot_extension_short %}. To interact with different {% data variables.product.prodname_copilot_extensions_short %} in an IDE, change the `@EXTENSION-NAME` at the beginning of each sentence. Interactions with different extensions will appear in the same {% data variables.product.prodname_copilot_chat_short %} window, but the conversations themselves are automatically separated. +* Interactions with one {% data variables.product.prodname_copilot_extension_short %} will never be shared with another {% data variables.product.prodname_copilot_extension_short %}. To interact with different {% data variables.product.prodname_copilot_extensions_short %} in an IDE, change the `@EXTENSION-NAME` at the beginning of each sentence. Interactions with different extensions will appear in the same {% data variables.product.prodname_copilot_chat_short %} window, but the conversations themselves are automatically separated. {% ifversion ghec %} To interact with different {% data variables.product.prodname_copilot_extensions_short %} on {% data variables.product.prodname_dotcom_the_website %}, you need to start a new conversation for each extension by clicking {% octicon "plus" aria-label="New conversation" %} at the top of the {% data variables.product.prodname_copilot_chat_short %} window.{% endif %} diff --git a/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries.md b/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries.md index aac57d830652..5fdd8defcac6 100644 --- a/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries.md +++ b/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries.md @@ -38,8 +38,8 @@ When a user requests a summary, a workflow is triggered. The workflow uses the c You can initiate this feature when creating a pull request, by editing the pull request description after creation, or in a comment in the pull request thread. Upon initiation, {% data variables.product.prodname_copilot_short %} will generate a two part summary: -- A paragraph, written in prose, giving an overview of the changes in the pull request. -- A bulleted list of the key changes, linked to the respective lines of code where those changes occur. +* A paragraph, written in prose, giving an overview of the changes in the pull request. +* A bulleted list of the key changes, linked to the respective lines of code where those changes occur. Larger pull requests can take a couple minutes for {% data variables.product.prodname_copilot_short %} to generate. Depending on your enterprise settings, you can share your feedback on a summary directly from the UI after a summary is generated to help us continue to improve the feature. @@ -91,7 +91,7 @@ Because a summary is an outline of the changes that were made in a pull request, ## Further reading -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) {%- ifversion fpt %} -- "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)" in the {% data variables.product.prodname_ghe_cloud %} documentation. +* "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)" in the {% data variables.product.prodname_ghe_cloud %} documentation. {%- endif %} diff --git a/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot.md b/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot.md index db446882de8c..4c864b7a50a6 100644 --- a/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot.md +++ b/content/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot.md @@ -15,9 +15,9 @@ You can use {% data variables.product.prodname_copilot %} to generate a summary {% data variables.product.prodname_copilot %} will scan through the pull request and provide an overview of the changes made in prose, as well as a bulleted list of changes with the files that they impact. You can generate a summary in the following places. -- In the description of a new pull request you're creating -- In the description of an existing pull request, by editing the opening comment -- In a comment on the main timeline of a pull request +* In the description of a new pull request you're creating +* In the description of an existing pull request, by editing the opening comment +* In a comment on the main timeline of a pull request To learn more about {% data variables.product.prodname_copilot_for_prs %} and how to use the feature most effectively, see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries)." @@ -33,9 +33,9 @@ To learn more about {% data variables.product.prodname_copilot_for_prs %} and ho 1. Navigate to the text field where you want to add the pull request summary. - - If you're creating a new pull request, use the "Add a description" field. - - If you're adding a description to an existing pull request, edit the opening comment. - - If you're adding a summary as a comment, navigate to the "Add a comment" section at the bottom of the pull request page. + * If you're creating a new pull request, use the "Add a description" field. + * If you're adding a description to an existing pull request, edit the opening comment. + * If you're adding a summary as a comment, navigate to the "Add a comment" section at the bottom of the pull request page. 1. In the header of the text field, select {% octicon "copilot" aria-label="Copilot actions" %}, then click **Summary**. diff --git a/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md b/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md index 9c5af45f4379..89ddab132f85 100644 --- a/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md +++ b/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md @@ -47,5 +47,5 @@ Access to {% data variables.product.prodname_copilot %} is managed at the organi ## Further reading -- "[{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq)" -- "[{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/)" +* "[{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot#faq)" +* "[{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/)" diff --git a/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md b/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md index 8e16ee000add..d28a62c0844f 100644 --- a/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md +++ b/content/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features.md @@ -16,13 +16,13 @@ To enable users to use {% data variables.product.prodname_copilot_enterprise_sho Access to {% data variables.product.prodname_copilot_short %} is determined at the enterprise and organization levels: -- Enterprise owners can allow some or all of the organizations in the enterprise to access {% data variables.product.prodname_copilot_short %}. For more information, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise)." -- Owners of organizations that have been granted access to {% data variables.product.prodname_copilot_short %} can assign {% data variables.product.prodname_copilot_enterprise %} seats to some or all members of their organization. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." +* Enterprise owners can allow some or all of the organizations in the enterprise to access {% data variables.product.prodname_copilot_short %}. For more information, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise)." +* Owners of organizations that have been granted access to {% data variables.product.prodname_copilot_short %} can assign {% data variables.product.prodname_copilot_enterprise %} seats to some or all members of their organization. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." When access to {% data variables.product.prodname_copilot_short %} has been enabled, features such as the ability to use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}, can be configured. Features are enabled or disabled at the enterprise or organization level: -- Enterprise owners can set {% data variables.product.prodname_copilot_short %} features to be enabled or disabled for all organizations in the enterprise that have access to {% data variables.product.prodname_copilot_short %}. Alternatively, they can allow each organization to set its own policy for each feature. -- If the enterprise owner has permitted it, organization owners can enable or disable {% data variables.product.prodname_copilot_short %} features for their organization. +* Enterprise owners can set {% data variables.product.prodname_copilot_short %} features to be enabled or disabled for all organizations in the enterprise that have access to {% data variables.product.prodname_copilot_short %}. Alternatively, they can allow each organization to set its own policy for each feature. +* If the enterprise owner has permitted it, organization owners can enable or disable {% data variables.product.prodname_copilot_short %} features for their organization. This article explains how to enable or disable the features of {% data variables.product.prodname_copilot_enterprise %} at the enterprise level, and for an individual organization. @@ -60,8 +60,8 @@ If your organization's parent enterprise has selected **No policy** for "{% data 1. Next to "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}", select the dropdown menu (labeled **Disabled** by default), then choose from the following options. - - **Enabled**: The feature is enabled for all members of the organization. - - **Disabled**: The feature is disabled for all members of the organization. + * **Enabled**: The feature is enabled for all members of the organization. + * **Disabled**: The feature is disabled for all members of the organization. 1. If you select **Enabled**, two check boxes are displayed. @@ -83,4 +83,4 @@ After {% data variables.product.prodname_copilot_enterprise_short %} has been en ## Further reading -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)" +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)" diff --git a/content/copilot/github-copilot-in-the-cli/about-github-copilot-in-the-cli.md b/content/copilot/github-copilot-in-the-cli/about-github-copilot-in-the-cli.md index 13cb88254ff9..86a5a0f71f6a 100644 --- a/content/copilot/github-copilot-in-the-cli/about-github-copilot-in-the-cli.md +++ b/content/copilot/github-copilot-in-the-cli/about-github-copilot-in-the-cli.md @@ -95,5 +95,5 @@ Additionally, you are ultimately responsible for the commands executed by {% dat ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) diff --git a/content/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli.md b/content/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli.md index 2458ae02f50d..baee897b3314 100644 --- a/content/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli.md +++ b/content/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli.md @@ -14,8 +14,8 @@ redirect_from: ## Prerequisites -- **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)". -- **{% data variables.product.prodname_cli %} installed.** {% data reusables.cli.cli-installation %} +* **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)". +* **{% data variables.product.prodname_cli %} installed.** {% data reusables.cli.cli-installation %} If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_cli_short %} if your organization owner or enterprise administrator has disabled {% data variables.product.prodname_copilot_cli_short %}. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." @@ -43,5 +43,5 @@ gh extension upgrade gh-copilot ## Further reading -- "[AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli)" -- "[AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli)" +* "[AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli)" +* "[AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli)" diff --git a/content/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli.md b/content/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli.md index 49072a97659f..31d80554b6e2 100644 --- a/content/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli.md +++ b/content/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli.md @@ -11,9 +11,9 @@ shortTitle: Use Copilot in the CLI ## Prerequisites -- **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." -- **{% data variables.product.prodname_cli %} installed**. {% data reusables.cli.cli-installation %} -- **{% data variables.product.prodname_copilot_cli_short %} extension installed**. See "[AUTOTITLE](/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli)." +* **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." +* **{% data variables.product.prodname_cli %} installed**. {% data reusables.cli.cli-installation %} +* **{% data variables.product.prodname_copilot_cli_short %} extension installed**. See "[AUTOTITLE](/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli)." If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_cli_short %} if your organization owner or enterprise administrator has disabled {% data variables.product.prodname_copilot_cli_short %}. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." @@ -47,5 +47,5 @@ You can also open an issue in the [{% data variables.product.prodname_copilot_cl ## Further reading -- [{% data variables.product.prodname_copilot_cli_short %} extension README](https://github.com/github/gh-copilot?tab=readme-ov-file) -- "[AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli)" +* [{% data variables.product.prodname_copilot_cli_short %} extension README](https://github.com/github/gh-copilot?tab=readme-ov-file) +* "[AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli)" diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md b/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md index 5eb695676085..07cba4171c4b 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md +++ b/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md @@ -81,8 +81,8 @@ You can manage advanced settings for {% data variables.product.prodname_copilot {% data reusables.copilot.jetbrains-settings %} {% data reusables.copilot.jetbrains-languages-and-frameworks %} 1. Edit the settings according to your personal preferences. - - To adjust the behavior and appearance of code suggestions, and whether to automatically check for updates, select or deselect the corresponding checkboxes. - - If you have selected to receive automatic updates, you can choose whether to receive stable, but less frequent updates, or nightly updates, which may be less stable. Click the **Update channel** dropdown and select **Stable** for stable updates, or **Nightly** for nightly updates. + * To adjust the behavior and appearance of code suggestions, and whether to automatically check for updates, select or deselect the corresponding checkboxes. + * If you have selected to receive automatic updates, you can choose whether to receive stable, but less frequent updates, or nightly updates, which may be less stable. Click the **Update channel** dropdown and select **Stable** for stable updates, or **Nightly** for nightly updates. ## Configuring language settings for {% data variables.product.prodname_copilot %} @@ -104,9 +104,9 @@ To configure language settings in the `github-copilot.xml` file, you must edit t The file is located in the following directory: -- **macOS**: `~/Library/Application Support/JetBrains//options/github-copilot.xml` -- **Windows**: `%APPDATA%\JetBrains\\options\github-copilot.xml` -- **Linux**: `~/.config/JetBrains//options/github-copilot.xml` +* **macOS**: `~/Library/Application Support/JetBrains//options/github-copilot.xml` +* **Windows**: `%APPDATA%\JetBrains\\options\github-copilot.xml` +* **Linux**: `~/.config/JetBrains//options/github-copilot.xml` For example, if you are using IntelliJ IDEA 2021.1 on macOS, the file is located at `~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml`. @@ -189,7 +189,7 @@ You can also add a configuration to make the `languageAllowList` readonly in the ## Further reading -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) {% endjetbrains %} @@ -246,7 +246,7 @@ If you use ReSharper, {% data variables.product.prodname_copilot %} may work bes ## Further reading -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) {% endvisualstudio %} @@ -255,9 +255,9 @@ If you use ReSharper, {% data variables.product.prodname_copilot %} may work bes ## About {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %} If you use {% data variables.product.prodname_vscode %}, you can use {% data variables.product.prodname_copilot %} to: -- Generate code -- Learn from the code {% data variables.product.prodname_copilot_short %} generates -- Help you configure your editor +* Generate code +* Learn from the code {% data variables.product.prodname_copilot_short %} generates +* Help you configure your editor You can learn more about scenarios and setup in the [VS Code documentation](https://code.visualstudio.com/docs/copilot/overview#_use-cases-for-github-copilot-in-vs-code). @@ -375,8 +375,8 @@ After you have revoked authorization, if you want to continue using {% data vari ## Further reading -- [{% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/overview) -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) +* [{% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/overview) +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) {% endvscode %} @@ -396,6 +396,6 @@ You can rebind the keyboard shortcuts in Vim/Neovim when using {% data variables ## Further reading -- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) +* [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq) {% endvimneovim %} diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md b/content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md index edb609677e94..7c375da1ddad 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md +++ b/content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md @@ -31,10 +31,10 @@ You can configure an HTTP proxy for {% data variables.product.prodname_copilot % If you don't configure a proxy directly in your editor, {% data variables.product.prodname_copilot %} checks if a proxy URL is set in any of the following environment variables, listed from highest to lowest priority. -- `HTTPS_PROXY` -- `https_proxy` -- `HTTP_PROXY` -- `http_proxy` +* `HTTPS_PROXY` +* `https_proxy` +* `HTTP_PROXY` +* `http_proxy` {% note %} @@ -153,8 +153,8 @@ Generally, if you're using company equipment, your company's IT department shoul {% endwarning %} -- For Windows, see [Installing the trusted root certificate](https://learn.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate) in the Microsoft documentation. -- For macOS, see [Add certificates to a keychain using Keychain Access on Mac](https://support.apple.com/en-gb/guide/keychain-access/kyca2431/mac) in the Keychain Access User Guide. -- For Linux, see [Installing a root CA certificate in the trust store](https://ubuntu.com/server/docs/security-trust-store) in the Ubuntu documentation. Similar instructions should apply to most Linux distributions. +* For Windows, see [Installing the trusted root certificate](https://learn.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate) in the Microsoft documentation. +* For macOS, see [Add certificates to a keychain using Keychain Access on Mac](https://support.apple.com/en-gb/guide/keychain-access/kyca2431/mac) in the Keychain Access User Guide. +* For Linux, see [Installing a root CA certificate in the trust store](https://ubuntu.com/server/docs/security-trust-store) in the Ubuntu documentation. Similar instructions should apply to most Linux distributions. If you have installed a certificate but {% data variables.product.prodname_copilot_short %} isn't detecting it, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot#troubleshooting-certificate-related-errors)." diff --git a/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md b/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md index 7f2af1bb261b..ced62ad76caf 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md +++ b/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md @@ -29,8 +29,8 @@ To see instructions for other popular coding environments, use the tool switcher 1. If a popup window in Azure Data Studio prompts you to sign in to use {% data variables.product.prodname_copilot %}, click **Sign in to {% data variables.product.prodname_dotcom %}** and follow the instructions on screen. - - If you have previously authorized Azure Data Studio for your account on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_copilot %} will be automatically authorized. - - If you don't get the prompt to authorize, you can view notifications by clicking the bell icon in the bottom panel of the Azure Data Studio window. + * If you have previously authorized Azure Data Studio for your account on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_copilot %} will be automatically authorized. + * If you don't get the prompt to authorize, you can view notifications by clicking the bell icon in the bottom panel of the Azure Data Studio window. 1. If you are following the authorization steps, in your browser, {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize Azure Data Studio**. @@ -96,28 +96,28 @@ To see instructions for other popular coding environments, use the tool switcher 1. Install {% data variables.product.prodname_copilot %} using the built-in plugin manager: - - For **Vim on macOS or Linux**, run the following command in the terminal. + * For **Vim on macOS or Linux**, run the following command in the terminal. ```shell copy git clone https://github.com/github/copilot.vim \ ~/.vim/pack/github/start/copilot.vim ``` - - For **Vim on Windows**, run the following command in Git Bash: + * For **Vim on Windows**, run the following command in Git Bash: ```shell copy git clone https://github.com/github/copilot.vim.git \ $HOME/vimfiles/pack/github/start/copilot.vim ``` - - For **Neovim on macOS or Linux**, run the following command in the terminal. + * For **Neovim on macOS or Linux**, run the following command in the terminal. ```shell copy git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim ``` - - For **Neovim on Windows**, run the following command in Git Bash: + * For **Neovim on Windows**, run the following command in Git Bash: ```shell copy git clone https://github.com/github/copilot.vim.git \ @@ -178,4 +178,4 @@ Only the latest {% data variables.product.prodname_copilot_chat_short %} version ## Next steps -- **Get started with {% data variables.product.prodname_copilot_short %}** - Learn how to use {% data variables.product.prodname_copilot_short %} in your preferred coding environment. See "[AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor)." +* **Get started with {% data variables.product.prodname_copilot_short %}** - Learn how to use {% data variables.product.prodname_copilot_short %} in your preferred coding environment. See "[AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor)." diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/modifying-your-copilot-subscription-as-an-individual-user.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/modifying-your-copilot-subscription-as-an-individual-user.md index 318079b948a9..800ded5509d8 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/modifying-your-copilot-subscription-as-an-individual-user.md +++ b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/modifying-your-copilot-subscription-as-an-individual-user.md @@ -15,7 +15,7 @@ If you have access to {% data variables.product.prodname_copilot %} through an o {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} 1. In the "{% data variables.product.prodname_copilot %}" section, select the **Edit** dropdown on the right. - - If you are on a monthly billing cycle, select **Change to yearly billing**. - - If you are on a yearly billing cycle, select **Change to monthly billing**. + * If you are on a monthly billing cycle, select **Change to yearly billing**. + * If you are on a yearly billing cycle, select **Change to monthly billing**. {% data reusables.billing.billing-info %} diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user.md index 267bbedf814e..79507bd9d380 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user.md +++ b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user.md @@ -24,5 +24,5 @@ Before you can start using {% data variables.product.prodname_copilot_for_indivi ## Further reading -- "[AUTOTITLE](/copilot/overview-of-github-copilot/about-github-copilot-individual)" -- "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)" +* "[AUTOTITLE](/copilot/overview-of-github-copilot/about-github-copilot-individual)" +* "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot)" diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md index 9ffa6ed5f376..fd2ede6036b2 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md @@ -13,13 +13,13 @@ topics: {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %} 1. In the "{% data variables.product.prodname_copilot_short %} is active in your enterprise" section, configure the access for your {% data variables.product.prodname_copilot %} subscription. - - To disable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, select **Disabled**. - - To disable {% data variables.product.prodname_copilot %} for specific organizations, select **Allow for specific organizations**. + * To disable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, select **Disabled**. + * To disable {% data variables.product.prodname_copilot %} for specific organizations, select **Allow for specific organizations**. 1. If you selected **Allow for specific organizations**, select the organizations you want to disable {% data variables.product.prodname_copilot %} for. Then, click the **Set organization permissions** dropdown and select **Disable** to deny {% data variables.product.prodname_copilot %} access for the specified organizations. ![Screenshot of the {% data variables.product.prodname_copilot %} policy page. The organization permissions dropdown is outlined in dark orange.](/assets/images/help/copilot/set-org-permissions-enterprise.png) 1. Review your selection. - - If you selected **Disabled**, you will see a warning that disabling {% data variables.product.prodname_copilot %} will revoke access for all organizations and members. To confirm, click **Confirm and save**. - - If you selected **Allow for specific organizations**, click **Save**. + * If you selected **Disabled**, you will see a warning that disabling {% data variables.product.prodname_copilot %} will revoke access for all organizations and members. To confirm, click **Confirm and save**. + * If you selected **Allow for specific organizations**, click **Save**. diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md index 14ab9d83b8e7..eaec336f1874 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md @@ -15,8 +15,8 @@ Admins of enterprises that have a {% data variables.product.prodname_copilot_ent {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %} 1. In the "{% data variables.product.prodname_copilot_short %} is active in your enterprise" section, configure the access for your {% data variables.product.prodname_copilot %} subscription. - - To enable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, both current and future, select **Allow for: All organizations**. - - To enable {% data variables.product.prodname_copilot %} for specific organizations, select **Allow for specific organizations**. + * To enable {% data variables.product.prodname_copilot %} for all organizations in your enterprise, both current and future, select **Allow for: All organizations**. + * To enable {% data variables.product.prodname_copilot %} for specific organizations, select **Allow for specific organizations**. 1. If you selected **Allow for specific organizations**, select the organizations you want to enable {% data variables.product.prodname_copilot %} for. Then, click the **Set organization permissions** dropdown and select **Enable** to grant {% data variables.product.prodname_copilot %} access for the specified organizations. diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md index 0eb79913d8e2..8115f976b37f 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md @@ -24,9 +24,9 @@ Wherever a restrictive policy has been chosen at the enterprise level, an organi {% data reusables.enterprise-accounts.copilot-tab %} {% data reusables.enterprise-accounts.copilot-policies-tab %} 1. Next to "Suggestions matching public code," click the dropdown menu and select the policy you want to enforce. - - To block {% data variables.product.prodname_copilot %} suggestions matching public code, select **Blocked**. - - To allow {% data variables.product.prodname_copilot %} suggestions matching public code, select **Allowed**. - - To allow each of your organizations to set their own policy on the use of {% data variables.product.prodname_copilot %} suggestions matching public code, select **No policy**. + * To block {% data variables.product.prodname_copilot %} suggestions matching public code, select **Blocked**. + * To allow {% data variables.product.prodname_copilot %} suggestions matching public code, select **Allowed**. + * To allow each of your organizations to set their own policy on the use of {% data variables.product.prodname_copilot %} suggestions matching public code, select **No policy**. ## Enforcing a policy to manage the use of {% data variables.product.prodname_copilot %} features on {% data variables.product.prodname_dotcom_the_website %} @@ -46,9 +46,9 @@ To manage the use of {% data variables.product.prodname_copilot_chat_dotcom_shor {% data reusables.enterprise-accounts.copilot-tab %} {% data reusables.enterprise-accounts.copilot-policies-tab %} 1. Next to "{% data variables.product.prodname_copilot_chat %} in the IDE," click the dropdown menu and select the policy you want to enforce. - - To allow each of your organizations to set their own policy on the use of {% data variables.product.prodname_copilot_chat %}, select **No policy**. - - To allow use of {% data variables.product.prodname_copilot_chat %}, select **Enabled**. - - To prevent use of {% data variables.product.prodname_copilot_chat %}, select **Disabled**. + * To allow each of your organizations to set their own policy on the use of {% data variables.product.prodname_copilot_chat %}, select **No policy**. + * To allow use of {% data variables.product.prodname_copilot_chat %}, select **Enabled**. + * To prevent use of {% data variables.product.prodname_copilot_chat %}, select **Disabled**. ## Enforcing a policy to manage the use of {% data variables.product.prodname_copilot_cli %} diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md index 00658c285f8e..53ad952b4fe3 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md +++ b/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md @@ -30,6 +30,6 @@ For billing information, see "[AUTOTITLE](/billing/managing-billing-for-github-c ## Next steps -- Configure policies for {% data variables.product.prodname_copilot_short %} in your enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise)." -- Enable {% data variables.product.prodname_copilot_short %} for organizations in your enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise)." -- When {% data variables.product.prodname_copilot_short %} is enabled for an organization, owners of the organization can grant access to some or all members of the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)." +* Configure policies for {% data variables.product.prodname_copilot_short %} in your enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise)." +* Enable {% data variables.product.prodname_copilot_short %} for organizations in your enterprise. See "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise)." +* When {% data variables.product.prodname_copilot_short %} is enabled for an organization, owners of the organization can grant access to some or all members of the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)." diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-content-exclusions-for-github-copilot.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-content-exclusions-for-github-copilot.md index eb657cf4c969..f3952d7cd740 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-content-exclusions-for-github-copilot.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-content-exclusions-for-github-copilot.md @@ -28,8 +28,8 @@ You may want to prevent certain files from being available to {% data variables. When you specify content exclusions it has two effects: -- The content of the affected files will not be used by {% data variables.product.prodname_copilot %} to inform the code completion suggestions it makes in other files. -- {% data variables.product.prodname_copilot %} code completion will not be available in the affected files. +* The content of the affected files will not be used by {% data variables.product.prodname_copilot %} to inform the code completion suggestions it makes in other files. +* {% data variables.product.prodname_copilot %} code completion will not be available in the affected files. {% data reusables.copilot.content-exclusions-delay %} For more information, see "[Propagating content exclusion changes to your IDE](#propagating-content-exclusion-changes-to-your-ide)." @@ -165,9 +165,9 @@ You can use your organization settings to specify content, in any repository, th {% note %} **Notes**: - - The `user@` and `:port` parts of the `REPOSITORY-REFERENCE` are ignored in the calculation of which paths to ignore for a repository. - - Each repository reference can contain a single `*` wildcard. For example, `https://github.com/octo-org/*` matches all repositories in the `octo-org` organization. - - There is additional support for Azure DevOps URLs. For more information, see "[Azure DevOps `REPOSITORY-REFERENCE` support](#azure-devops-repository-reference-support)." + * The `user@` and `:port` parts of the `REPOSITORY-REFERENCE` are ignored in the calculation of which paths to ignore for a repository. + * Each repository reference can contain a single `*` wildcard. For example, `https://github.com/octo-org/*` matches all repositories in the `octo-org` organization. + * There is additional support for Azure DevOps URLs. For more information, see "[Azure DevOps `REPOSITORY-REFERENCE` support](#azure-devops-repository-reference-support)." {% endnote %} @@ -302,5 +302,5 @@ Both the new (dev.azure.com) and old (visualstudio.com) formats for Azure DevOps ## Further reading -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business)" -- "[AUTOTITLE](/enterprise-cloud@latest/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot#github-copilot-content-exclusions-are-not-being-applied)" +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business)" +* "[AUTOTITLE](/enterprise-cloud@latest/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot#github-copilot-content-exclusions-are-not-being-applied)" diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md index f39936256e91..05d3599e0058 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md @@ -54,18 +54,18 @@ Billing for {% data variables.product.prodname_copilot %} starts when you grant 1. In the left sidebar, click **Access**. 1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," to enable {% data variables.product.prodname_copilot %} for selected teams or users in your organization, select **Enabled For: Selected members**. 1. If you are updating user access from the **Enabled For: All members of the organization** setting, in the "Confirm policy update" dialog, select how you want to start assigning access. - - To unassign all members and then select those who should have access, select **Start from scratch**. - - To keep all members who currently have access and then select those who should not have access, select **Renew seats**. + * To unassign all members and then select those who should have access, select **Start from scratch**. + * To keep all members who currently have access and then select those who should not have access, select **Renew seats**. 1. Click **Assign {% data variables.product.prodname_copilot_short %} seats**. 1. In the "Enable Copilot access for users and teams" dialog, click one of the two tabs. ![Screenshot of the "enable access for selected members" dialog.](/assets/images/help/copilot/enable-access-for-selected-members.png) - - Click **Users and teams** to search for and add individual users or teams. + * Click **Users and teams** to search for and add individual users or teams. To search for a user, type their username or full name in the search bar. If you select a user who is not currently a member of your organization, they will be invited to join your organization when you click **Continue to purchase** followed by **Purchase seats**. - - Click **Upload CSV** to add users in bulk by uploading a CSV file. + * Click **Upload CSV** to add users in bulk by uploading a CSV file. To add members in bulk, click **Choose CSV to upload**, and then upload a CSV file including either the username or email address for each member you want to add, separated by a comma. The file can contain a mixture of usernames and email addresses. @@ -85,7 +85,7 @@ You can use {% data variables.product.prodname_dotcom %}'s REST API to grant acc ## Further reading -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)" -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization)" -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)" +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)" +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization)" +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)" diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases.md index d7fa55222fd2..a6528bb5a257 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases.md @@ -53,11 +53,11 @@ Knowledge bases you create will be accessible by all organization members with a 1. Optionally, you can define which paths within the selected repositories to index. - - Click **Edit file paths**. + * Click **Edit file paths**. ![Screenshot of the list of selected repositories. The "Edit file paths" link is highlighted with a dark orange outline.](/assets/images/help/copilot/copilot-select-paths-button.png) - - List the paths you want to include in the knowledge base, one path per line. When you're finished, click **Apply**. + * List the paths you want to include in the knowledge base, one path per line. When you're finished, click **Apply**. 1. Click **Create knowledge base**. diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization.md index 72af063de453..36ff82d733f7 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization.md @@ -20,11 +20,11 @@ shortTitle: Managing policies Organization owners can set policies to govern how {% data variables.product.prodname_copilot %} can be used within the organization. For example, an organization owner can enable or disable the following {% data variables.product.prodname_copilot_short %} features{% ifversion ghec %} (unless an enterprise owner has blocked access to these features at the enterprise level){% endif %}: {% ifversion ghec %} -- {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} (if your organization has a {% data variables.product.prodname_copilot_enterprise_short %} subscription){% endif %} -- {% data variables.product.prodname_copilot_chat_short %} in the IDE -- {% data variables.product.prodname_copilot_mobile_short %} -- {% data variables.product.prodname_copilot_cli_short %} -- Suggestions matching public code +* {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} (if your organization has a {% data variables.product.prodname_copilot_enterprise_short %} subscription){% endif %} +* {% data variables.product.prodname_copilot_chat_short %} in the IDE +* {% data variables.product.prodname_copilot_mobile_short %} +* {% data variables.product.prodname_copilot_cli_short %} +* Suggestions matching public code The policy settings selected by an organization owner determine the behavior of {% data variables.product.prodname_copilot %} for all organization members that have been granted access to {% data variables.product.prodname_copilot_short %} through the organization. @@ -61,6 +61,6 @@ If an organization member is assigned a seat by multiple organizations with diff ## Further reading -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) -- "[AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions)"{% ifversion ghec %} -- "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)"{% endif %} +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +* "[AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions)"{% ifversion ghec %} +* "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)"{% endif %} diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md index a698d64afed2..40ace6e580b8 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md @@ -19,8 +19,8 @@ topics: You can use the audit logs for {% data variables.product.prodname_copilot_business_short %} to review actions taken by users in your organization{% ifversion ghec %} or enterprise{% endif %}, such as: -- Changes to {% data variables.product.prodname_copilot_short %} settings and policies -- The addition or removal of seats from your {% data variables.product.prodname_copilot_business_short %} subscription +* Changes to {% data variables.product.prodname_copilot_short %} settings and policies +* The addition or removal of seats from your {% data variables.product.prodname_copilot_business_short %} subscription The audit log lists events related to your {% data variables.product.prodname_copilot_business_short %} subscription for the last 180 days. @@ -44,13 +44,13 @@ The audit log lists events related to your {% data variables.product.prodname_co You can search for any of the {% data variables.product.prodname_copilot %} audit log events using the `action` qualifier and the `copilot` category. Some example searches that use this syntax are: -- `action:copilot`: Returns all {% data variables.product.prodname_copilot %} audit log events for your organization{% ifversion ghec %} or enterprise{% endif %}. -- `action:copilot.cfb_seat_assignment_created`: Returns all audit log events related to a {% data variables.product.prodname_copilot_business_short %} seat being assigned to a new user. +* `action:copilot`: Returns all {% data variables.product.prodname_copilot %} audit log events for your organization{% ifversion ghec %} or enterprise{% endif %}. +* `action:copilot.cfb_seat_assignment_created`: Returns all audit log events related to a {% data variables.product.prodname_copilot_business_short %} seat being assigned to a new user. For a full list of {% data variables.product.prodname_copilot %} audit log events, see{% ifversion ghec %} "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#copilot)" and{% endif %} "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization#copilot)." ## Further reading {% ifversion ghec %} -- "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise)"{% endif %} -- "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)" +* "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise)"{% endif %} +* "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)" diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md index e4dd23960f16..4a485d3b4b3e 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization.md @@ -38,7 +38,7 @@ You can use {% data variables.product.prodname_dotcom %}'s REST API to get detai ## Further reading {% ifversion ghec%} -- "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/viewing-copilot-usage-for-your-enterprise)"{% endif %} -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)" +* "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/viewing-copilot-usage-for-your-enterprise)"{% endif %} +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)" diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md index 7b767e7c5d7e..d5c130845f9e 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md @@ -28,7 +28,7 @@ Removing a user from the organization(s) that had granted them {% data variables {% data reusables.copilot.access-settings %} 1. Under {% ifversion ghec %}"{% data variables.product.prodname_copilot_enterprise_short %} is active in your organization" or {% endif %}"{% data variables.product.prodname_copilot_business_short %} is active in your organization," select **Enabled For: selected members**. - - In the "Confirm policy update" dialog, click **Renew seats**. + * In the "Confirm policy update" dialog, click **Renew seats**. 1. Under "Access management," in the search bar, type the member's username or full name. 1. To remove the member from the list of users who have access to {% data variables.product.prodname_copilot %}, select the checkbox to the left of their username, then click **Cancel seat**. @@ -43,6 +43,6 @@ You can use {% data variables.product.prodname_dotcom %}'s REST API to revoke ac ## Further reading -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." -- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization)" +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center) +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." +* "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization)" diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization.md index 66eb0d6a30bb..6d9016d5ca29 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization.md @@ -20,6 +20,6 @@ redirect_from: ## Next steps -- Configure policies for {% data variables.product.prodname_copilot_short %} in your organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." -- Grant {% data variables.product.prodname_copilot_short %} access to some or all members of the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)." -- For billing information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise)" and "[AUTOTITLE](/billing/managing-your-github-billing-settings)." +* Configure policies for {% data variables.product.prodname_copilot_short %} in your organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." +* Grant {% data variables.product.prodname_copilot_short %} access to some or all members of the organization. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-access-for-copilot-business-in-your-organization)." +* For billing information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise)" and "[AUTOTITLE](/billing/managing-your-github-billing-settings)." diff --git a/content/copilot/quickstart.md b/content/copilot/quickstart.md index 632c2afbd95d..152c68bda25f 100644 --- a/content/copilot/quickstart.md +++ b/content/copilot/quickstart.md @@ -115,7 +115,7 @@ The following example uses JavaScript, however other languages will work similar ## Next steps {% data reusables.copilot.quickstart-nextsteps1 %} -- **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. For more information, see "[Best practices for using {% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/prompt-crafting)" in the {% data variables.product.prodname_vscode %} documentation. +* **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. For more information, see "[Best practices for using {% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/prompt-crafting)" in the {% data variables.product.prodname_vscode %} documentation. {% data reusables.copilot.quickstart-nextsteps2 %} {% endvscode %} @@ -133,7 +133,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe ## Prerequisites {% ifversion ghec %} -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} {% endif %} {% data reusables.copilot.visual-studio-prerequisites %} @@ -165,7 +165,7 @@ The following example uses JavaScript, however other languages will work similar ## Next steps {% data reusables.copilot.quickstart-nextsteps1 %} -- **Prompt like a pro** - Watch "[{% data variables.product.prodname_vs %} Prompt Engineering with {% data variables.product.prodname_copilot %}](https://www.youtube.com/watch?v=9hZsOeIINg8&list=PLReL099Y5nRckZDdcQ21UigO9pKa14yxC)" on YouTube. +* **Prompt like a pro** - Watch "[{% data variables.product.prodname_vs %} Prompt Engineering with {% data variables.product.prodname_copilot %}](https://www.youtube.com/watch?v=9hZsOeIINg8&list=PLReL099Y5nRckZDdcQ21UigO9pKa14yxC)" on YouTube. {% data reusables.copilot.quickstart-nextsteps2 %} {% endvisualstudio %} @@ -183,9 +183,9 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe ## Prerequisites {% ifversion ghec %} -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} {% endif %} -- **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=jetbrains)." +* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=jetbrains)." {% data reusables.copilot.jetbrains-plugin-prerequisites %} ## Chat with {% data variables.product.prodname_copilot %} diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md index 23e94a2bb6dd..bb556f8b2165 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md @@ -58,4 +58,4 @@ This is a known issue and our team is working towards a fix. For more informatio ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/other-site-policies/github-and-trade-controls)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/other-site-policies/github-and-trade-controls)" diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md index 42f125555dba..d46e0fadeff0 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md @@ -32,6 +32,6 @@ Additional domains and URLs may require allowlisting, depending on your organiza ## Further reading -- [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network) -- [Install and use Visual Studio and Azure Services behind a firewall or proxy server](https://learn.microsoft.com/en-us/visualstudio/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server) -- "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)" +* [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network) +* [Install and use Visual Studio and Azure Services behind a firewall or proxy server](https://learn.microsoft.com/en-us/visualstudio/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server) +* "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)" diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md index 9295dc5da0e6..08c72b39ce7d 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md @@ -49,22 +49,22 @@ If you know you are connecting via a proxy, make sure the proxy is configured co {% data variables.product.prodname_copilot %} uses custom code to connect to proxies. This means a proxy setup supported by your editor is not necessarily supported by {% data variables.product.prodname_copilot %}. Some common causes for errors related to proxies are: -- If your proxy's URL starts `https://`, it is not currently supported by {% data variables.product.prodname_copilot %}. -- You may need to authenticate to the proxy. {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If you are using Kerberos, ensure you have a valid ticket for the proxy service and that you are using the correct service principal name for the service. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#authentication-with-kerberos)." -- {% data variables.product.prodname_copilot %} may reject custom certificates. For more information, see "[Troubleshooting certificate-related errors](#troubleshooting-certificate-related-errors)." +* If your proxy's URL starts `https://`, it is not currently supported by {% data variables.product.prodname_copilot %}. +* You may need to authenticate to the proxy. {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If you are using Kerberos, ensure you have a valid ticket for the proxy service and that you are using the correct service principal name for the service. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#authentication-with-kerberos)." +* {% data variables.product.prodname_copilot %} may reject custom certificates. For more information, see "[Troubleshooting certificate-related errors](#troubleshooting-certificate-related-errors)." ## Troubleshooting certificate-related errors Depending on your proxy setup, you may encounter errors like "certificate signature failure," "custom certificate," or "unable to verify the first certificate." These errors are usually caused by a corporate proxy setup that uses custom certificates to intercept and inspect secure connections. Some possible ways to resolve certificate-related errors are: -- Configure a different proxy that does not intercept secure connections. -- If you are using a corporate proxy, contact your IT department to see if they can configure the proxy to not intercept secure connections. -- Ensure the custom certificates are properly installed in your operating system's trust store. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#allowing-github-copilot-to-use-custom-certificates)." If the certificates are installed on your machine but {% data variables.product.prodname_copilot %} isn't detecting them, it may help you to know the mechanisms that {% data variables.product.prodname_copilot %} uses to find certificates. - - On Windows, {% data variables.product.prodname_copilot_short %} uses the [win-ca package](https://www.npmjs.com/package/win-ca). - - On macOS, {% data variables.product.prodname_copilot_short %} uses the [mac-ca package](https://www.npmjs.com/package/mac-ca). - - On Linux, {% data variables.product.prodname_copilot_short %} checks the standard OpenSSL files `/etc/ssl/certs/ca-certificates.crt` and `/etc/ssl/certs/ca-bundle.crt`. -- Configure {% data variables.product.prodname_copilot %} to ignore certificate errors. In your proxy settings, you can deselect **Proxy Strict SSL** in {% data variables.product.prodname_vscode %}, or select **Accept non-trusted certificates automatically** in a JetBrains IDE. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#configuring-proxy-settings-for-github-copilot)." +* Configure a different proxy that does not intercept secure connections. +* If you are using a corporate proxy, contact your IT department to see if they can configure the proxy to not intercept secure connections. +* Ensure the custom certificates are properly installed in your operating system's trust store. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#allowing-github-copilot-to-use-custom-certificates)." If the certificates are installed on your machine but {% data variables.product.prodname_copilot %} isn't detecting them, it may help you to know the mechanisms that {% data variables.product.prodname_copilot %} uses to find certificates. + * On Windows, {% data variables.product.prodname_copilot_short %} uses the [win-ca package](https://www.npmjs.com/package/win-ca). + * On macOS, {% data variables.product.prodname_copilot_short %} uses the [mac-ca package](https://www.npmjs.com/package/mac-ca). + * On Linux, {% data variables.product.prodname_copilot_short %} checks the standard OpenSSL files `/etc/ssl/certs/ca-certificates.crt` and `/etc/ssl/certs/ca-bundle.crt`. +* Configure {% data variables.product.prodname_copilot %} to ignore certificate errors. In your proxy settings, you can deselect **Proxy Strict SSL** in {% data variables.product.prodname_vscode %}, or select **Accept non-trusted certificates automatically** in a JetBrains IDE. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#configuring-proxy-settings-for-github-copilot)." {% warning %} diff --git a/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md b/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md index 580f14edfe3f..0d444c17cfee 100644 --- a/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md +++ b/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md @@ -25,13 +25,13 @@ The location of the log files depends on the JetBrains IDE you are using. For mo These steps describe how to view and collect the log files for the following JetBrains IDEs: -- IntelliJ IDEA -- Android Studio -- GoLand -- PhpStorm -- PyCharm -- RubyMine -- WebStorm +* IntelliJ IDEA +* Android Studio +* GoLand +* PhpStorm +* PyCharm +* RubyMine +* WebStorm The {% data variables.product.prodname_copilot%} extension logs to the IDEA log location for IntelliJ plugins. 1. In your JetBrains IDE, open the **Help** menu. @@ -93,7 +93,7 @@ The log files for the {% data variables.product.prodname_copilot%} extension are ## Further reading -- "[Log all activity to the log file for troubleshooting](https://learn.microsoft.com/en-us/visualstudio/ide/reference/log-devenv-exe?view=vs-2022)" in the {% data variables.product.prodname_vs %} documentation +* "[Log all activity to the log file for troubleshooting](https://learn.microsoft.com/en-us/visualstudio/ide/reference/log-devenv-exe?view=vs-2022)" in the {% data variables.product.prodname_vs %} documentation {% endvisualstudio %} @@ -109,10 +109,10 @@ The log files for the {% data variables.product.prodname_copilot%} extension are Alternatively, you can open the log folder for {% data variables.product.prodname_vscode %} extensions in your system's file explorer. This is useful if you need to forward the log files to the support team. 1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} - - For Mac: - - Use: Shift+Command+P - - For Windows or Linux: - - Use: Ctrl+Shift+P + * For Mac: + * Use: Shift+Command+P + * For Windows or Linux: + * Use: Ctrl+Shift+P 1. Type "Logs", and then select **Developer: Open Extension Logs Folder** from the list. ## Viewing network connectivity diagnostics logs @@ -120,10 +120,10 @@ Alternatively, you can open the log folder for {% data variables.product.prodnam If you encounter problems connecting to {% data variables.product.prodname_copilot%} due to network restrictions, firewalls, or your proxy setup, use the following troubleshooting steps. 1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} - - For Mac: - - Use: Shift+Command+P - - For Windows or Linux: - - Use: Ctrl+Shift+P + * For Mac: + * Use: Shift+Command+P + * For Windows or Linux: + * Use: Ctrl+Shift+P 1. Type "Diagnostics", and then select **{% data variables.product.prodname_copilot%}: Collect Diagnostics** from the list. This opens a new editor with the relevant information that you can inspect yourself or share with the support team. 1. Check the section on **Reachability** to determine if {% data variables.product.prodname_copilot%} can actually access the necessary services. @@ -132,10 +132,10 @@ If you encounter problems connecting to {% data variables.product.prodname_copil In rare cases, errors might not be propagated to the corresponding error handlers and are not logged in the regular locations. If you encounter errors and there is nothing in the logs, you may try to see the logs from the process running {% data variables.product.prodname_vscode_shortname %} and the extension. 1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} - - For Mac: - - Use: Shift+Command+P - - For Windows or Linux: - - Use Ctrl+Shift+P + * For Mac: + * Use: Shift+Command+P + * For Windows or Linux: + * Use Ctrl+Shift+P 1. Type "Toggle", and then select **Developer: Toggle Developer Tools** from the list. 1. In the Developer Tools window, select the **Console** tab to see any errors or warnings. @@ -143,8 +143,8 @@ In rare cases, errors might not be propagated to the corresponding error handler ## Further reading -- "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot)" -- "[Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network)" in the {% data variables.product.prodname_vscode %} documentation +* "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot)" +* "[Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network)" in the {% data variables.product.prodname_vscode %} documentation {% endvscode %} diff --git a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md b/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md index 2ac8be478cd0..8c0348da5826 100644 --- a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md +++ b/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md @@ -30,9 +30,9 @@ The linked web page includes details of any license identified for the repositor **Notes**: -- Code referencing does not currently apply to code completion suggestions that you add to your code using {% data variables.product.prodname_copilot_chat %}. -- Code referencing currently only looks for matches of accepted {% data variables.product.prodname_copilot_short %} suggestions. Matches to code you have written, or {% data variables.product.prodname_copilot_short %} suggestions you have altered, is not checked for matches to public code. -- Typically, matches to public code occur in less than one percent of {% data variables.product.prodname_copilot_short %} suggestions, so you should not expect to see code references for many of the suggestions you accept. +* Code referencing does not currently apply to code completion suggestions that you add to your code using {% data variables.product.prodname_copilot_chat %}. +* Code referencing currently only looks for matches of accepted {% data variables.product.prodname_copilot_short %} suggestions. Matches to code you have written, or {% data variables.product.prodname_copilot_short %} suggestions you have altered, is not checked for matches to public code. +* Typically, matches to public code occur in less than one percent of {% data variables.product.prodname_copilot_short %} suggestions, so you should not expect to see code references for many of the suggestions you accept. {% endnote %} @@ -57,12 +57,12 @@ You can access code references from one of the {% data variables.product.prodnam The log entry includes the following details: - - The date and time you accepted the suggestion. - - The name of the file in which the suggestion was added. - - A message telling you that similar code was found, with the number and type of licenses. - - A link to a page on {% data variables.product.prodname_dotcom_the_website %}. - - The location in the file where the suggestion was added. - - A snippet of part of the code that was suggested and added. + * The date and time you accepted the suggestion. + * The name of the file in which the suggestion was added. + * A message telling you that similar code was found, with the number and type of licenses. + * A link to a page on {% data variables.product.prodname_dotcom_the_website %}. + * The location in the file where the suggestion was added. + * A snippet of part of the code that was suggested and added. ![Screenshot of the Output window showing a code referencing log entry.](/assets/images/help/copilot/copilot-code-referencing-log.png) diff --git a/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md b/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md index 606791a04a0d..ccac6ed9747e 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md +++ b/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md @@ -32,9 +32,9 @@ The examples in this guide use Java, however other languages will work similarly ## Prerequisites -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -- **Compatible JetBrains IDE**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have a compatible JetBrains IDE installed. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: +* **Compatible JetBrains IDE**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have a compatible JetBrains IDE installed. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: {% data reusables.copilot.jetbrains-compatible-ides %} @@ -134,7 +134,7 @@ The examples in this guide use C#, however other languages will work similarly. ## Prerequisites -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} {% data reusables.copilot.visual-studio-prerequisites %} @@ -194,11 +194,11 @@ The examples in this guide use JavaScript, however other languages will work sim ## Prerequisites -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -- **{% data variables.product.prodname_vscode %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have {% data variables.product.prodname_vscode %} installed. For more information, see the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download). +* **{% data variables.product.prodname_vscode %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have {% data variables.product.prodname_vscode %} installed. For more information, see the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download). -- **{% data variables.product.prodname_copilot_short %} extension for {% data variables.product.prodname_vscode %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must install the [{% data variables.product.prodname_copilot %} extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). For more information, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the {% data variables.product.prodname_vscode %} documentation. +* **{% data variables.product.prodname_copilot_short %} extension for {% data variables.product.prodname_vscode %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must install the [{% data variables.product.prodname_copilot %} extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). For more information, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the {% data variables.product.prodname_vscode %} documentation. ## Getting code suggestions @@ -293,11 +293,11 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro ## Prerequisites -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -- **Compatible version of Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above installed. For more information, see the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). +* **Compatible version of Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above installed. For more information, see the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). -- **{% data variables.product.prodname_copilot %} extension for Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." +* **{% data variables.product.prodname_copilot %} extension for Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." ## Learning to use {% data variables.product.prodname_copilot %} in Vim/Neovim @@ -319,11 +319,11 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro ## Prerequisites -- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -- **Compatible version of Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. For more information, see the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation. +* **Compatible version of Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. For more information, see the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation. -- **{% data variables.product.prodname_copilot %} extension for Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must install the {% data variables.product.prodname_copilot %} extension. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." +* **{% data variables.product.prodname_copilot %} extension for Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must install the {% data variables.product.prodname_copilot %} extension. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." ## Getting code suggestions @@ -409,7 +409,7 @@ If you want to accept the next line of the suggestion, you will need to set a cu ## Next steps -- **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment)." -- **Get started with {% data variables.product.prodname_copilot_chat %}** - Learn how to ask {% data variables.product.prodname_copilot_short %} for information and assistance, using {% data variables.product.prodname_copilot_chat %}. See "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% endif %}. -- **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. See "[How to use GitHub Copilot: Prompts, tips, and use cases](https://github.blog/2023-06-20-how-to-write-better-prompts-for-github-copilot/)" in {% data variables.product.prodname_blog %}. -- **Troubleshoot issues** - Learn more about how to troubleshoot common issues with {% data variables.product.prodname_copilot %}. See "[AUTOTITLE](/copilot/troubleshooting-github-copilot)." +* **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment)." +* **Get started with {% data variables.product.prodname_copilot_chat %}** - Learn how to ask {% data variables.product.prodname_copilot_short %} for information and assistance, using {% data variables.product.prodname_copilot_chat %}. See "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% endif %}. +* **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. See "[How to use GitHub Copilot: Prompts, tips, and use cases](https://github.blog/2023-06-20-how-to-write-better-prompts-for-github-copilot/)" in {% data variables.product.prodname_blog %}. +* **Troubleshoot issues** - Learn more about how to troubleshoot common issues with {% data variables.product.prodname_copilot %}. See "[AUTOTITLE](/copilot/troubleshooting-github-copilot)." diff --git a/content/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md b/content/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md index 3f901b6bc26b..ad3006fe205c 100644 --- a/content/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md +++ b/content/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md @@ -54,4 +54,4 @@ You can create an alias for a local repository to help differentiate between rep ## Further reading -- [About remote repositories](/get-started/getting-started-with-git/about-remote-repositories) +* [About remote repositories](/get-started/getting-started-with-git/about-remote-repositories) diff --git a/content/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md b/content/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md index b720a717f0c7..01cf8f6c08ca 100644 --- a/content/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md +++ b/content/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop.md @@ -17,5 +17,5 @@ After you configure {% data variables.large_files.product_name_short %} to track ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files)" -- "[AUTOTITLE](/repositories/working-with-files/managing-large-files)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files)" +* "[AUTOTITLE](/repositories/working-with-files/managing-large-files)" diff --git a/content/desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md b/content/desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md index 2a3fbe361f86..0a477f994003 100644 --- a/content/desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md +++ b/content/desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md @@ -16,62 +16,62 @@ shortTitle: Configure default editor {% mac %} -- [MacVim](https://macvim-dev.github.io/macvim/) -- [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) -- [Visual Studio Codium](https://vscodium.com/) -- [Sublime Text](https://www.sublimetext.com/) -- [BBEdit](http://www.barebones.com/products/bbedit/) -- [JetBrains WebStorm](https://www.jetbrains.com/webstorm/) -- [JetBrains PhpStorm](https://www.jetbrains.com/phpstorm/) -- [JetBrains Rider](https://www.jetbrains.com/rider/) -- [JetBrains PyCharm](https://www.jetbrains.com/pycharm/) -- [JetBrains RubyMine](https://www.jetbrains.com/rubymine/) -- [JetBrains IntelliJ IDEA](https://www.jetbrains.com/idea/) -- [JetBrains GoLand](https://www.jetbrains.com/go/) -- [JetBrains Fleet](https://www.jetbrains.com/fleet/) -- [JetBrains DataSpell](https://www.jetbrains.com/dataspell/) -- [TextMate](https://macromates.com/) -- [Brackets](http://brackets.io/) - - To use Brackets with {% data variables.product.prodname_desktop %}, you must install the Command Line shortcut. To install the shortcut, open Brackets, click **File** in the menu bar, then click **Install Command Line Shortcut**. -- [Typora](https://typora.io/) -- [CodeRunner](https://coderunnerapp.com/) -- [SlickEdit](https://www.slickedit.com/) -- [Xcode](https://developer.apple.com/xcode/) -- [RStudio](https://rstudio.com/) -- [Nova](https://nova.app/) -- [Android Studio](https://developer.android.com/studio) -- [Aptana Studio](http://www.aptana.com/) -- [Neovide](https://neovide.dev/) -- [Emacs](https://www.gnu.org/software/emacs/) -- [Lite XL](https://lite-xl.com/) -- [Pulsar](https://pulsar-edit.dev/) -- [Zed](https://zed.dev/) +* [MacVim](https://macvim-dev.github.io/macvim/) +* [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) +* [Visual Studio Codium](https://vscodium.com/) +* [Sublime Text](https://www.sublimetext.com/) +* [BBEdit](http://www.barebones.com/products/bbedit/) +* [JetBrains WebStorm](https://www.jetbrains.com/webstorm/) +* [JetBrains PhpStorm](https://www.jetbrains.com/phpstorm/) +* [JetBrains Rider](https://www.jetbrains.com/rider/) +* [JetBrains PyCharm](https://www.jetbrains.com/pycharm/) +* [JetBrains RubyMine](https://www.jetbrains.com/rubymine/) +* [JetBrains IntelliJ IDEA](https://www.jetbrains.com/idea/) +* [JetBrains GoLand](https://www.jetbrains.com/go/) +* [JetBrains Fleet](https://www.jetbrains.com/fleet/) +* [JetBrains DataSpell](https://www.jetbrains.com/dataspell/) +* [TextMate](https://macromates.com/) +* [Brackets](http://brackets.io/) + * To use Brackets with {% data variables.product.prodname_desktop %}, you must install the Command Line shortcut. To install the shortcut, open Brackets, click **File** in the menu bar, then click **Install Command Line Shortcut**. +* [Typora](https://typora.io/) +* [CodeRunner](https://coderunnerapp.com/) +* [SlickEdit](https://www.slickedit.com/) +* [Xcode](https://developer.apple.com/xcode/) +* [RStudio](https://rstudio.com/) +* [Nova](https://nova.app/) +* [Android Studio](https://developer.android.com/studio) +* [Aptana Studio](http://www.aptana.com/) +* [Neovide](https://neovide.dev/) +* [Emacs](https://www.gnu.org/software/emacs/) +* [Lite XL](https://lite-xl.com/) +* [Pulsar](https://pulsar-edit.dev/) +* [Zed](https://zed.dev/) {% endmac %} {% windows %} -- [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) -- [Visual Studio Codium](https://vscodium.com/) -- [Sublime Text](https://www.sublimetext.com/) -- [ColdFusion Builder](https://www.adobe.com/products/coldfusion-builder.html) -- [Typora](https://typora.io/) -- [SlickEdit](https://www.slickedit.com/) -- [JetBrains IntelliJ Idea](https://www.jetbrains.com/idea/) -- [JetBrains WebStorm](https://www.jetbrains.com/webstorm/) -- [JetBrains PhpStorm](https://www.jetbrains.com/phpstorm/) -- [JetBrains Rider](https://www.jetbrains.com/rider/) -- [JetBrains CLion](https://www.jetbrains.com/clion/) -- [JetBrains PyCharm](https://www.jetbrains.com/pycharm/) -- [JetBrains RubyMine](https://www.jetbrains.com/rubymine/) -- [JetBrains GoLand](https://www.jetbrains.com/go/) -- [JetBrains Fleet](https://www.jetbrains.com/fleet/) -- [JetBrains DataSpell](https://www.jetbrains.com/dataspell/) -- [Android Studio](https://developer.android.com/studio) -- [Brackets](http://brackets.io/) -- [Notepad++](https://notepad-plus-plus.org/) -- [RStudio](https://rstudio.com/) -- [Aptana Studio](http://www.aptana.com/) +* [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) +* [Visual Studio Codium](https://vscodium.com/) +* [Sublime Text](https://www.sublimetext.com/) +* [ColdFusion Builder](https://www.adobe.com/products/coldfusion-builder.html) +* [Typora](https://typora.io/) +* [SlickEdit](https://www.slickedit.com/) +* [JetBrains IntelliJ Idea](https://www.jetbrains.com/idea/) +* [JetBrains WebStorm](https://www.jetbrains.com/webstorm/) +* [JetBrains PhpStorm](https://www.jetbrains.com/phpstorm/) +* [JetBrains Rider](https://www.jetbrains.com/rider/) +* [JetBrains CLion](https://www.jetbrains.com/clion/) +* [JetBrains PyCharm](https://www.jetbrains.com/pycharm/) +* [JetBrains RubyMine](https://www.jetbrains.com/rubymine/) +* [JetBrains GoLand](https://www.jetbrains.com/go/) +* [JetBrains Fleet](https://www.jetbrains.com/fleet/) +* [JetBrains DataSpell](https://www.jetbrains.com/dataspell/) +* [Android Studio](https://developer.android.com/studio) +* [Brackets](http://brackets.io/) +* [Notepad++](https://notepad-plus-plus.org/) +* [RStudio](https://rstudio.com/) +* [Aptana Studio](http://www.aptana.com/) {% endwindows %} diff --git a/content/desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md b/content/desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md index 8c1db78d4bc1..df501be5150c 100644 --- a/content/desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md +++ b/content/desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md @@ -34,4 +34,4 @@ shortTitle: Configure basic settings ## Further reading -- "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/setting-a-theme-for-github-desktop)" +* "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/setting-a-theme-for-github-desktop)" diff --git a/content/desktop/configuring-and-customizing-github-desktop/configuring-git-for-github-desktop.md b/content/desktop/configuring-and-customizing-github-desktop/configuring-git-for-github-desktop.md index a07ea64ec257..bc39bd3783b0 100644 --- a/content/desktop/configuring-and-customizing-github-desktop/configuring-git-for-github-desktop.md +++ b/content/desktop/configuring-and-customizing-github-desktop/configuring-git-for-github-desktop.md @@ -109,7 +109,7 @@ You can configure the default branch that will be used when you create a new rep ## Further reading -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)" -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- "[AUTOTITLE](/get-started/getting-started-with-git)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" +* "[AUTOTITLE](/get-started/getting-started-with-git)" diff --git a/content/desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github-in-github-desktop.md b/content/desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github-in-github-desktop.md index fe1bded7d3dc..2fff0d23a5a9 100644 --- a/content/desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github-in-github-desktop.md +++ b/content/desktop/installing-and-authenticating-to-github-desktop/about-connections-to-github-in-github-desktop.md @@ -18,4 +18,4 @@ After you authenticate to {% data variables.product.prodname_dotcom %}, you can ## Further reading -- "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop)" +* "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop)" diff --git a/content/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md b/content/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md index 317335d2eaa0..0d54ada44b48 100644 --- a/content/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md +++ b/content/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md @@ -193,4 +193,4 @@ If your Windows username has extended Unicode characters, it may cause an AskPas ## Further reading -- "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)" +* "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)" diff --git a/content/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md b/content/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md index 175877da6008..9320769641f1 100644 --- a/content/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md +++ b/content/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md @@ -34,14 +34,14 @@ Repository administrators can enable rulesets for a branch to enforce specific c You can change the way diffs are displayed in {% data variables.product.prodname_desktop %} to suit your reviewing needs. To change how you view diffs, in the top-right corner of the diff view, click {% octicon "gear" aria-label="The Gear icon" %}. -- To change how the entire diff is displayed, under "Diff display", select **Unified** or **Split**. The Unified view shows changes linearly, while the Split view shows old content on the left side and new content on the right side. -- To hide whitespace changes so you can focus on more substantive changes, select **Hide Whitespace Changes**. +* To change how the entire diff is displayed, under "Diff display", select **Unified** or **Split**. The Unified view shows changes linearly, while the Split view shows old content on the left side and new content on the right side. +* To hide whitespace changes so you can focus on more substantive changes, select **Hide Whitespace Changes**. ![Screenshot of the diff view of a "README" file. A gear icon is outlined in orange above an expanded dropdown displaying "Whitespace" and "Diff display" settings.](/assets/images/help/desktop/diff-selection.png) If you need to see more of the file than {% data variables.product.prodname_desktop %} shows by default, you can expand the diff. -- To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers. -- To see the entire file, right-click in the diff view and click **Expand Whole File**. +* To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers. +* To see the entire file, right-click in the diff view and click **Expand Whole File**. ![Screenshot of the diff view of a "README" file. Over a green "addition" line, in a context menu, the cursor hovers over "Expand Whole File".](/assets/images/help/desktop/expand-diff-view.png) @@ -51,14 +51,14 @@ As you make changes to files in your text editor and save them locally, you will In the "Changes" tab in the left sidebar: -- The red {% octicon "diff-removed" aria-label="The diff removed icon color-red" %} icon indicates removed files. -- The yellow {% octicon "diff-modified" aria-label="The diff modified icon color-yellow" %} icon indicates modified files. -- The green {% octicon "diff-added" aria-label="The diff added icon color-green" %} icon indicates added files. -- To access stashed changes, click **Stashed Changes**. -- {% data reusables.desktop.commit-all-desc %} +* The red {% octicon "diff-removed" aria-label="The diff removed icon color-red" %} icon indicates removed files. +* The yellow {% octicon "diff-modified" aria-label="The diff modified icon color-yellow" %} icon indicates modified files. +* The green {% octicon "diff-added" aria-label="The diff added icon color-green" %} icon indicates added files. +* To access stashed changes, click **Stashed Changes**. +* {% data reusables.desktop.commit-all-desc %} ![Screenshot of the "Changes" tab. Above the list of changed files, next to the text "3 changed files", a selected checkbox is outlined in orange.](/assets/images/help/desktop/commit-all.png) -- {% data reusables.desktop.commit-some-desc %} +* {% data reusables.desktop.commit-some-desc %} ### Creating a partial commit @@ -118,8 +118,8 @@ Once you're satisfied with the changes you've chosen to include in your commit, ![Screenshot of the "Changes" tab. In the corner of the "Description" field, a "person with a plus sign" icon for adding a co-author is outlined in orange.](/assets/images/help/desktop/add-co-author-commit.png) {% data reusables.desktop.commit-button %} 1. If the branch you're trying to commit to is protected, Desktop will warn you. - - To move your changes, click **switch branches**. - - To commit your changes to the protected branch, click **Commit to BRANCH**. + * To move your changes, click **switch branches**. + * To commit your changes to the protected branch, click **Commit to BRANCH**. For more information about protected branches, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." {% data reusables.desktop.push-origin %} @@ -136,4 +136,4 @@ If you need to undo a commit or revise your commit history (to make it easier fo ## Further reading -- "[AUTOTITLE](/get-started/using-git)" +* "[AUTOTITLE](/get-started/using-git)" diff --git a/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md b/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md index 20e83ee74ea2..416450259a4c 100644 --- a/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md +++ b/content/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md @@ -104,8 +104,8 @@ You can't delete a branch if it's currently associated with an open pull request ## Further reading -- "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop)" -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#branch)" in the {% data variables.product.prodname_dotcom %} glossary -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" -- "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation -- "[AUTOTITLE](/desktop/making-changes-in-a-branch/stashing-changes-in-github-desktop)" +* "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop)" +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#branch)" in the {% data variables.product.prodname_dotcom %} glossary +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)" +* "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation +* "[AUTOTITLE](/desktop/making-changes-in-a-branch/stashing-changes-in-github-desktop)" diff --git a/content/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop.md b/content/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop.md index 20fd3316f777..f7fb03c0ef66 100644 --- a/content/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop.md +++ b/content/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop.md @@ -31,8 +31,8 @@ Repository administrators can also enable rulesets for a branch, which will prev **Note:** {% data variables.product.prodname_desktop %} will reject a push if it exceeds certain limits. -- A push contains a large file over {% data variables.large_files.max_github_size %} in size. -- A push is over {% data variables.large_files.max_file_size %} in total size. +* A push contains a large file over {% data variables.large_files.max_github_size %} in size. +* A push is over {% data variables.large_files.max_file_size %} in total size. If you configure {% data variables.large_files.product_name_long %} to track your large files, you can push large files that would normally be rejected. For more information, see "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop)." @@ -46,6 +46,6 @@ If you configure {% data variables.large_files.product_name_long %} to track you ## Further reading -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#push)" in the {% data variables.product.prodname_dotcom %} glossary -- "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop)" -- "[AUTOTITLE](/get-started/using-git)" +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#push)" in the {% data variables.product.prodname_dotcom %} glossary +* "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop)" +* "[AUTOTITLE](/get-started/using-git)" diff --git a/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md b/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md index 198f70fd39ab..9b97a7d74b4f 100644 --- a/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md +++ b/content/desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md @@ -12,10 +12,10 @@ shortTitle: View branch history --- Each commit shows: -- The commit message -- The time the commit was created -- The committer's username and profile photo (if available) -- The commit's SHA-1 hash (the unique ID) +* The commit message +* The time the commit was created +* The committer's username and profile photo (if available) +* The commit's SHA-1 hash (the unique ID) {% data reusables.desktop.history-tab %} 1. On the **History** tab, click the commit you'd like to review. @@ -40,4 +40,4 @@ Each commit shows: ## Further reading -- "[AUTOTITLE](/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop)" +* "[AUTOTITLE](/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop)" diff --git a/content/desktop/managing-commits/amending-a-commit-in-github-desktop.md b/content/desktop/managing-commits/amending-a-commit-in-github-desktop.md index 74136f34a7f8..f66dd6663be9 100644 --- a/content/desktop/managing-commits/amending-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/amending-a-commit-in-github-desktop.md @@ -28,4 +28,4 @@ If possible, you should only amend a commit that you haven't pushed to the remot ## Further reading -- "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" +* "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" diff --git a/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md b/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md index ac4ecd2e968f..f4bedf3cafc1 100644 --- a/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/checking-out-a-commit-in-github-desktop.md @@ -45,5 +45,5 @@ The `8bd5e736a2 HEAD@{1}: commit: testing out a feature` line is the commit that ## Further reading -- [Detached HEAD](https://git-scm.com/docs/git-checkout#_detached_head) in the Git documentation -- [Git cherry-pick](https://git-scm.com/docs/git-cherry-pick) in the Git documentation +* [Detached HEAD](https://git-scm.com/docs/git-checkout#_detached_head) in the Git documentation +* [Git cherry-pick](https://git-scm.com/docs/git-cherry-pick) in the Git documentation diff --git a/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md b/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md index e910b7b4e6d7..d8b26d625539 100644 --- a/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md @@ -45,5 +45,5 @@ You can also use cherry-picking when collaborating with a team. Some projects in ## Further reading -- [git-cherry-pick](https://git-scm.com/docs/git-cherry-pick) in the Git documentation -- "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" +* [git-cherry-pick](https://git-scm.com/docs/git-cherry-pick) in the Git documentation +* "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" diff --git a/content/desktop/managing-commits/managing-tags-in-github-desktop.md b/content/desktop/managing-commits/managing-tags-in-github-desktop.md index 7ce2a6198a98..bb7d6d2dd544 100644 --- a/content/desktop/managing-commits/managing-tags-in-github-desktop.md +++ b/content/desktop/managing-commits/managing-tags-in-github-desktop.md @@ -52,4 +52,4 @@ versions: ## Further reading -- "[Git Basics - Tagging](https://git-scm.com/book/en/v2/Git-Basics-Tagging)" in the Git documentation +* "[Git Basics - Tagging](https://git-scm.com/book/en/v2/Git-Basics-Tagging)" in the Git documentation diff --git a/content/desktop/managing-commits/options-for-managing-commits-in-github-desktop.md b/content/desktop/managing-commits/options-for-managing-commits-in-github-desktop.md index 4c1392556903..e6199597ddef 100644 --- a/content/desktop/managing-commits/options-for-managing-commits-in-github-desktop.md +++ b/content/desktop/managing-commits/options-for-managing-commits-in-github-desktop.md @@ -10,9 +10,9 @@ versions: When you're contributing changes to a repository, your commit history should tell an easy-to-follow story about how you arrived at the changes you've made. To help people review your work, and to make it easier for people to find when and why changes were introduced to a repository, we recommend you follow certain best practices, such as: -- Organizing your commits into a sequential, easy-to-follow order -- Writing clear commit messages that include your intent and any necessary context -- Making small commits that contain related changes +* Organizing your commits into a sequential, easy-to-follow order +* Writing clear commit messages that include your intent and any necessary context +* Making small commits that contain related changes Often, it is difficult to follow these best practices perfectly at the point where you're making changes. You might realize you need to undo the changes in a commit you've made, edit a commit message, or reorder your commits to tell a clearer story. With {% data variables.product.prodname_desktop %}, you can manage your commit history directly from the user interface. diff --git a/content/desktop/managing-commits/reordering-commits-in-github-desktop.md b/content/desktop/managing-commits/reordering-commits-in-github-desktop.md index 2d0653611558..00331d3f0331 100644 --- a/content/desktop/managing-commits/reordering-commits-in-github-desktop.md +++ b/content/desktop/managing-commits/reordering-commits-in-github-desktop.md @@ -31,10 +31,10 @@ While the application reorders the commits, a **Reorder in process** dialog indi When you reorder commits, you may see one of the following notifications or error messages. -- A notification states that the requested change to the branch will require a force push to update the remote branch. This is shown when the commits that you reordered were previously pushed to the remote branch. Force pushing alters the commit history of the branch and will affect other collaborators who are working in that branch. Select **Begin reorder** to start the reorder, and then click **Force push origin** to push your changes. -- An error states that the reorder failed because there is a merge commit among the reordered commits. -- A notification is shown indicating that there are uncommitted changes present on your current branch. Select **Stash Changes and Continue** to store the changes and proceed, or select **Close** to dismiss the message and commit the changes. When there are no longer any uncommitted changes, you can reorder your commits. -- A message states that there are merge conflicts that you must resolve before the application can continue reordering commits on your branch. +* A notification states that the requested change to the branch will require a force push to update the remote branch. This is shown when the commits that you reordered were previously pushed to the remote branch. Force pushing alters the commit history of the branch and will affect other collaborators who are working in that branch. Select **Begin reorder** to start the reorder, and then click **Force push origin** to push your changes. +* An error states that the reorder failed because there is a merge commit among the reordered commits. +* A notification is shown indicating that there are uncommitted changes present on your current branch. Select **Stash Changes and Continue** to store the changes and proceed, or select **Close** to dismiss the message and commit the changes. When there are no longer any uncommitted changes, you can reorder your commits. +* A message states that there are merge conflicts that you must resolve before the application can continue reordering commits on your branch. 1. Click **View conflicts**. ![Screenshot of a notification about conflicts. At the end of the message, a link, labeled "View commits", is highlighted with an orange outline.](/assets/images/help/desktop/reorder-resolve-conflicts.png) @@ -44,4 +44,4 @@ When you reorder commits, you may see one of the following notifications or erro ## Further reading -- "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" +* "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" diff --git a/content/desktop/managing-commits/resetting-to-a-commit-in-github-desktop.md b/content/desktop/managing-commits/resetting-to-a-commit-in-github-desktop.md index 7f4e77f84ebf..1e5d7b367b55 100644 --- a/content/desktop/managing-commits/resetting-to-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/resetting-to-a-commit-in-github-desktop.md @@ -21,4 +21,4 @@ If you want to edit your most recent commit message, or combine new changes with ## Further reading -- [Git Tools - Reset Demystified](https://git-scm.com/book/en/v2/Git-Tools-Reset-Demystified) in the Git documentation +* [Git Tools - Reset Demystified](https://git-scm.com/book/en/v2/Git-Tools-Reset-Demystified) in the Git documentation diff --git a/content/desktop/managing-commits/reverting-a-commit-in-github-desktop.md b/content/desktop/managing-commits/reverting-a-commit-in-github-desktop.md index 9ddb664995de..59c2475cc141 100644 --- a/content/desktop/managing-commits/reverting-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/reverting-a-commit-in-github-desktop.md @@ -23,4 +23,4 @@ When you revert to a previous commit, the revert is also a commit. The original ## Further reading -- "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" +* "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" diff --git a/content/desktop/managing-commits/squashing-commits-in-github-desktop.md b/content/desktop/managing-commits/squashing-commits-in-github-desktop.md index 81a92929087d..ed5145645afa 100644 --- a/content/desktop/managing-commits/squashing-commits-in-github-desktop.md +++ b/content/desktop/managing-commits/squashing-commits-in-github-desktop.md @@ -41,10 +41,10 @@ Squashing allows you to combine multiple commits in your branch's history into a When you squash commits, you may see one of the following notifications or error messages. -- A notification states that the requested change to the branch will require a force push to update the remote branch. Force pushing alters the commit history of the branch and will affect other collaborators who are working in that branch. Select **Begin Squash** to start the squash, and then click **Force push origin** to push your changes. -- An error states that the squash failed because there is a merge commit among the squashed commits. -- A notification is shown indicating that there are uncommitted changes present on your current branch. Select **Stash Changes and Continue** to store the changes and proceed, or select **Close** to dismiss the message and commit the changes. When there are no longer any uncommitted changes you can squash your commits. +* A notification states that the requested change to the branch will require a force push to update the remote branch. Force pushing alters the commit history of the branch and will affect other collaborators who are working in that branch. Select **Begin Squash** to start the squash, and then click **Force push origin** to push your changes. +* An error states that the squash failed because there is a merge commit among the squashed commits. +* A notification is shown indicating that there are uncommitted changes present on your current branch. Select **Stash Changes and Continue** to store the changes and proceed, or select **Close** to dismiss the message and commit the changes. When there are no longer any uncommitted changes you can squash your commits. ## Further reading -- "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" +* "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" diff --git a/content/desktop/managing-commits/undoing-a-commit-in-github-desktop.md b/content/desktop/managing-commits/undoing-a-commit-in-github-desktop.md index e2f25421db32..5d9399ba0dd2 100644 --- a/content/desktop/managing-commits/undoing-a-commit-in-github-desktop.md +++ b/content/desktop/managing-commits/undoing-a-commit-in-github-desktop.md @@ -23,4 +23,4 @@ If you want to edit your most recent commit message, or combine new changes with ## Further reading -- "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" +* "[AUTOTITLE](/desktop/managing-commits/options-for-managing-commits-in-github-desktop)" diff --git a/content/desktop/overview/about-github-desktop.md b/content/desktop/overview/about-github-desktop.md index 901b1c7b270c..39b70253d487 100644 --- a/content/desktop/overview/about-github-desktop.md +++ b/content/desktop/overview/about-github-desktop.md @@ -21,18 +21,18 @@ redirect_from: {% data variables.product.prodname_desktop %} is useful for beginning and advanced users. Benefits include: -- **Get started easily.** If you're new to Git and {% data variables.product.prodname_dotcom %}, you may find it easier to use {% data variables.product.prodname_desktop %} than to use Git on the command line. {% data variables.product.prodname_desktop %} has a graphical user interface that simplifies commands and helps you visualize changes. -- **Find commands.** Because {% data variables.product.prodname_desktop %} has a visual interface, you can easily access less-common Git commands, such as choosing which changed lines to include in a commit or adding a co-author to a commit, without needing to memorize or look up syntax. -- **Follow best practices.** {% data variables.product.prodname_desktop %} encourages best practices. For example, it helps you to create an accurate and easy-to-follow commit history so other collaborators on a project can easily review your work. -- **Integrate with {% data variables.product.prodname_dotcom %}.** {% data variables.product.prodname_desktop %} is specifically designed for use with {% data variables.product.prodname_dotcom %}. For example, you can authenticate to {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_server %} quickly, without needing to use a separate credential manager. You can also check out a pull request to run checks without needing to open your browser. +* **Get started easily.** If you're new to Git and {% data variables.product.prodname_dotcom %}, you may find it easier to use {% data variables.product.prodname_desktop %} than to use Git on the command line. {% data variables.product.prodname_desktop %} has a graphical user interface that simplifies commands and helps you visualize changes. +* **Find commands.** Because {% data variables.product.prodname_desktop %} has a visual interface, you can easily access less-common Git commands, such as choosing which changed lines to include in a commit or adding a co-author to a commit, without needing to memorize or look up syntax. +* **Follow best practices.** {% data variables.product.prodname_desktop %} encourages best practices. For example, it helps you to create an accurate and easy-to-follow commit history so other collaborators on a project can easily review your work. +* **Integrate with {% data variables.product.prodname_dotcom %}.** {% data variables.product.prodname_desktop %} is specifically designed for use with {% data variables.product.prodname_dotcom %}. For example, you can authenticate to {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_server %} quickly, without needing to use a separate credential manager. You can also check out a pull request to run checks without needing to open your browser. ## {% data variables.product.prodname_desktop %} workflow You can use {% data variables.product.prodname_desktop %} alongside any tools you need to contribute to a project. For example, a typical workflow is: -- Use {% data variables.product.prodname_desktop %} to download a {% data variables.product.prodname_dotcom %} repository to your computer and create a new branch -- Use an editor such as {% data variables.product.prodname_vscode %} to make changes to the code -- Return to {% data variables.product.prodname_desktop %} to commit and push the changes to {% data variables.product.prodname_dotcom %} +* Use {% data variables.product.prodname_desktop %} to download a {% data variables.product.prodname_dotcom %} repository to your computer and create a new branch +* Use an editor such as {% data variables.product.prodname_vscode %} to make changes to the code +* Return to {% data variables.product.prodname_desktop %} to commit and push the changes to {% data variables.product.prodname_dotcom %} ## Getting started @@ -42,4 +42,4 @@ If you're interested in the open source {% data variables.product.prodname_deskt ## Further reading -- "[AUTOTITLE](/get-started/using-git/about-git)" +* "[AUTOTITLE](/get-started/using-git/about-git)" diff --git a/content/desktop/overview/creating-your-first-repository-using-github-desktop.md b/content/desktop/overview/creating-your-first-repository-using-github-desktop.md index 19509a63a556..63826d750c45 100644 --- a/content/desktop/overview/creating-your-first-repository-using-github-desktop.md +++ b/content/desktop/overview/creating-your-first-repository-using-github-desktop.md @@ -44,12 +44,12 @@ If you do not wish to create and clone a tutorial repository, you can create a n 1. Click **Create a New Repository on your Hard Drive...**. 1. In the "Create a New Repository" window, fill in the fields and select your preferred options. - - "Name" defines the name of your repository both locally and on {% data variables.product.product_name %}. - - "Description" is an optional field that you can use to provide more information about the purpose of your repository. - - "Local path" sets the location of your repository on your computer. By default, {% data variables.product.prodname_desktop %} creates a _GitHub_ folder inside your _Documents_ folder to store your repositories, but you can choose any location on your computer. Your new repository will be a folder inside the chosen location. For example, if you name your repository `Tutorial`, a folder named _Tutorial_ is created inside the folder you selected for your local path. {% data variables.product.prodname_desktop %} remembers your chosen location the next time you create or clone a new repository. - - **Initialize this repository with a README** creates an initial commit with a _README.md_ file. READMEs helps people understand the purpose of your project, so we recommend selecting this and filling it out with helpful information. When someone visits your repository on {% data variables.product.product_name %}, the README is the first thing they'll see as they learn about your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." - - The **Git ignore** drop-down menu lets you add a custom file to ignore specific files in your local repository that you don't want to store in version control. If there's a specific language or framework that you'll be using, you can select an option from the available list. If you're just getting started, feel free to skip this selection. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)." - - The **License** drop-down menu lets you add an open-source license to a LICENSE file in your repository. You don't need to worry about adding a license right away. For more information about available open-source licenses and how to add them to your repository, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * "Name" defines the name of your repository both locally and on {% data variables.product.product_name %}. + * "Description" is an optional field that you can use to provide more information about the purpose of your repository. + * "Local path" sets the location of your repository on your computer. By default, {% data variables.product.prodname_desktop %} creates a _GitHub_ folder inside your _Documents_ folder to store your repositories, but you can choose any location on your computer. Your new repository will be a folder inside the chosen location. For example, if you name your repository `Tutorial`, a folder named _Tutorial_ is created inside the folder you selected for your local path. {% data variables.product.prodname_desktop %} remembers your chosen location the next time you create or clone a new repository. + * **Initialize this repository with a README** creates an initial commit with a _README.md_ file. READMEs helps people understand the purpose of your project, so we recommend selecting this and filling it out with helpful information. When someone visits your repository on {% data variables.product.product_name %}, the README is the first thing they'll see as they learn about your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." + * The **Git ignore** drop-down menu lets you add a custom file to ignore specific files in your local repository that you don't want to store in version control. If there's a specific language or framework that you'll be using, you can select an option from the available list. If you're just getting started, feel free to skip this selection. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)." + * The **License** drop-down menu lets you add an open-source license to a LICENSE file in your repository. You don't need to worry about adding a license right away. For more information about available open-source licenses and how to add them to your repository, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." 1. Click **Create repository**. ## Part 3: Exploring {% data variables.product.prodname_desktop %} @@ -62,9 +62,9 @@ At the top of the {% data variables.product.prodname_desktop %} app, you will se ![Screenshot of the GitHub Desktop app. A bar displaying details for the "hello-world" repository spans the top of the window, and is outlined in orange.](/assets/images/help/desktop/explore-github-desktop.png) -- **Current repository** shows the name of the repository you're working on. You can click **Current repository** to switch to a different repository in {% data variables.product.prodname_desktop %}. -- **Current branch** shows the name of the branch you're working on. You can click **Current branch** to view all the branches in your repository, switch to a different branch, or create a new branch. Once you create pull requests in your repository, you can also view these by clicking on **Current branch**. -- **Publish repository** appears because you haven't published your repository to {% data variables.product.product_name %} yet, which you'll do later in the next step. This section of the bar will change based on the status of your current branch and repository. Different context dependent actions will be available that let you exchange data between your local and remote repositories. +* **Current repository** shows the name of the repository you're working on. You can click **Current repository** to switch to a different repository in {% data variables.product.prodname_desktop %}. +* **Current branch** shows the name of the branch you're working on. You can click **Current branch** to view all the branches in your repository, switch to a different branch, or create a new branch. Once you create pull requests in your repository, you can also view these by clicking on **Current branch**. +* **Publish repository** appears because you haven't published your repository to {% data variables.product.product_name %} yet, which you'll do later in the next step. This section of the bar will change based on the status of your current branch and repository. Different context dependent actions will be available that let you exchange data between your local and remote repositories. ### Changes and History @@ -72,8 +72,8 @@ In the left sidebar, you'll find the **Changes** and **History** views. ![Screenshot of the GitHub Desktop app. A sidebar on the left-hand side, with tabs labeled "Changes" and "History", is highlighted with an orange outline.](/assets/images/help/desktop/changes-and-history.png) -- The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to. -- The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, LICENSE, or README files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file +* The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to. +* The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, LICENSE, or README files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file ## Part 4: Publishing your repository to {% data variables.product.product_name %} @@ -82,9 +82,9 @@ When you create a new repository, it only exists on your computer and you are th 1. In the repository bar, click **Publish repository**. ![Screenshot of the repository bar. A button, labeled "Publish repository", is highlighted with an orange outline.](/assets/images/help/desktop/publish-repository.png) 1. In the "Publish Repository" window, enter details for your new repository. - - {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository. - - **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available. - - The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}. + * {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository. + * **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available. + * The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}. 1. Click **Publish Repository**. 1. You can access the repository on {% data variables.product.prodname_dotcom_the_website %} from within {% data variables.product.prodname_desktop %}. In the file menu, click **Repository**, then click **View on GitHub**. This will take you directly to the repository in your default browser. @@ -105,8 +105,8 @@ Now that you've created and published your repository, you're ready to make chan 1. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**. ![Screenshot of the "Repository" menu bar. A button, labeled "Push origin", is highlighted with an orange outline.](/assets/images/help/desktop/push-to-origin.png) - - The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}. - - The "origin" in **Push origin** means that you are pushing changes to the remote called `origin`, which in this case is your project's repository on {% data variables.product.prodname_dotcom_the_website %}. Until you push any new commits to {% data variables.product.product_name %}, there will be differences between your project's repository on your computer and your project's repository on {% data variables.product.prodname_dotcom_the_website %}. This allows you to work locally and only push your changes to {% data variables.product.prodname_dotcom_the_website %} when you're ready. + * The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}. + * The "origin" in **Push origin** means that you are pushing changes to the remote called `origin`, which in this case is your project's repository on {% data variables.product.prodname_dotcom_the_website %}. Until you push any new commits to {% data variables.product.product_name %}, there will be differences between your project's repository on your computer and your project's repository on {% data variables.product.prodname_dotcom_the_website %}. This allows you to work locally and only push your changes to {% data variables.product.prodname_dotcom_the_website %} when you're ready. 1. In the window to the right of the **Changes** view, you'll see suggestions for actions you can do next. To open the repository on {% data variables.product.product_name %} in your browser, click **View on {% data variables.product.product_name %}**. ![Screenshot of the "No local changes" screen. In a list of suggestions, a button, labeled "View on GitHub", is highlighted with an orange outline.](/assets/images/help/desktop/available-actions.png) 1. In your browser, click **2 commits**. You'll see a list of the commits in this repository on {% data variables.product.product_name %}. The first commit should be the commit you just made in {% data variables.product.prodname_desktop %}. @@ -118,6 +118,6 @@ You've now created a repository, published the repository to {% data variables.p ## Further reading -- "[AUTOTITLE](/get-started/getting-started-with-git)" -- "[AUTOTITLE](/get-started/learning-about-github)" -- "[AUTOTITLE](/get-started)" +* "[AUTOTITLE](/get-started/getting-started-with-git)" +* "[AUTOTITLE](/get-started/learning-about-github)" +* "[AUTOTITLE](/get-started)" diff --git a/content/desktop/overview/getting-started-with-github-desktop.md b/content/desktop/overview/getting-started-with-github-desktop.md index ae3e9ba701d1..c8f709276a66 100644 --- a/content/desktop/overview/getting-started-with-github-desktop.md +++ b/content/desktop/overview/getting-started-with-github-desktop.md @@ -17,9 +17,9 @@ This guide will help you get started with {% data variables.product.prodname_des You might find it helpful to have a basic understanding of Git and {% data variables.product.prodname_dotcom %} before getting started with {% data variables.product.prodname_desktop %}. For more information, see the following articles. -- "[AUTOTITLE](/get-started/using-git)" -- "[AUTOTITLE](/get-started/learning-about-github)" -- "[AUTOTITLE](/get-started)" +* "[AUTOTITLE](/get-started/using-git)" +* "[AUTOTITLE](/get-started/learning-about-github)" +* "[AUTOTITLE](/get-started)" {% data variables.product.prodname_desktop %} is an open source project. You can see the roadmap, contribute to the project, or open an issue to provide feedback or feature requests. For more information, see the [`desktop/desktop`](https://github.com/desktop/desktop) repository. diff --git a/content/desktop/overview/supported-operating-systems-for-github-desktop.md b/content/desktop/overview/supported-operating-systems-for-github-desktop.md index 87e5d2e05896..5aa114103b57 100644 --- a/content/desktop/overview/supported-operating-systems-for-github-desktop.md +++ b/content/desktop/overview/supported-operating-systems-for-github-desktop.md @@ -13,8 +13,8 @@ shortTitle: Supported OS ## About supported operating systems The following operating systems are supported for {% data variables.product.prodname_desktop %}. -- {% data variables.desktop.mac-osx-versions %} -- {% data variables.desktop.windows-versions %}. You must have a 64-bit operating system to run {% data variables.product.prodname_desktop %}. +* {% data variables.desktop.mac-osx-versions %} +* {% data variables.desktop.windows-versions %}. You must have a 64-bit operating system to run {% data variables.product.prodname_desktop %}. ## Troubleshooting problems on macOS diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md index 1470f8201adb..04f9a24c0b17 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md @@ -11,8 +11,8 @@ redirect_from: {% data variables.product.prodname_desktop %} will show a system notification for events that occur in the currently selected repository. Notifications will be shown when: -- Pull request checks have failed. -- A pull request review is left with a comment, approval, or requested changes. +* Pull request checks have failed. +* A pull request review is left with a comment, approval, or requested changes. Clicking the notification will switch application focus to {% data variables.product.prodname_desktop %} and provide more detailed information. diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md index 6d2ecb4831a1..4ce51daa761c 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md @@ -21,9 +21,9 @@ After you create a branch and make changes to files in a project, you can create ## Prerequisites Before you create a pull request, you'll need to push changes to a branch on {% data variables.product.prodname_dotcom %}. -- Save and commit any changes on your local branch. For more information, see "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop)." -- Push your local commits to the remote repository. For more information, see "[AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop)." -- Publish your current branch to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop)." +* Save and commit any changes on your local branch. For more information, see "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop)." +* Push your local commits to the remote repository. For more information, see "[AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop)." +* Publish your current branch to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop)." ## Creating an issue @@ -79,7 +79,7 @@ Before you create a pull request, you'll need to push changes to a branch on {% ## Further reading -- "[Issue](/get-started/learning-about-github/github-glossary#issue)" in the {% data variables.product.prodname_dotcom %} glossary -- "[Pull request](/get-started/learning-about-github/github-glossary#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary -- "[Base branch](/get-started/learning-about-github/github-glossary#base-branch)" in the {% data variables.product.prodname_dotcom %} glossary -- "[Topic branch](/get-started/learning-about-github/github-glossary#topic-branch)" in the {% data variables.product.prodname_dotcom %} glossary +* "[Issue](/get-started/learning-about-github/github-glossary#issue)" in the {% data variables.product.prodname_dotcom %} glossary +* "[Pull request](/get-started/learning-about-github/github-glossary#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary +* "[Base branch](/get-started/learning-about-github/github-glossary#base-branch)" in the {% data variables.product.prodname_dotcom %} glossary +* "[Topic branch](/get-started/learning-about-github/github-glossary#topic-branch)" in the {% data variables.product.prodname_dotcom %} glossary diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md index 1ac6243b72cb..391f50f4397a 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop.md @@ -97,6 +97,6 @@ Some workflows require or benefit from rebasing instead of merging. By rebasing ## Further Reading -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#pull)" in the {% data variables.product.prodname_dotcom %} glossary -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#merge)" in the {% data variables.product.prodname_dotcom %} glossary -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#rebase)" in the {% data variables.product.prodname_dotcom %} glossary +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#pull)" in the {% data variables.product.prodname_dotcom %} glossary +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#merge)" in the {% data variables.product.prodname_dotcom %} glossary +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#rebase)" in the {% data variables.product.prodname_dotcom %} glossary diff --git a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md index cca4a7a13849..5b1756f5feb3 100644 --- a/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md +++ b/content/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md @@ -49,9 +49,9 @@ You cannot comment on a pull request from {% data variables.product.prodname_des When you have checked out a pull request branch, you can use {% data variables.product.prodname_desktop %} and your local editor to view the contributor's changes or make further changes to the branch. For example, you can: -- [Open the branch in your editor](#open-the-branch-in-your-editor) -- [View the commit history](#view-the-commit-history) -- [View and re-run checks](#view-and-re-run-checks) +* [Open the branch in your editor](#open-the-branch-in-your-editor) +* [View the commit history](#view-the-commit-history) +* [View and re-run checks](#view-and-re-run-checks) ### Open the branch in your editor diff --git a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md index 7487f32a07ec..8c96c1c6a27a 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/about-discussions.md @@ -10,11 +10,11 @@ versions: With {% data variables.product.prodname_discussions %}, the community for your project can create and participate in conversations within the project's repository or organization. Discussions empower a project's maintainers, contributors, and visitors to gather and accomplish the following goals in a central location, without third-party tools. -- Share announcements and information, gather feedback, plan, and make decisions -- Ask questions, discuss and answer the questions, and mark the discussions as answered -- Create polls to gauge community opinion -- Upvote discussions and comments to give higher visibility to ideas you find valuable -- Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows +* Share announcements and information, gather feedback, plan, and make decisions +* Ask questions, discuss and answer the questions, and mark the discussions as answered +* Create polls to gauge community opinion +* Upvote discussions and comments to give higher visibility to ideas you find valuable +* Foster an inviting atmosphere for visitors and contributors to discuss goals, development, administration, and workflows ![Screenshot of the "Discussions" page for a {% data variables.product.company_short %} repository, showing a list of discussions such as "Feedback on the new layout" and "Project direction".](/assets/images/help/discussions/hero.png) @@ -71,8 +71,8 @@ You can share your feedback about {% data variables.product.prodname_discussions ## Further reading -- "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)" -- "[AUTOTITLE](/search-github/searching-on-github/searching-discussions)" -- "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)" -- "[AUTOTITLE](/communities/moderating-comments-and-conversations)"{% ifversion fpt or ghec %} -- "[AUTOTITLE](/communities/maintaining-your-safety-on-github)"{% endif %} +* "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-discussions)" +* "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)" +* "[AUTOTITLE](/communities/moderating-comments-and-conversations)"{% ifversion fpt or ghec %} +* "[AUTOTITLE](/communities/maintaining-your-safety-on-github)"{% endif %} diff --git a/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md b/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md index 522ebf8d493c..1866bcc6021d 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md @@ -62,9 +62,9 @@ You can choose how to sort the list of discussions. ![Screenshot of a row of buttons for sorting discussions. A button labeled "Sort by: Latest activity" is highlighted with an orange outline.](/assets/images/help/discussions/sort-discussions-buttons.png) - - Sort by **Latest activity** to display the discussions with the most recent activity at the top of the list. - - Sort by **Date created** to display the discussions that were created most recently at the top of the list. - - Sort by **Top** to display the discussions with the most upvotes at the top of the list. You can limit the list to only display discussions from a specific time period. + * Sort by **Latest activity** to display the discussions with the most recent activity at the top of the list. + * Sort by **Date created** to display the discussions that were created most recently at the top of the list. + * Sort by **Top** to display the discussions with the most upvotes at the top of the list. You can limit the list to only display discussions from a specific time period. ## Sorting top-level comments in discussions @@ -77,9 +77,9 @@ You can choose how to sort top-level comments in discussions. Comment threads do ![Screenshot of a discussion. The buttons for sorting comments in discussions are outlined in dark orange.](/assets/images/help/discussions/sort-comments-buttons.png) - - Sort by **Oldest** to display the oldest top-level comments first. - - Sort by **Newest** to display the newest top-level comments first. - - Sort by **Top** to display the most upvoted top-level comments first. + * Sort by **Oldest** to display the oldest top-level comments first. + * Sort by **Newest** to display the newest top-level comments first. + * Sort by **Top** to display the most upvoted top-level comments first. ## Converting an issue to a discussion @@ -87,7 +87,7 @@ You can choose how to sort top-level comments in discussions. Comment threads do ## Further reading -- "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)" +* "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)" {%- ifversion fpt or ghec %} -- "[AUTOTITLE](/communities/maintaining-your-safety-on-github)" +* "[AUTOTITLE](/communities/maintaining-your-safety-on-github)" {%- endif %} diff --git a/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md b/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md index 0d7e4947a83d..a5a5f703f30b 100644 --- a/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md +++ b/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md @@ -14,10 +14,10 @@ shortTitle: Participate in discussion In addition to starting or viewing discussions and polls, you can: -- Comment in response to the original comment from the author of the discussion -- Create a comment thread by replying to an individual comment that another community member made within the discussion -- React to comments with emoji -- Upvote discussions and top-level comments to give them more visibility +* Comment in response to the original comment from the author of the discussion +* Create a comment thread by replying to an individual comment that another community member made within the discussion +* React to comments with emoji +* Upvote discussions and top-level comments to give them more visibility {% ifversion fpt or ghec %}You can block users and report disruptive content to maintain a safe and pleasant environment for yourself on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/communities/maintaining-your-safety-on-github)."{% endif %} diff --git a/content/discussions/guides/best-practices-for-community-conversations-on-github.md b/content/discussions/guides/best-practices-for-community-conversations-on-github.md index c107d9cd4e1a..3aea1c7d76b5 100644 --- a/content/discussions/guides/best-practices-for-community-conversations-on-github.md +++ b/content/discussions/guides/best-practices-for-community-conversations-on-github.md @@ -11,9 +11,9 @@ versions: Since {% data variables.product.prodname_discussions %} is an open forum, there is an opportunity to bring non-code collaboration into a project's repository or organization and gather diverse feedback and ideas more quickly. You can help drive a productive conversation in a number of ways. -- Asking pointed questions and follow-up questions to garner specific feedback -- Capturing a diverse experience and distilling it down to main points -- Opening an issue to take action based on the conversation, where applicable +* Asking pointed questions and follow-up questions to garner specific feedback +* Capturing a diverse experience and distilling it down to main points +* Opening an issue to take action based on the conversation, where applicable For more information about opening an issue and cross-referencing a discussion, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." @@ -22,10 +22,10 @@ For more information about opening an issue and cross-referencing a discussion, You can create and participate in discussions, issues, and pull requests, depending on the type of conversation you'd like to have. You can use {% data variables.product.prodname_discussions %} to discuss big picture ideas, brainstorm, and develop a project's specific details before committing it to an issue, which can then be scoped. {% data variables.product.prodname_discussions %} is useful for teams in a number of scenarios. -- You are in the discovery phase of a project and are still learning which direction your team wants to go in -- You want to collect feedback from a wider community about a project -- You want to keep bug fixes, feature requests, and general conversations separate -- You want to measure interest in new ideas and gauge community opinion using polls +* You are in the discovery phase of a project and are still learning which direction your team wants to go in +* You want to collect feedback from a wider community about a project +* You want to keep bug fixes, feature requests, and general conversations separate +* You want to measure interest in new ideas and gauge community opinion using polls You might use repository discussions to discuss topics that are specific to the repository. If your project spans multiple repositories, you might use organization discussions to discuss topics that aren't specific to a single repository in your organization. @@ -43,7 +43,7 @@ To continue learning about {% data variables.product.prodname_discussions %} and ## Further reading -- "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)" -- "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)" -- "[AUTOTITLE](/communities/moderating-comments-and-conversations)" -- "[AUTOTITLE](/get-started/writing-on-github)" +* "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)" +* "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)" +* "[AUTOTITLE](/communities/moderating-comments-and-conversations)" +* "[AUTOTITLE](/get-started/writing-on-github)" diff --git a/content/discussions/guides/finding-your-discussions.md b/content/discussions/guides/finding-your-discussions.md index 9386e1429ac6..04c7d9eee548 100644 --- a/content/discussions/guides/finding-your-discussions.md +++ b/content/discussions/guides/finding-your-discussions.md @@ -25,6 +25,6 @@ redirect_from: ## Further reading -- "[AUTOTITLE](/search-github/searching-on-github/searching-discussions)" -- "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" -- "[AUTOTITLE](/discussions/managing-discussions-for-your-community)" +* "[AUTOTITLE](/search-github/searching-on-github/searching-discussions)" +* "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)" +* "[AUTOTITLE](/discussions/managing-discussions-for-your-community)" diff --git a/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md b/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md index fa43fa510140..9425871fa172 100644 --- a/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md +++ b/content/discussions/managing-discussions-for-your-community/viewing-insights-for-your-discussions.md @@ -12,10 +12,10 @@ shortTitle: View discussions insights ## About the discussions insights dashboard You can use discussions insights to help understand the contribution activity, page views, and growth of your discussions community. -- **Contribution activity** shows the count of total contributions to discussions, issues, and pull requests. -- **Discussions page views** shows the total page views for discussions, segmented by logged in versus anonymous viewers. -- **Discussions daily contributors** shows the daily count of unique users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period. -- **Discussions new contributors** shows the daily count of unique new users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period. +* **Contribution activity** shows the count of total contributions to discussions, issues, and pull requests. +* **Discussions page views** shows the total page views for discussions, segmented by logged in versus anonymous viewers. +* **Discussions daily contributors** shows the daily count of unique users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period. +* **Discussions new contributors** shows the daily count of unique new users who have reacted, upvoted, marked an answer, commented, or posted in the selected time period. ![Screenshot of the "Community insights" page. A dashboard displays graphs for data related to Discussions, such as page views.](/assets/images/help/discussions/discussions-dashboard.png) diff --git a/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md b/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md index 41e2318a16d2..ad63845bb406 100644 --- a/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md +++ b/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md @@ -40,4 +40,4 @@ To report an abusive repository: Go to your {% data variables.product.prodname_c ## Further reading -- ""[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)"" +* ""[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)"" diff --git a/content/education/contribute-with-github-community-exchange/submitting-your-repository-to-github-community-exchange.md b/content/education/contribute-with-github-community-exchange/submitting-your-repository-to-github-community-exchange.md index 5a6fa67e898f..a77748bba814 100644 --- a/content/education/contribute-with-github-community-exchange/submitting-your-repository-to-github-community-exchange.md +++ b/content/education/contribute-with-github-community-exchange/submitting-your-repository-to-github-community-exchange.md @@ -12,9 +12,9 @@ Only public repositories owned by personal accounts can be submitted to {% data There are three types of repository submissions: -- **Learn.** A repository to share step-by-step instructions to build a project. -- **Collaborate.** A repository seeking collaborators to work on a project. -- **Learn and Collaborate.** A repository which is a combination of `Learn` and `Collaborate`. +* **Learn.** A repository to share step-by-step instructions to build a project. +* **Collaborate.** A repository seeking collaborators to work on a project. +* **Learn and Collaborate.** A repository which is a combination of `Learn` and `Collaborate`. Consider what the main purpose of your repository is when choosing the type of submission for your repository. @@ -27,17 +27,17 @@ Once a repository has been submitted to {% data variables.product.prodname_commu Your repository must meet a minimum set of requirements for a submission to be accepted. During the submission process, if the submission criteria hasn't been met for your selected repository, you will be notified of the missing items. For a submission with a purpose of `Learn`, your repository must have: -- A description. -- A LEARN.md file to provide step-by-step instructions, with text and/or media, on how you built your project. Ideally, your LEARN.md file will deconstruct your project into small components and provide thorough details of each step, so that other students can code their project by following your instructions. -- A README.md file to provide a detailed description of your project. -- A License so others are aware of what they can and cannot do with your source code. +* A description. +* A LEARN.md file to provide step-by-step instructions, with text and/or media, on how you built your project. Ideally, your LEARN.md file will deconstruct your project into small components and provide thorough details of each step, so that other students can code their project by following your instructions. +* A README.md file to provide a detailed description of your project. +* A License so others are aware of what they can and cannot do with your source code. For a submission with a purpose of `Collaborate`, your repository must have: -- A description. -- A README.md file to provide a detailed description of your project. -- A License so others are aware of what they can and cannot do with your source code. -- One or more issues for collaborators to work on. -- CONTRIBUTING.md file to communicate how to contribute to your project. +* A description. +* A README.md file to provide a detailed description of your project. +* A License so others are aware of what they can and cannot do with your source code. +* One or more issues for collaborators to work on. +* CONTRIBUTING.md file to communicate how to contribute to your project. A good repository submission for both `Learn` and `Collaborate` purposes, is a repository that follows community standards. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-community-exchange.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-community-exchange.md index 256d8be2b7f3..f3e31c450ea6 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-community-exchange.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-community-exchange.md @@ -16,11 +16,11 @@ shortTitle: About Community Exchange You can help your peers learn open source skills, become a project maintainer, and grow your {% data variables.product.prodname_dotcom %} portfolio and network within a safe and verified community platform. {% data variables.product.prodname_community_exchange %} allows you to: -- Discover student created repositories -- Star repositories of interest -- Submit a repository in need of collaborators -- Submit a repository to teach new skills -- Manage your repository submissions +* Discover student created repositories +* Star repositories of interest +* Submit a repository in need of collaborators +* Submit a repository to teach new skills +* Manage your repository submissions For more information, see "[AUTOTITLE](/education/contribute-with-github-community-exchange)." @@ -28,4 +28,4 @@ For more information, see "[AUTOTITLE](/education/contribute-with-github-communi ## Further reading -- "[AUTOTITLE](/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange)" +* "[AUTOTITLE](/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange)" diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md index b59f691a6147..a310fa93dc72 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students.md @@ -25,17 +25,17 @@ Once you are a verified {% data variables.product.prodname_global_campus %} stud ## {% data variables.product.prodname_global_campus %} features for students {% data variables.product.prodname_global_campus %} is a portal from which you can access your {% data variables.product.prodname_education %} benefits and resources, all in one place. On the {% data variables.product.prodname_global_campus %} portal, students can: -- Connect with a local Campus Expert. For more information on campus experts, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts)." -- Gain in-depth understanding of a feature, tool, or topic with curated experiences designed to support your learning journey. -- Explore and claim offers for free industry tools from the [Student Developer Pack](https://education.github.com/pack). -- See upcoming in-person and virtual events for students, curated by {% data variables.product.prodname_education %} and student leaders. -- View assignments from [GitHub Classroom](https://classroom.github.com/) with upcoming due dates. -- Stay in the know on what the community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. -- Discover student-created repositories from {% data variables.product.prodname_community_exchange %}. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)." +* Connect with a local Campus Expert. For more information on campus experts, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts)." +* Gain in-depth understanding of a feature, tool, or topic with curated experiences designed to support your learning journey. +* Explore and claim offers for free industry tools from the [Student Developer Pack](https://education.github.com/pack). +* See upcoming in-person and virtual events for students, curated by {% data variables.product.prodname_education %} and student leaders. +* View assignments from [GitHub Classroom](https://classroom.github.com/) with upcoming due dates. +* Stay in the know on what the community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. +* Discover student-created repositories from {% data variables.product.prodname_community_exchange %}. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)." {% data variables.product.prodname_global_campus %} students also receive the following {% data variables.product.prodname_dotcom %} benefits. -- **{% data variables.product.prodname_copilot %}**: Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. You will be automatically notified about the free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page in your account settings. For more information about subscribing to and using {% data variables.product.prodname_copilot %}, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user)." -- **{% data variables.product.prodname_github_codespaces %}**: {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/overview)." +* **{% data variables.product.prodname_copilot %}**: Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. You will be automatically notified about the free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page in your account settings. For more information about subscribing to and using {% data variables.product.prodname_copilot %}, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user)." +* **{% data variables.product.prodname_github_codespaces %}**: {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/overview)." {% note %} @@ -45,6 +45,6 @@ Once you are a verified {% data variables.product.prodname_global_campus %} stud ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers)" -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom)" +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers)" +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom)" diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student.md index 348dd47214b5..100be03c1b78 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student.md @@ -17,10 +17,10 @@ shortTitle: Apply to Github Education ## Requirements To be eligible for {% data variables.product.prodname_global_campus %}, including {% data variables.product.prodname_student_pack %} and other benefits, you must: -- Be currently enrolled in a degree or diploma granting course of study such as a high school, secondary school, college, university, homeschool, or similar educational institution -- Have a verifiable school-issued email address or upload documents that prove your current student status -- Have a [{% data variables.product.prodname_dotcom %} personal account](/get-started/start-your-journey/creating-an-account-on-github) -- Be at least 13 years old +* Be currently enrolled in a degree or diploma granting course of study such as a high school, secondary school, college, university, homeschool, or similar educational institution +* Have a verifiable school-issued email address or upload documents that prove your current student status +* Have a [{% data variables.product.prodname_dotcom %} personal account](/get-started/start-your-journey/creating-an-account-on-github) +* Be at least 13 years old Documents that prove your current student status include a picture of your school ID with current enrollment date, class schedule, transcript, and affiliation or enrollment verification letter. @@ -57,7 +57,7 @@ To see when your free access to the {% data variables.product.prodname_student_p ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/why-wasnt-my-application-to-global-campus-for-students-approved)" -- "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom)" -- [{% data variables.product.prodname_education %}](https://education.github.com) +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/why-wasnt-my-application-to-global-campus-for-students-approved)" +* "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom)" +* [{% data variables.product.prodname_education %}](https://education.github.com) diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/why-wasnt-my-application-to-github-education-for-students-approved.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/why-wasnt-my-application-to-github-education-for-students-approved.md index 3a11b668a315..81e653600b8a 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/why-wasnt-my-application-to-github-education-for-students-approved.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/why-wasnt-my-application-to-github-education-for-students-approved.md @@ -55,20 +55,20 @@ If your academic email address was already used to request a {% data variables.p If you have more than one personal account, you must merge your accounts. To retain the discount, keep the account that was granted the discount. You can rename the retained account and keep your contribution history by adding all your email addresses to the retained account. For more information, see: -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)" ## Ineligible student status You're ineligible for a {% data variables.product.prodname_student_pack %} if: -- You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. -- You're pursuing a degree which will be terminated in the current academic session. -- You're under 13 years old. +* You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. +* You're pursuing a degree which will be terminated in the current academic session. +* You're under 13 years old. Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_campus_program %}](https://education.github.com/schools). ## Further reading -- "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %} -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)" +* "[How to get the GitHub Student Developer Pack without a student ID](https://github.blog/2019-07-30-how-to-get-the-github-student-developer-pack-without-a-student-id/)" on {% data variables.product.prodname_blog %} +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)" diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers.md index 5572e86d6c64..34f4cb5db2d9 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers.md @@ -23,14 +23,14 @@ Before applying for an individual discount, check if your learning community is {% data variables.product.prodname_global_campus %} is a portal from which you can access your {% data variables.product.prodname_education %} benefits and resources, all in one place. On the {% data variables.product.prodname_global_campus %} portal, teachers of all levels can: {% data reusables.education.apply-for-team %} -- View an overview of your active [{% data variables.product.prodname_classroom %}](https://classroom.github.com), including recent assignments and your class's progress at a glance, as well as links to {% data variables.product.prodname_classroom %}. -- View and interact with [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) posted by your peers from around the world to discuss current trends in technology education, and see the latest posts from our [{% data variables.product.prodname_education %} blog](https://github.blog/category/education/). -- See student events curated by {% data variables.product.prodname_education %} and student leaders. -- Stay in the know on what the student community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. -- Request a {% data variables.product.prodname_dotcom %} swag bag with educational materials and goodies for your students. +* View an overview of your active [{% data variables.product.prodname_classroom %}](https://classroom.github.com), including recent assignments and your class's progress at a glance, as well as links to {% data variables.product.prodname_classroom %}. +* View and interact with [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) posted by your peers from around the world to discuss current trends in technology education, and see the latest posts from our [{% data variables.product.prodname_education %} blog](https://github.blog/category/education/). +* See student events curated by {% data variables.product.prodname_education %} and student leaders. +* Stay in the know on what the student community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. +* Request a {% data variables.product.prodname_dotcom %} swag bag with educational materials and goodies for your students. A free subscription for {% data variables.product.prodname_copilot %} is available to verified teachers with {% data variables.product.prodname_education %}. You will be automatically notified about the free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page in your account settings. For more information about subscribing to and using {% data variables.product.prodname_copilot %}, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/subscribing-to-copilot-as-an-individual-user)" and "[AUTOTITLE](/copilot/overview-of-github-copilot/about-github-copilot-individual)." ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)" +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)" diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher.md index c6f98c4bbe32..81880c3b0268 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher.md @@ -37,7 +37,7 @@ For more information about personal accounts on {% data variables.product.produc ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/why-wasnt-my-application-to-global-campus-for-teachers-approved)" -- [{% data variables.product.prodname_education %}](https://education.github.com) -- [{% data variables.product.prodname_classroom %} Videos](https://classroom.github.com/videos) -- [{% data variables.product.prodname_education_community %}]({% data variables.product.prodname_education_forum_link %}) +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/why-wasnt-my-application-to-global-campus-for-teachers-approved)" +* [{% data variables.product.prodname_education %}](https://education.github.com) +* [{% data variables.product.prodname_classroom %} Videos](https://classroom.github.com/videos) +* [{% data variables.product.prodname_education_community %}]({% data variables.product.prodname_education_forum_link %}) diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/why-wasnt-my-application-to-github-education-for-teachers-approved.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/why-wasnt-my-application-to-github-education-for-teachers-approved.md index 56850050f077..015ded6693f1 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/why-wasnt-my-application-to-github-education-for-teachers-approved.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/why-wasnt-my-application-to-github-education-for-teachers-approved.md @@ -46,4 +46,4 @@ Teachers are not eligible for the partner offers that come with the [{% data var ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)" +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)" diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts.md index 06948a44754b..447e195a4704 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts.md @@ -35,4 +35,4 @@ Optionally, to learn more about the program, contact your closest {% data variab ## Further reading -- “[Applying to be a {% data variables.product.prodname_student_leader_program_singular %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert)” +* “[Applying to be a {% data variables.product.prodname_student_leader_program_singular %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert)” diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md index 7ecf52783cb5..48e067939b4f 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program.md @@ -14,28 +14,28 @@ shortTitle: GitHub Campus Program --- {% data variables.product.prodname_campus_program %} is a package of premium {% data variables.product.prodname_dotcom %} access for teaching-focused institutions that grant degrees, diplomas, or certificates. {% data variables.product.prodname_campus_program %} includes: -- No-cost access to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} for all of your technical and academic departments -- 50,000 {% data variables.product.prodname_actions %} minutes and 50 GB {% data variables.product.prodname_registry %} storage +* No-cost access to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} for all of your technical and academic departments +* 50,000 {% data variables.product.prodname_actions %} minutes and 50 GB {% data variables.product.prodname_registry %} storage To read about how {% data variables.product.prodname_dotcom %} is used by educators, see [{% data variables.product.prodname_education %} stories](https://education.github.com/stories). ## {% data variables.product.prodname_campus_program %} terms and conditions -- The license is free for one year and will automatically renew for free every 2 years. You may continue on the free license so long as you continue to operate within the terms of the agreement. Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. +* The license is free for one year and will automatically renew for free every 2 years. You may continue on the free license so long as you continue to operate within the terms of the agreement. Any school that can agree to the [terms of the program](https://education.github.com/schools/terms) is welcome to join. -- Please note that the licenses are for use by the whole school. Internal IT departments, academic research groups, collaborators, students, and other non-academic departments are eligible to use the licenses so long as they are not making a profit from its use. Externally funded research groups that are housed at the university may not use the free licenses. +* Please note that the licenses are for use by the whole school. Internal IT departments, academic research groups, collaborators, students, and other non-academic departments are eligible to use the licenses so long as they are not making a profit from its use. Externally funded research groups that are housed at the university may not use the free licenses. -- You must offer {% data variables.product.prodname_dotcom %} to all of your technical and academic departments and your school’s logo will be shared on the GitHub Education website as a {% data variables.product.prodname_campus_program %} Partner. +* You must offer {% data variables.product.prodname_dotcom %} to all of your technical and academic departments and your school’s logo will be shared on the GitHub Education website as a {% data variables.product.prodname_campus_program %} Partner. -- New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact {% data variables.contact.contact_support %}. For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). +* New organizations in your enterprise are automatically added to your enterprise account. To add organizations that existed before your school joined the {% data variables.product.prodname_campus_program %}, please contact {% data variables.contact.contact_support %}. For more information about administrating your enterprise, see the [enterprise administrators documentation](/admin). To read more about {% data variables.product.prodname_dotcom %}'s privacy practices, see "[AUTOTITLE](/site-policy/privacy-policies/github-privacy-statement)." ## {% data variables.product.prodname_campus_program %} Application Eligibility -- Often times, a campus CTO/CIO, Dean, Department Chair, or Technology Officer signs the terms of the program on behalf of the campus. +* Often times, a campus CTO/CIO, Dean, Department Chair, or Technology Officer signs the terms of the program on behalf of the campus. -- If your school does not issue email addresses, {% data variables.product.prodname_dotcom %} will reach out to your account administrators with an alternative option to allow you to distribute the student developer pack to your students. +* If your school does not issue email addresses, {% data variables.product.prodname_dotcom %} will reach out to your account administrators with an alternative option to allow you to distribute the student developer pack to your students. For more information, see the [official {% data variables.product.prodname_campus_program %}](https://education.github.com/schools) page. diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md index ee4e508322c0..4c73a023cbe8 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md @@ -13,10 +13,10 @@ To apply to the {% data variables.product.prodname_student_leader_program %} pro {% note %} **Note:** The application process helps us get to know the applicant. Here are some things we want to learn about you: -- Motivation: What makes you tick? What drives you? -- Interest: Why do you want to be part of the program? -- Growth and potential: What skills do you want to learn, and how will they help you grow personally and professionally? -- Contribution: What impact do you want to make on your campus? +* Motivation: What makes you tick? What drives you? +* Interest: Why do you want to be part of the program? +* Growth and potential: What skills do you want to learn, and how will they help you grow personally and professionally? +* Contribution: What impact do you want to make on your campus? {% endnote %} @@ -24,12 +24,12 @@ To apply to the {% data variables.product.prodname_student_leader_program %} pro To become a {% data variables.product.prodname_student_leader_program_singular %}, you must: -- Be a {% data variables.product.prodname_dotcom %} user for at least six months. -- Be at least 18 years of age. -- Be enrolled in a formal higher education institution. -- Have more than one year left as a student before graduating. -- Not be enrolled in the {% data variables.product.prodname_dotcom %} Campus Advisors Program. -- Validate your student status through the [{% data variables.product.prodname_student_pack %}](https://education.github.com/pack). +* Be a {% data variables.product.prodname_dotcom %} user for at least six months. +* Be at least 18 years of age. +* Be enrolled in a formal higher education institution. +* Have more than one year left as a student before graduating. +* Not be enrolled in the {% data variables.product.prodname_dotcom %} Campus Advisors Program. +* Validate your student status through the [{% data variables.product.prodname_student_pack %}](https://education.github.com/pack). ### Submitting your application form diff --git a/content/education/guides.md b/content/education/guides.md index f95a077bde28..e84d7b57ed9c 100644 --- a/content/education/guides.md +++ b/content/education/guides.md @@ -11,42 +11,42 @@ shortTitle: Guides Teachers, students, and researchers can use tools from {% data variables.product.product_name %} to enrich a software development curriculum and develop real-world collaboration skills. -- [Sign up for a new {% data variables.product.prodname_dotcom %} account](/get-started/start-your-journey/creating-an-account-on-github) -- [Git and {% data variables.product.prodname_dotcom %} quickstart](/get-started/start-your-journey) -- [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students) -- [Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher) -- [Apply to {% data variables.product.prodname_global_campus %} as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student) +* [Sign up for a new {% data variables.product.prodname_dotcom %} account](/get-started/start-your-journey/creating-an-account-on-github) +* [Git and {% data variables.product.prodname_dotcom %} quickstart](/get-started/start-your-journey) +* [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students) +* [Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher) +* [Apply to {% data variables.product.prodname_global_campus %} as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student) ## Run a software development course with {% data variables.product.company_short %} Administer a classroom, assign and review work from your students, and teach the new generation of software developers with {% data variables.product.prodname_classroom %}. -- [About {% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers) -- [Manage classrooms](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms) -- [About assignments](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments) -- [Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment) -- [Create an individual assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) -- [Create a group assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment) -- [Create an assignment from a template repository](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository) -- [Monitor students' progress with the assignment overview page](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page) -- [Leave feedback with pull requests](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests) -- [Use autograding](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding) +* [About {% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/about-github-education-for-teachers) +* [Manage classrooms](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms) +* [About assignments](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments) +* [Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment) +* [Create an individual assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) +* [Create a group assignment](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment) +* [Create an assignment from a template repository](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository) +* [Monitor students' progress with the assignment overview page](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page) +* [Leave feedback with pull requests](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests) +* [Use autograding](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding) ## Learn to develop software Incorporate {% data variables.product.prodname_dotcom %} into your education, and use the same tools as the professionals. -- [Git and {% data variables.product.prodname_dotcom %} learning resources](/get-started/start-your-journey/git-and-github-learning-resources) -- [{% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students) -- [Try {% data variables.product.prodname_desktop %}](/desktop) -- [Try {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli) +* [Git and {% data variables.product.prodname_dotcom %} learning resources](/get-started/start-your-journey/git-and-github-learning-resources) +* [{% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students) +* [Try {% data variables.product.prodname_desktop %}](/desktop) +* [Try {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli) ## Contribute to the community Participate in the community, get training from {% data variables.product.company_short %}, and learn or teach new skills. -- [{% data variables.product.prodname_education_community %}]({% data variables.product.prodname_education_forum_link %}) -- [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students) -- [About {% data variables.product.prodname_student_leader_program %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts) -- [Applying to be a {% data variables.product.prodname_student_leader_program_singular %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert) -- [Contribute with GitHub Community Exchange](/education/contribute-with-github-community-exchange) +* [{% data variables.product.prodname_education_community %}]({% data variables.product.prodname_education_forum_link %}) +* [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/about-github-education-for-students) +* [About {% data variables.product.prodname_student_leader_program %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-experts) +* [Applying to be a {% data variables.product.prodname_student_leader_program_singular %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert) +* [Contribute with GitHub Community Exchange](/education/contribute-with-github-community-exchange) diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md index b29052f0a6b8..c10e59ddfef8 100644 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/about-github-classroom.md @@ -38,5 +38,5 @@ Optionally, you can connect a learning management system (LMS) to {% data variab ## Further reading -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/learn-with-github-classroom)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/learn-with-github-classroom)" diff --git a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md index bf69d16f7062..0ed0d1f51557 100644 --- a/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md +++ b/content/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/glossary.md @@ -50,4 +50,4 @@ A roster allows a teacher to manage students and assignment submissions in a cla ## Further reading -- "[AUTOTITLE](/get-started/learning-about-github/github-glossary)" +* "[AUTOTITLE](/get-started/learning-about-github/github-glossary)" diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md index e3b58a84a9e6..01b608c6b7e8 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-makecode-arcade-with-github-classroom.md @@ -28,4 +28,4 @@ By default, MakeCode Arcade is configured to push to the assignment repository o ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md index f2ec5620fdb5..35bed49b9690 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md @@ -42,4 +42,4 @@ Unless you use {% data variables.product.prodname_github_codespaces %}, you must ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md index fcc574636e64..b3dccff1200c 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/replit-with-github-classroom.md @@ -13,8 +13,8 @@ redirect_from: As of July 13 2021, Repl.it integration is no longer available. Here’s what’s changed: -- New private and public repls can no longer be created from within GitHub Classroom. -- Replit Hacker benefits, such as Always On and Boosts, are no longer available for new GitHub Classroom users. +* New private and public repls can no longer be created from within GitHub Classroom. +* Replit Hacker benefits, such as Always On and Boosts, are no longer available for new GitHub Classroom users. ## What does this mean for existing assignments? @@ -26,4 +26,4 @@ We know cloud IDE integrations are important to your classroom and are working h ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)" diff --git a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md b/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md index 5337098e0fc1..fdb62def0545 100644 --- a/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md +++ b/content/education/manage-coursework-with-github-classroom/learn-with-github-classroom/view-autograding-results.md @@ -25,4 +25,4 @@ You can click a specific test run to review log output, like compilation errors ## Further reading -- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)" +* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md index 6585be1c8351..0615d2fb985c 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/about-assignments.md @@ -53,6 +53,6 @@ For more information, see "[AUTOTITLE](/education/manage-coursework-with-github- ## Further reading -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md index 76ec9a5de74b..779f4b3445cd 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md @@ -101,8 +101,8 @@ Google Classroom does not use the LTI protocol so does not need to be connected {% data reusables.classroom.click-classroom-in-list %} {% data reusables.classroom.click-students %} 1. If your classroom already has a roster, you can either update the roster or delete the roster and create a new roster. - - For more information about deleting and creating a roster, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)" and "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." - - For more information about updating a roster, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)." + * For more information about deleting and creating a roster, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)" and "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." + * For more information about updating a roster, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)." 1. In the list of LMSes, click **Google Classroom**. 1. Sign in to Google, then select the Classroom to link to. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 9dead5582b48..2205956ae1e1 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -37,11 +37,11 @@ You can decide how many teams one assignment can have, and how many members each Name your assignment, decide whether to assign a deadline, define teams, and choose the visibility of assignment repositories. -- [Naming an assignment](#naming-an-assignment) -- [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) -- [Choosing an assignment type](#choosing-an-assignment-type) -- [Defining teams for an assignment](#defining-teams-for-an-assignment) -- [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) +* [Naming an assignment](#naming-an-assignment) +* [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) +* [Choosing an assignment type](#choosing-an-assignment-type) +* [Defining teams for an assignment](#defining-teams-for-an-assignment) +* [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) ### Naming an assignment @@ -67,9 +67,9 @@ If you've already created a group assignment for the classroom, you can reuse a **Note**: -- We recommend including details about the set of teams in the name for the set. For example, if you want to use the set of teams for one assignment, name the set after the assignment. If you want to reuse the set throughout a semester or course, name the set after the semester or course. +* We recommend including details about the set of teams in the name for the set. For example, if you want to use the set of teams for one assignment, name the set after the assignment. If you want to reuse the set throughout a semester or course, name the set after the semester or course. -- If you'd like to assign students to a specific team, give your students a name for the team and provide a list of members. +* If you'd like to assign students to a specific team, give your students a name for the team and provide a list of members. {% endnote %} @@ -85,8 +85,8 @@ If you've already created a group assignment for the classroom, you can reuse a {% data reusables.classroom.assignments-guide-intro-for-environment %} -- [Choosing a template repository](#choosing-a-template-repository) -- [Choosing an integrated development environment (IDE)](#choosing-an-integrated-development-environment-ide) +* [Choosing a template repository](#choosing-a-template-repository) +* [Choosing an integrated development environment (IDE)](#choosing-an-integrated-development-environment-ide) ### Choosing a template repository @@ -108,8 +108,8 @@ By default, a new assignment will create an empty repository for each team that Optionally, you can automatically grade assignments and create a space for discussing each submission with the team. -- [Testing assignments automatically](#testing-assignments-automatically) -- [Creating a pull request for feedback](#creating-a-pull-request-for-feedback) +* [Testing assignments automatically](#testing-assignments-automatically) +* [Creating a pull request for feedback](#creating-a-pull-request-for-feedback) ### Testing assignments automatically @@ -139,14 +139,14 @@ You can see the teams that are working on or have submitted an assignment in the ## Next steps -- After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see "[AUTOTITLE](/get-started)," "[AUTOTITLE](/repositories)," "[AUTOTITLE](/get-started/using-git)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests)," and the free course on [resolving merge conflicts](https://github.com/skills/resolve-merge-conflicts) from {% data variables.product.prodname_learning %}. +* After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see "[AUTOTITLE](/get-started)," "[AUTOTITLE](/repositories)," "[AUTOTITLE](/get-started/using-git)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests)," and the free course on [resolving merge conflicts](https://github.com/skills/resolve-merge-conflicts) from {% data variables.product.prodname_learning %}. -- When a team finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand how the team collaborated. For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository)." +* When a team finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand how the team collaborated. For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository)." -- You can provide feedback for an assignment by commenting on individual commits or lines in a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." For more information about creating saved replies to provide feedback for common errors, see "[AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies)." +* You can provide feedback for an assignment by commenting on individual commits or lines in a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." For more information about creating saved replies to provide feedback for common errors, see "[AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies)." ## Further reading -- "[{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" +* "[{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md index 600373f819c6..a8ee8561314c 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository.md @@ -26,6 +26,6 @@ You can reuse an existing assignment, even if it uses a template repository, in ## Further reading -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index 197ad37309cd..67d2de256f45 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -34,10 +34,10 @@ shortTitle: Individual assignment Name your assignment, decide whether to assign a deadline, and choose the visibility of assignment repositories. -- [Naming an assignment](#naming-an-assignment) -- [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) -- [Choosing an assignment type](#choosing-an-assignment-type) -- [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) +* [Naming an assignment](#naming-an-assignment) +* [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) +* [Choosing an assignment type](#choosing-an-assignment-type) +* [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) ### Naming an assignment @@ -67,8 +67,8 @@ Under "Individual or group assignment", select the drop-down menu, and click **I {% data reusables.classroom.assignments-guide-intro-for-environment %} -- [Choosing a template repository](#choosing-a-template-repository) -- [Choosing an integrated development environment (IDE)](#choosing-an-integrated-development-environment-ide) +* [Choosing a template repository](#choosing-a-template-repository) +* [Choosing an integrated development environment (IDE)](#choosing-an-integrated-development-environment-ide) ### Choosing a template repository @@ -90,8 +90,8 @@ By default, a new assignment will create an empty repository for each student on Optionally, you can automatically grade assignments and create a space for discussing each submission with the student. -- [Testing assignments automatically](#testing-assignments-automatically) -- [Creating a pull request for feedback](#creating-a-pull-request-for-feedback) +* [Testing assignments automatically](#testing-assignments-automatically) +* [Creating a pull request for feedback](#creating-a-pull-request-for-feedback) ### Testing assignments automatically @@ -121,14 +121,14 @@ You can see whether a student has joined the classroom and accepted or submitted ## Next steps -- Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see "[AUTOTITLE](/get-started)," "[AUTOTITLE](/repositories)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests)." +* Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see "[AUTOTITLE](/get-started)," "[AUTOTITLE](/repositories)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests)." -- When a student finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand the student's work. For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository)." +* When a student finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand the student's work. For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository)." -- You can provide feedback for an assignment by commenting on individual commits or lines in a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." For more information about creating saved replies to provide feedback for common errors, see "[AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies)." +* You can provide feedback for an assignment by commenting on individual commits or lines in a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." For more information about creating saved replies to provide feedback for common errors, see "[AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies)." ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md index f8b391e508ff..6107042921f7 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/editing-an-assignment.md @@ -62,8 +62,8 @@ After creating an assignment, you can edit many aspects of the assignment to bet {% endnote %} 1. To set up or change the template repository for your assignment, in the "Add a template repository to give students starter code" section, select the **Select a repository** dropdown menu. - - To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results. - - To remove a template repository, delete any text in the text field. + * To choose a template repository, begin typing the repository name in the text field, then click the repository in the search results. + * To remove a template repository, delete any text in the text field. {% note %} @@ -97,5 +97,5 @@ After creating an assignment, you can edit many aspects of the assignment to bet ## Further reading -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md index 56c8ac5dd9ca..d44f1d4acfff 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group.md @@ -13,8 +13,8 @@ If you set a cutoff date for an assignment in {% data variables.product.prodname {% note %} **Notes:** -- If your assignment has a deadline, but it does not have a cutoff date, you will not be able to grant students extensions. Instead, you can inform the student or group of their extension directly and ignore the "Late" label applied to the student or group's entry on the assignment overview. -- If you grant a student or group an extension, and they submit their work after the initial cutoff date, the assignment will still be marked "Late". You can ignore the "Late" label, as it will not affect the student or group's grade, or write access to their assignment repository. +* If your assignment has a deadline, but it does not have a cutoff date, you will not be able to grant students extensions. Instead, you can inform the student or group of their extension directly and ignore the "Late" label applied to the student or group's entry on the assignment overview. +* If you grant a student or group an extension, and they submit their work after the initial cutoff date, the assignment will still be marked "Late". You can ignore the "Late" label, as it will not affect the student or group's grade, or write access to their assignment repository. {% endnote %} diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md index 102ea2bcf2ae..91e802783cc3 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests.md @@ -30,4 +30,4 @@ To create and access the feedback pull request, you must enable the feedback pul ## Further reading -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md index d779cbd89b0a..203d4caebf37 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md @@ -66,8 +66,8 @@ If your course already has a roster, you can update the students on the roster o 1. Provide the student identifiers for your roster. - - To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**. - - To create a roster manually, type your student identifiers in the text field. + * To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**. + * To create a roster manually, type your student identifiers in the text field. 1. Click **Create roster**. @@ -80,13 +80,13 @@ Your classroom must have an existing roster to add students to the roster. For m {% data reusables.classroom.click-students %} 1. To the right of "Classroom roster", click **Update students**. If you have already linked your classroom to an LMS course, then you will see a **Sync from...** button instead. 1. Follow the instructions to add students to the roster. - - To import students from an LMS, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the **Sync from...** button. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)." + * To import students from an LMS, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the **Sync from...** button. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)." {% note %} **Note:** {% data reusables.classroom.google-classroom-note %} {% endnote %} - - To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**. + * To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**. ## Renaming a classroom @@ -130,4 +130,4 @@ You can archive a classroom that you no longer use on {% data variables.product. ## Further reading -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md index 0d8d9bf499d6..1496f99abe94 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page.md @@ -15,20 +15,20 @@ Each assignment you create on {% data variables.product.prodname_classroom %} ha For individual assignments, you can view the following information at the top of the assignment overview page: -- **Rostered students**: The number of students on the classroom's roster. -- **Added students**: The number of {% data variables.product.prodname_dotcom %} accounts that have accepted the assignment and are not associated with a roster identifier. -- **Accepted students**: The number of accounts that have accepted this assignment. -- **Assignment submissions**: The number of students that have submitted the assignment. Submission is triggered at the assignment deadline. -- **Passing students**: The number of students currently passing the autograding tests for this assignment. +* **Rostered students**: The number of students on the classroom's roster. +* **Added students**: The number of {% data variables.product.prodname_dotcom %} accounts that have accepted the assignment and are not associated with a roster identifier. +* **Accepted students**: The number of accounts that have accepted this assignment. +* **Assignment submissions**: The number of students that have submitted the assignment. Submission is triggered at the assignment deadline. +* **Passing students**: The number of students currently passing the autograding tests for this assignment. For group assignments, you can view the following information at the top of the assignment overview page: -- **Total teams**: The number of teams that have been created. -- **Rostered students**: The number of students on the classroom's roster. -- **Students not on a team**: The number of students on the classroom roster who have not yet joined a team. -- **Accepted teams**: The number of teams who have accepted this assignment. -- **Assignment submissions**: The number of teams that have submitted the assignment. Submission is triggered at the assignment deadline. -- **Passing teams**: The number of teams that are currently passing the autograding tests for this assignment. +* **Total teams**: The number of teams that have been created. +* **Rostered students**: The number of students on the classroom's roster. +* **Students not on a team**: The number of students on the classroom roster who have not yet joined a team. +* **Accepted teams**: The number of teams who have accepted this assignment. +* **Assignment submissions**: The number of teams that have submitted the assignment. Submission is triggered at the assignment deadline. +* **Passing teams**: The number of teams that are currently passing the autograding tests for this assignment. ## Viewing the assignment overview page for an assignment diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md index ce9dcc2a453f..8cca103f86f5 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md @@ -54,13 +54,13 @@ You can register your Canvas installation with {% data variables.product.prodnam 1. Go to https://classroom.github.com/register-lms. 1. Fill in the following information: - - Under "LMS Type", choose "Canvas" from the dropdown menu. - - "Issuer Identifier": `https://canvas.instructure.com` - - "Domain": The base URL to your Canvas instance - - "Client ID": The "Client ID" under "Details" from the developer key you created - - "OIDC Authorization end-point": The base URL to your Canvas instance with `/api/lti/authorize_redirect` appended at the end. - - "OAuth 2.0 Token Retrieval URL": The base URL to your Canvas instance with `/login/oauth2/token` appended at the end. - - "Key Set URL": The base URL to your Canvas instance with `/api/lti/security/jwks` appended at the end. + * Under "LMS Type", choose "Canvas" from the dropdown menu. + * "Issuer Identifier": `https://canvas.instructure.com` + * "Domain": The base URL to your Canvas instance + * "Client ID": The "Client ID" under "Details" from the developer key you created + * "OIDC Authorization end-point": The base URL to your Canvas instance with `/api/lti/authorize_redirect` appended at the end. + * "OAuth 2.0 Token Retrieval URL": The base URL to your Canvas instance with `/login/oauth2/token` appended at the end. + * "Key Set URL": The base URL to your Canvas instance with `/api/lti/security/jwks` appended at the end. 1. Click **Register**. 1. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. @@ -111,13 +111,13 @@ You must be using Moodle version 3.0 or greater. 1. Go to https://classroom.github.com/register-lms. 1. Fill in the following information: - - Under "LMS Type", choose "Moodle" from the dropdown menu. - - "Issuer Identifier": The "Platform ID" from the "Tool configuration details" of the external tool you created in Moodle - - "Domain": The base URL to your Moodle instance - - "Client ID": The "Client ID" from the "Tool configuration details" of the external tool you created in Moodle - - "Authentication request URL": The "Authentication Request URL" from the "Tool configuration details" of the external tool you created in Moodle - - "Access token URL": The "Access token URL" from the "Tool configuration details" of the external tool you created in Moodle - - "Key Set URL": The "Public keyset URL" from the "Tool configuration details" of the external tool you created in Moodle + * Under "LMS Type", choose "Moodle" from the dropdown menu. + * "Issuer Identifier": The "Platform ID" from the "Tool configuration details" of the external tool you created in Moodle + * "Domain": The base URL to your Moodle instance + * "Client ID": The "Client ID" from the "Tool configuration details" of the external tool you created in Moodle + * "Authentication request URL": The "Authentication Request URL" from the "Tool configuration details" of the external tool you created in Moodle + * "Access token URL": The "Access token URL" from the "Tool configuration details" of the external tool you created in Moodle + * "Key Set URL": The "Public keyset URL" from the "Tool configuration details" of the external tool you created in Moodle 1. Click **Register**. 1. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. @@ -148,13 +148,13 @@ You must be using Moodle version 3.0 or greater. 1. Go to https://classroom.github.com/register-lms. 1. Fill in the following information: - - Under "LMS Type", choose "Sakai" from the dropdown menu. - - "LTI 1.3 Platform Issuer": The "LTI 1.3 Platform Issuer" field as provided by Sakai - - "Domain": The base URL to your Sakai instance - - "LTI 1.3 Client ID": The "LTI 1.3 Client ID" field as provided by Sakai - - "LTI 1.3 Platform OIDC Authentication URL": The "LTI 1.3 Platform OIDC Authentication URL" field as provided by Sakai - - "LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL": The "LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL" field as provided by Sakai - - "LTI 1.3 Platform OAuth2 Well-Known/KeySet URL": The "LTI 1.3 Platform OAuth2 Well-Known/KeySet URL" field as provided by Sakai + * Under "LMS Type", choose "Sakai" from the dropdown menu. + * "LTI 1.3 Platform Issuer": The "LTI 1.3 Platform Issuer" field as provided by Sakai + * "Domain": The base URL to your Sakai instance + * "LTI 1.3 Client ID": The "LTI 1.3 Client ID" field as provided by Sakai + * "LTI 1.3 Platform OIDC Authentication URL": The "LTI 1.3 Platform OIDC Authentication URL" field as provided by Sakai + * "LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL": The "LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL" field as provided by Sakai + * "LTI 1.3 Platform OAuth2 Well-Known/KeySet URL": The "LTI 1.3 Platform OAuth2 Well-Known/KeySet URL" field as provided by Sakai 1. Click **Register**. 1. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md index d7ad66838837..67ee2053e0f5 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding.md @@ -87,13 +87,13 @@ You can add, edit, or delete autograding tests for an existing assignment. All c {% data reusables.classroom.assignments-click-pencil %} 1. In the left sidebar, click **Grading and feedback**. 1. Add, edit, or delete an autograding test. - - To add a test, under "Add autograding tests", select the **Add test** dropdown menu, then click the grading method you want to use. + * To add a test, under "Add autograding tests", select the **Add test** dropdown menu, then click the grading method you want to use. Configure the test, then click **Save test case**. - - To edit a test, to the right of the test name, click {% octicon "pencil" aria-label="The pencil icon" %}. + * To edit a test, to the right of the test name, click {% octicon "pencil" aria-label="The pencil icon" %}. Configure the test, then click **Save test case**. - - To delete a test, to the right of the test name, click {% octicon "trash" aria-label="The trash icon" %}. + * To delete a test, to the right of the test name, click {% octicon "trash" aria-label="The trash icon" %}. 1. At the bottom of the page, click **Update assignment**. @@ -106,9 +106,9 @@ By default, autograding tests will automatically run whenever a student pushes t {% data reusables.classroom.assignments-click-pencil %} 1. In the left sidebar, click **Grading and feedback**. 1. Below your list of autograding tests, you can configure when autograding tests are run. - - **Every time a student submits an assignment**: This is the default behavior. - - **On a schedule**: You can set a time every day or every week for autograding tests to be run. - - **Manually**: Autograding test runs will be manually triggered by you from the assignment dashboard. + * **Every time a student submits an assignment**: This is the default behavior. + * **On a schedule**: You can set a time every day or every week for autograding tests to be run. + * **Manually**: Autograding test runs will be manually triggered by you from the assignment dashboard. ## Viewing and downloading results from autograding tests @@ -126,4 +126,4 @@ You can also download a CSV of your students' autograding scores via the "Downlo ## Further reading -- [{% data variables.product.prodname_actions %} documentation](/actions) +* [{% data variables.product.prodname_actions %} documentation](/actions) diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md index 05299180cb76..183f9491ce3e 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md @@ -35,18 +35,18 @@ The Git & {% data variables.product.company_short %} starter assignment is a pre Import the starter course into your organization, name your assignment, decide whether to assign a deadline, and choose the visibility of assignment repositories. -- [Prerequisites](#prerequisites) -- [Creating the starter assignment](#creating-the-starter-assignment) - - [If there are no existing assignments in the classroom](#if-there-are-no-existing-assignments-in-the-classroom) - - [If there already are existing assignments in the classroom](#if-there-already-are-existing-assignments-in-the-classroom) -- [Setting up the basics for an assignment](#setting-up-the-basics-for-an-assignment) - - [Importing the assignment](#importing-the-assignment) - - [Naming the assignment](#naming-the-assignment) - - [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) - - [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) -- [Inviting students to an assignment](#inviting-students-to-an-assignment) -- [Next steps](#next-steps) -- [Further reading](#further-reading) +* [Prerequisites](#prerequisites) +* [Creating the starter assignment](#creating-the-starter-assignment) + * [If there are no existing assignments in the classroom](#if-there-are-no-existing-assignments-in-the-classroom) + * [If there already are existing assignments in the classroom](#if-there-already-are-existing-assignments-in-the-classroom) +* [Setting up the basics for an assignment](#setting-up-the-basics-for-an-assignment) + * [Importing the assignment](#importing-the-assignment) + * [Naming the assignment](#naming-the-assignment) + * [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment) + * [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories) +* [Inviting students to an assignment](#inviting-students-to-an-assignment) +* [Next steps](#next-steps) +* [Further reading](#further-reading) ### Importing the assignment @@ -80,9 +80,9 @@ The Git & {% data variables.product.company_short %} starter assignment is only ## Next steps -- Make additional assignments customized to your course. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)," "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)," and "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." +* Make additional assignments customized to your course. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)," "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)," and "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." ## Further reading -- "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" -- "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" +* "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" +* "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)" diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md index 41db13311885..b3b36f20f9fb 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli.md @@ -14,13 +14,13 @@ type: how_to You can work with {% data variables.product.prodname_classroom %} in the {% data variables.product.prodname_cli %} to: -- [List classrooms](#list-classrooms) -- [View classroom information](#view-classroom-information) -- [List assignments](#list-assignments) -- [List accepted assignments](#list-accepted-assignments) -- [View assignment information](#view-assignment-information) -- [Clone an assignment's starter code repository](#clone-an-assignments-starter-code-repository) -- [Clone a student’s assignment repository](#clone-a-students-assignment-repository) +* [List classrooms](#list-classrooms) +* [View classroom information](#view-classroom-information) +* [List assignments](#list-assignments) +* [List accepted assignments](#list-accepted-assignments) +* [View assignment information](#view-assignment-information) +* [Clone an assignment's starter code repository](#clone-an-assignments-starter-code-repository) +* [Clone a student’s assignment repository](#clone-a-students-assignment-repository) ## Setting up {% data variables.product.prodname_cli %} @@ -35,11 +35,11 @@ To install the {% data variables.product.prodname_classroom %} extension, run `g To use `gh` to work with {% data variables.product.prodname_classroom %}, type `gh classroom SUBCOMMAND`. As an example of a series of commands you might use to work with {% data variables.product.prodname_classroom %}, you could: -- List your classrooms:
+* List your classrooms:
`gh classroom list` -- List the assignments for a specific classroom:
+* List the assignments for a specific classroom:
`gh classroom assignments` -- View information for a specific assignment:
+* View information for a specific assignment:
`gh classroom assignment` ## `gh` subcommands for {% data variables.product.prodname_classroom %} diff --git a/content/education/quickstart.md b/content/education/quickstart.md index b9ac8954903b..4c715c42b553 100644 --- a/content/education/quickstart.md +++ b/content/education/quickstart.md @@ -83,8 +83,8 @@ With your personal account and organization account, you're ready to get started You've created a classroom, and you're ready to enrich your course with {% data variables.product.product_name %} and {% data variables.product.prodname_classroom %}! 🎉 -- Manage your classrooms and classroom admins, and create a roster of students for your classroom. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms)." -- Use the Git and {% data variables.product.company_short %} starter assignment to give students an overview of Git and {% data variables.product.product_name %} fundamentals. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment)." -- Create an assignment for individual students or teams. {% data reusables.classroom.for-more-information-about-assignment-creation %} -- Write and implement automated tests to provide immediate feedback to students directly in assignment repositories. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding)." -- Participate in {% data variables.product.prodname_education_community_with_url %}. +* Manage your classrooms and classroom admins, and create a roster of students for your classroom. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms)." +* Use the Git and {% data variables.product.company_short %} starter assignment to give students an overview of Git and {% data variables.product.product_name %} fundamentals. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment)." +* Create an assignment for individual students or teams. {% data reusables.classroom.for-more-information-about-assignment-creation %} +* Write and implement automated tests to provide immediate feedback to students directly in assignment repositories. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding)." +* Participate in {% data variables.product.prodname_education_community_with_url %}. diff --git a/content/get-started/accessibility/github-command-palette.md b/content/get-started/accessibility/github-command-palette.md index b1ad5b1a2566..394500837e65 100644 --- a/content/get-started/accessibility/github-command-palette.md +++ b/content/get-started/accessibility/github-command-palette.md @@ -29,8 +29,8 @@ The ability to run commands directly from your keyboard, without navigating thro ## Opening the {% data variables.product.prodname_command_palette %} Open the command palette using one of the following default keyboard shortcuts: -- Windows and Linux: Ctrl+K or Ctrl+Alt+K -- Mac: Command+K or Command+Option+K +* Windows and Linux: Ctrl+K or Ctrl+Alt+K +* Mac: Command+K or Command+Option+K You can customize the keyboard shortcuts you use to open the command palette in the [Accessibility section](https://github.com/settings/accessibility) of your user settings. For more information, see "[Customizing your {% data variables.product.prodname_command_palette %} keyboard shortcuts](#customizing-your-github-command-palette-keyboard-shortcuts)." @@ -41,8 +41,8 @@ When you open the command palette, it shows your location at the top left and us {% note %} **Notes:** -- If you are editing Markdown text, open the command palette with Ctrl+Alt+K (Windows and Linux) or Command+Option+K (Mac).{% ifversion projects-v2 %} -- If you are working on a {% data variables.projects.project_v2 %}, a project-specific command palette is displayed instead. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view)."{% endif %} +* If you are editing Markdown text, open the command palette with Ctrl+Alt+K (Windows and Linux) or Command+Option+K (Mac).{% ifversion projects-v2 %} +* If you are working on a {% data variables.projects.project_v2 %}, a project-specific command palette is displayed instead. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view)."{% endif %} {% endnote %} @@ -76,10 +76,10 @@ You can use the command palette to search for anything on {% data variables.loca 1. Optionally, use keystrokes to find specific types of resource: - - # Search for issues, pull requests, discussions, and projects - - ! Search for projects - - @ Search for users, organizations, and repositories - - / Search for files within a repository scope + * # Search for issues, pull requests, discussions, and projects + * ! Search for projects + * @ Search for users, organizations, and repositories + * / Search for files within a repository scope 1. Begin entering your search terms. The command palette will offer you a range of suggested searches based on your search scope. @@ -95,8 +95,8 @@ You can use the command palette to search for anything on {% data variables.loca You can use the {% data variables.product.prodname_command_palette %} to run commands. For example, you can create a new repository or issue, or change your theme. When you run a command, the location for its action is determined by either the underlying page or the scope shown in the command palette. -- Pull request and issue commands always run on the underlying page. -- Higher-level commands, for example, repository commands, run in the scope shown in the command palette. +* Pull request and issue commands always run on the underlying page. +* Higher-level commands, for example, repository commands, run in the scope shown in the command palette. For a full list of supported commands, see "[{% data variables.product.prodname_command_palette %} reference](#github-command-palette-reference)." @@ -112,8 +112,8 @@ For a full list of supported commands, see "[{% data variables.product.prodname_ When the command palette is active, you can use one of the following keyboard shortcuts to close the command palette: -- Search and navigation mode: Esc or Ctrl+K (Windows and Linux) Command+K (Mac) -- Command mode: Esc or Ctrl+Shift+K (Windows and Linux) Command+Shift+K (Mac) +* Search and navigation mode: Esc or Ctrl+K (Windows and Linux) Command+K (Mac) +* Command mode: Esc or Ctrl+Shift+K (Windows and Linux) Command+Shift+K (Mac) If you have customized the command palette keyboard shortcuts in the Accessibility settings, your customized keyboard shortcuts will be used for both opening and closing the command palette. diff --git a/content/get-started/accessibility/managing-your-theme-settings.md b/content/get-started/accessibility/managing-your-theme-settings.md index 941963a98bd7..3eb6a0a99cb8 100644 --- a/content/get-started/accessibility/managing-your-theme-settings.md +++ b/content/get-started/accessibility/managing-your-theme-settings.md @@ -32,10 +32,10 @@ If you have low vision, you may benefit from a high contrast theme, with greater ![Screenshot of the "Theme mode" sub-section. A dropdown menu, labeled "Single theme," is highlighted with an orange outline.](/assets/images/help/settings/theme-mode-drop-down-menu.png) 1. Click the theme you'd like to use. - - If you chose a single theme, click a theme. + * If you chose a single theme, click a theme. - - If you chose to follow your system settings, click a day theme and a night theme.{% ifversion fpt or ghec %} - - If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %} + * If you chose to follow your system settings, click a day theme and a night theme.{% ifversion fpt or ghec %} + * If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %} {% ifversion command-palette %} @@ -49,4 +49,4 @@ If you have low vision, you may benefit from a high contrast theme, with greater ## Further reading -- "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/setting-a-theme-for-github-desktop)" +* "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/setting-a-theme-for-github-desktop)" diff --git a/content/get-started/archiving-your-github-personal-account-and-public-repositories/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md b/content/get-started/archiving-your-github-personal-account-and-public-repositories/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md index fa840b9dfe3b..646d41cc78cc 100644 --- a/content/get-started/archiving-your-github-personal-account-and-public-repositories/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md +++ b/content/get-started/archiving-your-github-personal-account-and-public-repositories/opting-into-or-out-of-the-github-archive-program-for-your-public-repository.md @@ -24,4 +24,4 @@ If you opt out of the {% data variables.product.prodname_archive %} for a reposi ## Further reading -- [{% data variables.product.prodname_archive %} FAQ](https://archiveprogram.github.com/faq/) +* [{% data variables.product.prodname_archive %} FAQ](https://archiveprogram.github.com/faq/) diff --git a/content/get-started/exploring-integrations/about-building-integrations.md b/content/get-started/exploring-integrations/about-building-integrations.md index 55e7093a60ff..05a1e9ce3782 100644 --- a/content/get-started/exploring-integrations/about-building-integrations.md +++ b/content/get-started/exploring-integrations/about-building-integrations.md @@ -11,15 +11,15 @@ Integrations are tools that extend {% data variables.product.company_short %}'s Many integrations are {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_actions %} workflows, or custom actions for {% data variables.product.prodname_actions %} workflows. -- {% data variables.product.prodname_github_apps %} are integrations that run on the app owner's server or on a user device. For more information, see "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)." -- {% data variables.product.prodname_actions %} workflows are workflows that run when specific events occur on {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)." -- Custom actions are code that can be executed by a {% data variables.product.prodname_actions %} workflow. For more information, see "[AUTOTITLE](/actions/creating-actions/about-custom-actions)." +* {% data variables.product.prodname_github_apps %} are integrations that run on the app owner's server or on a user device. For more information, see "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)." +* {% data variables.product.prodname_actions %} workflows are workflows that run when specific events occur on {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)." +* Custom actions are code that can be executed by a {% data variables.product.prodname_actions %} workflow. For more information, see "[AUTOTITLE](/actions/creating-actions/about-custom-actions)." Your integration can use {% data variables.product.company_short %}'s API to fetch data and make changes to data on {% data variables.product.company_short %}. {% data variables.product.company_short %} has a REST API and a GraphQL API. For more information, see: -- "[AUTOTITLE](/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api)" -- "[AUTOTITLE](/rest)" -- "[AUTOTITLE](/graphql)" +* "[AUTOTITLE](/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api)" +* "[AUTOTITLE](/rest)" +* "[AUTOTITLE](/graphql)" Your integration can use webhooks to learn when specific events happen on {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/webhooks/about-webhooks)." diff --git a/content/get-started/exploring-integrations/about-using-integrations.md b/content/get-started/exploring-integrations/about-using-integrations.md index 21ff2df46fb5..621d231f8c28 100644 --- a/content/get-started/exploring-integrations/about-using-integrations.md +++ b/content/get-started/exploring-integrations/about-using-integrations.md @@ -34,8 +34,8 @@ If you want your {% data variables.product.prodname_ghe_server %} instance to us For more information about using integrations, see: -- "[AUTOTITLE](/apps/using-github-apps/about-using-github-apps)" -- "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps)" -- "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions)" +* "[AUTOTITLE](/apps/using-github-apps/about-using-github-apps)" +* "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps)" +* "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions)" You can also build your own integrations. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/about-building-integrations)." diff --git a/content/get-started/exploring-integrations/featured-github-integrations.md b/content/get-started/exploring-integrations/featured-github-integrations.md index 31579f1258b7..252e12bdb421 100644 --- a/content/get-started/exploring-integrations/featured-github-integrations.md +++ b/content/get-started/exploring-integrations/featured-github-integrations.md @@ -57,13 +57,13 @@ You can integrate your {% ifversion fpt or ghec %}personal{% elsif ghes %}user{% The Slack + {% data variables.product.prodname_dotcom %} app lets you subscribe to your repositories or organizations and get real-time updates about activity for the following features on {% data variables.location.product_location %}. -- Issues -- Pull requests -- Commits -- Discussions -- Releases -- {% data variables.product.prodname_actions %} -- Deployments +* Issues +* Pull requests +* Commits +* Discussions +* Releases +* {% data variables.product.prodname_actions %} +* Deployments You can also open and close issues, comment on your issues and pull requests, approve deployments, and see detailed references to issues and pull requests without leaving Slack. The app will also ping you personally on Slack if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. @@ -73,13 +73,13 @@ The Slack + {% data variables.product.prodname_dotcom %} app is also compatible The {% data variables.product.prodname_dotcom %} for Teams app lets you subscribe to your repositories or organizations and get real-time updates about activity for the following features on {% data variables.location.product_location %}. -- Issues -- Pull requests -- Commits -- Discussions -- Releases -- {% data variables.product.prodname_actions %} -- Deployments +* Issues +* Pull requests +* Commits +* Discussions +* Releases +* {% data variables.product.prodname_actions %} +* Deployments You can also open and close issues, comment on your issues and pull requests, approve deployments, and see detailed references to issues and pull requests without leaving Microsoft Teams. The app will also ping you personally on Teams if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. diff --git a/content/get-started/exploring-integrations/github-developer-program.md b/content/get-started/exploring-integrations/github-developer-program.md index 0b3c28d0be77..01a4451796b9 100644 --- a/content/get-started/exploring-integrations/github-developer-program.md +++ b/content/get-started/exploring-integrations/github-developer-program.md @@ -25,12 +25,12 @@ Email partnerships@github.com to re Awesome! Here’s how you can spread the word: -- Use the [Octocat or GitHub logo](https://github.com/logos) to identify that your product works with GitHub. -- Post a video or a blog on your website about your integration. +* Use the [Octocat or GitHub logo](https://github.com/logos) to identify that your product works with GitHub. +* Post a video or a blog on your website about your integration. ## Ready to join the GitHub Developer Program? Membership is open to individual developers and companies who have: -- An integration in production or development using the GitHub API. -- An email address where GitHub users can contact you for support. +* An integration in production or development using the GitHub API. +* An email address where GitHub users can contact you for support. diff --git a/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md b/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md index 170f4bc69f10..8579cae2cc23 100644 --- a/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md +++ b/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md @@ -54,5 +54,5 @@ You can contribute to an open source project by adding additional information to ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)" -- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)" +* "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard)" diff --git a/content/get-started/exploring-projects-on-github/following-organizations.md b/content/get-started/exploring-projects-on-github/following-organizations.md index 1b94f2b830d4..6552f067bff1 100644 --- a/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/content/get-started/exploring-projects-on-github/following-organizations.md @@ -36,5 +36,5 @@ You can unfollow an organization if you do not wish to see their {% ifversion fp ## Further reading -- "[AUTOTITLE](/get-started/exploring-projects-on-github/following-people)" +* "[AUTOTITLE](/get-started/exploring-projects-on-github/following-people)" {% endif %} diff --git a/content/get-started/exploring-projects-on-github/following-people.md b/content/get-started/exploring-projects-on-github/following-people.md index c11607157623..faabe5de34e2 100644 --- a/content/get-started/exploring-projects-on-github/following-people.md +++ b/content/get-started/exploring-projects-on-github/following-people.md @@ -48,6 +48,6 @@ You can unfollow someone if you do not wish to see their public activity on {% d ## Further reading -- "[AUTOTITLE](/get-started/exploring-projects-on-github/saving-repositories-with-stars)" -- "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)" +* "[AUTOTITLE](/get-started/exploring-projects-on-github/saving-repositories-with-stars)" +* "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)" {% endif %} diff --git a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md index c38dc562b3be..2ec4feaf6d68 100644 --- a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md +++ b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md @@ -121,4 +121,4 @@ You can use sorting or filtering to customize how you see starred repositories a ## Further reading -- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)" +* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics)" diff --git a/content/get-started/getting-started-with-git/about-remote-repositories.md b/content/get-started/getting-started-with-git/about-remote-repositories.md index ab7602948293..6aecf772ebc3 100644 --- a/content/get-started/getting-started-with-git/about-remote-repositories.md +++ b/content/get-started/getting-started-with-git/about-remote-repositories.md @@ -22,8 +22,8 @@ A remote URL is Git's fancy way of saying "the place where your code is stored." You can only push to two types of URL addresses: -- An HTTPS URL like `https://{% data variables.product.product_url %}/user/repo.git` -- An SSH URL, like `git@{% data variables.product.product_url %}:user/repo.git` +* An HTTPS URL like `https://{% data variables.product.product_url %}/user/repo.git` +* An SSH URL, like `git@{% data variables.product.product_url %}:user/repo.git` Git associates a remote URL with a name, and your default remote is usually called `origin`. @@ -59,8 +59,8 @@ When you `git clone`, `git fetch`, `git pull`, or `git push` to a remote reposit {% tip %} **Tips**: -- 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 "[AUTOTITLE](/get-started/getting-started-with-git/caching-your-github-credentials-in-git)." -- To clone a repository without authenticating to {% data variables.product.product_name %} on the command line, you can use {% data variables.product.prodname_desktop %} to clone instead. For more information, see "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop)." +* 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 "[AUTOTITLE](/get-started/getting-started-with-git/caching-your-github-credentials-in-git)." +* To clone a repository without authenticating to {% data variables.product.product_name %} on the command line, you can use {% data variables.product.prodname_desktop %} to clone instead. For more information, see "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop)." {% endtip %} diff --git a/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md b/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md index 0cf4e5c2fcb1..427928e2cf20 100644 --- a/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -27,8 +27,8 @@ shortTitle: Caching credentials 1. [Install](https://github.com/cli/cli#installation) {% data variables.product.prodname_cli %} on macOS, Windows, or Linux. 1. In the command line, enter `gh auth login`, then follow the prompts. - - When prompted for your preferred protocol for Git operations, select `HTTPS`. - - When asked if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials, enter `Y`. + * When prompted for your preferred protocol for Git operations, select `HTTPS`. + * When asked if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials, enter `Y`. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). diff --git a/content/get-started/getting-started-with-git/configuring-git-to-handle-line-endings.md b/content/get-started/getting-started-with-git/configuring-git-to-handle-line-endings.md index e58534266482..ad92835faeef 100644 --- a/content/get-started/getting-started-with-git/configuring-git-to-handle-line-endings.md +++ b/content/get-started/getting-started-with-git/configuring-git-to-handle-line-endings.md @@ -69,8 +69,8 @@ The `.gitattributes` file must be created in the root of the repository and comm A `.gitattributes` file looks like a table with two columns: -- On the left is the file name for Git to match. -- On the right is the line ending configuration that Git should use for those files. +* On the left is the file name for Git to match. +* On the right is the line ending configuration that Git should use for those files. ### Example @@ -95,13 +95,13 @@ Here's an example `.gitattributes` file. You can use it as a template for your r You'll notice that files are matched—`*.c`, `*.sln`, `*.png`—, separated by a space, then given a setting—`text`, `text eol=crlf`, `binary`. We'll go over some possible settings below. -- `text=auto` Git will handle the files in whatever way it thinks is best. This is a good default option. +* `text=auto` Git will handle the files in whatever way it thinks is best. This is a good default option. -- `text eol=crlf` Git will always convert line endings to `CRLF` on checkout. You should use this for files that must keep `CRLF` endings, even on OSX or Linux. +* `text eol=crlf` Git will always convert line endings to `CRLF` on checkout. You should use this for files that must keep `CRLF` endings, even on OSX or Linux. -- `text eol=lf` Git will always convert line endings to `LF` on checkout. You should use this for files that must keep LF endings, even on Windows. +* `text eol=lf` Git will always convert line endings to `LF` on checkout. You should use this for files that must keep LF endings, even on Windows. -- `binary` Git will understand that the files specified are not text, and it should not try to change them. The `binary` setting is also an alias for `-text -diff`. +* `binary` Git will understand that the files specified are not text, and it should not try to change them. The `binary` setting is also an alias for `-text -diff`. ## Refreshing a repository after changing line endings @@ -138,7 +138,7 @@ To ensure that all the line endings in your repository match your new configurat ## Further reading -- [Customizing Git - Git Attributes](https://git-scm.com/book/en/Customizing-Git-Git-Attributes) in the Pro Git book -- [git-config](https://git-scm.com/docs/git-config) in the man pages for Git -- [Getting Started - First-Time Git Setup](https://git-scm.com/book/en/Getting-Started-First-Time-Git-Setup) in the Pro Git book -- [Mind the End of Your Line](http://adaptivepatchwork.com/2012/03/01/mind-the-end-of-your-line/) by [Tim Clem](https://github.com/tclem) +* [Customizing Git - Git Attributes](https://git-scm.com/book/en/Customizing-Git-Git-Attributes) in the Pro Git book +* [git-config](https://git-scm.com/docs/git-config) in the man pages for Git +* [Getting Started - First-Time Git Setup](https://git-scm.com/book/en/Getting-Started-First-Time-Git-Setup) in the Pro Git book +* [Mind the End of Your Line](http://adaptivepatchwork.com/2012/03/01/mind-the-end-of-your-line/) by [Tim Clem](https://github.com/tclem) diff --git a/content/get-started/getting-started-with-git/ignoring-files.md b/content/get-started/getting-started-with-git/ignoring-files.md index 23471ff5b9d8..adf5cbcfed06 100644 --- a/content/get-started/getting-started-with-git/ignoring-files.md +++ b/content/get-started/getting-started-with-git/ignoring-files.md @@ -56,7 +56,7 @@ Use your favorite text editor to open the file called `.git/info/exclude` within ## Further Reading -- [Ignoring files](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) in the Git documentation -- [.gitignore](https://git-scm.com/docs/gitignore) in the Git documentation -- [A collection of useful _.gitignore_ templates](https://github.com/github/gitignore) in the github/gitignore repository -- [gitignore.io](https://www.gitignore.io/) site +* [Ignoring files](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) in the Git documentation +* [.gitignore](https://git-scm.com/docs/gitignore) in the Git documentation +* [A collection of useful _.gitignore_ templates](https://github.com/github/gitignore) in the github/gitignore repository +* [gitignore.io](https://www.gitignore.io/) site diff --git a/content/get-started/getting-started-with-git/managing-remote-repositories.md b/content/get-started/getting-started-with-git/managing-remote-repositories.md index 72d7b5f8bb1e..755e90f52fdc 100644 --- a/content/get-started/getting-started-with-git/managing-remote-repositories.md +++ b/content/get-started/getting-started-with-git/managing-remote-repositories.md @@ -29,8 +29,8 @@ shortTitle: Manage remote repositories To add a new remote, use the `git remote add` command on the terminal, in the directory your repository is stored at. The `git remote add` command takes two arguments: -- A remote name, for example, `origin` -- A remote URL, for example, `https://{% data variables.product.product_url %}/OWNER/REPOSITORY.git` +* A remote name, for example, `origin` +* A remote URL, for example, `https://{% data variables.product.product_url %}/OWNER/REPOSITORY.git` For example: @@ -56,9 +56,9 @@ $ git remote add origin https://{% data variables.product.product_url %}/octocat ``` To fix this, you can: -- Use a different name for the new remote. -- Rename the existing remote repository before you add the new remote. For more information, see "[Renaming a remote repository](#renaming-a-remote-repository)" below. -- Delete the existing remote repository before you add the new remote. For more information, see "[Removing a remote repository](#removing-a-remote-repository)" below. +* Use a different name for the new remote. +* Rename the existing remote repository before you add the new remote. For more information, see "[Renaming a remote repository](#renaming-a-remote-repository)" below. +* Delete the existing remote repository before you add the new remote. For more information, see "[Removing a remote repository](#removing-a-remote-repository)" below. ## Changing a remote repository's URL @@ -72,15 +72,15 @@ The `git remote set-url` command changes an existing remote repository URL. The `git remote set-url` command takes two arguments: -- An existing remote name. For example, `origin` or `upstream` are two common choices. -- A new URL for the remote. For example: - - If you're updating to use HTTPS, your URL might look like: +* An existing remote name. For example, `origin` or `upstream` are two common choices. +* A new URL for the remote. For example: + * If you're updating to use HTTPS, your URL might look like: ```shell https://{% data variables.product.product_url %}/OWNER/REPOSITORY.git ``` - - If you're updating to use SSH, your URL might look like: + * If you're updating to use SSH, your URL might look like: ```shell git@{% data variables.product.product_url %}:OWNER/REPOSITORY.git @@ -160,8 +160,8 @@ Check that you've correctly typed the remote name. Use the `git remote rename` command to rename an existing remote. The `git remote rename` command takes two arguments: -- An existing remote name, for example, `origin` -- A new name for the remote, for example, `destination` +* An existing remote name, for example, `origin` +* A new name for the remote, for example, `destination` ### Example of renaming a remote repository @@ -204,7 +204,7 @@ This error means that the remote name you want to use already exists. To solve t Use the `git remote rm` command to remove a remote URL from your repository. The `git remote rm` command takes one argument: -- A remote name, for example, `destination` +* A remote name, for example, `destination` Removing the remote URL from your repository only unlinks the local and remote repositories. It does not delete the remote repository. @@ -248,4 +248,4 @@ Check that you've correctly typed the remote name. ## Further reading -- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) +* ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes) diff --git a/content/get-started/getting-started-with-git/set-up-git.md b/content/get-started/getting-started-with-git/set-up-git.md index f77dca795afb..f2008586e88d 100644 --- a/content/get-started/getting-started-with-git/set-up-git.md +++ b/content/get-started/getting-started-with-git/set-up-git.md @@ -32,9 +32,9 @@ If you want to work with Git locally, but do not want to use the command line, y If you do not need to work with files locally, {% data variables.product.product_name %} lets you complete many Git-related actions directly in the browser, including: -- [AUTOTITLE](/repositories/creating-and-managing-repositories/quickstart-for-repositories) -- [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) -- [Managing files](/repositories/working-with-files/managing-files) +* [AUTOTITLE](/repositories/creating-and-managing-repositories/quickstart-for-repositories) +* [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) +* [Managing files](/repositories/working-with-files/managing-files) ## Setting up Git @@ -76,10 +76,10 @@ If you clone with SSH, you must generate SSH keys on each computer you use to pu You now have Git and {% data variables.product.prodname_dotcom %} all set up. You may now choose to create a repository where you can put your projects. Saving your code in a repository allows you to back up your code and share it around the world. -- {% data reusables.getting-started.create-a-repository %} +* {% data reusables.getting-started.create-a-repository %} -- {% data reusables.getting-started.fork-a-repository %} +* {% data reusables.getting-started.fork-a-repository %} -- {% data reusables.getting-started.being-social %} +* {% data reusables.getting-started.being-social %} -- {% data reusables.support.connect-in-the-forum-bootcamp %} +* {% data reusables.support.connect-in-the-forum-bootcamp %} diff --git a/content/get-started/getting-started-with-git/setting-your-username-in-git.md b/content/get-started/getting-started-with-git/setting-your-username-in-git.md index e933838e1b4c..27f8dd3f36ce 100644 --- a/content/get-started/getting-started-with-git/setting-your-username-in-git.md +++ b/content/get-started/getting-started-with-git/setting-your-username-in-git.md @@ -56,5 +56,5 @@ Changing the name associated with your Git commits using `git config` will only ## Further reading -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)" -- ["Git Configuration" from the _Pro Git_ book](https://git-scm.com/book/en/Customizing-Git-Git-Configuration) +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)" +* ["Git Configuration" from the _Pro Git_ book](https://git-scm.com/book/en/Customizing-Git-Git-Configuration) diff --git a/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md b/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md index c2c2a7e71613..85b63f044b35 100644 --- a/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md +++ b/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md @@ -46,4 +46,4 @@ If it's successful, nothing will print out. To test that it works, try and clone ## Further reading -- "[AUTOTITLE](/get-started/getting-started-with-git/caching-your-github-credentials-in-git)" +* "[AUTOTITLE](/get-started/getting-started-with-git/caching-your-github-credentials-in-git)" diff --git a/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md b/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md index b3f1024e7244..fec4737ffca0 100644 --- a/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md +++ b/content/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password.md @@ -20,6 +20,6 @@ You can avoid being prompted for your password by configuring Git to [cache your ## Further reading -- "[AUTOTITLE](/get-started/getting-started-with-git/about-remote-repositories)" -- "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)" -- "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent)" +* "[AUTOTITLE](/get-started/getting-started-with-git/about-remote-repositories)" +* "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github)" +* "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent)" diff --git a/content/get-started/learning-about-github/about-github-advanced-security.md b/content/get-started/learning-about-github/about-github-advanced-security.md index 6d11ae00cd55..efc9cff515b0 100644 --- a/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/content/get-started/learning-about-github/about-github-advanced-security.md @@ -34,19 +34,19 @@ shortTitle: GitHub Advanced Security A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features{% ifversion fpt %} for private repositories:{% else %}:{% endif %} -- **{% data variables.product.prodname_code_scanning_caps %}** - Search for potential security vulnerabilities and coding errors in your code using {% data variables.product.prodname_codeql %} or a third-party tool. For more information, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning)" and "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)." +* **{% data variables.product.prodname_code_scanning_caps %}** - Search for potential security vulnerabilities and coding errors in your code using {% data variables.product.prodname_codeql %} or a third-party tool. For more information, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning)" and "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)." -- **{% data variables.product.prodname_codeql_cli %}** - Run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli)." +* **{% data variables.product.prodname_codeql_cli %}** - Run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli)." -- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into {% ifversion fpt %}private repositories{% else %} the repository{% endif %}. If push protection is enabled, {% data variables.product.prodname_dotcom %} also detects secrets when they are pushed to your repository. {% ifversion secret-scanning-enable-by-default-for-public-repos %}{% data variables.secret-scanning.user_alerts_caps %} and push protection are available and free of charge for all {% ifversion ghec %}user-owned {% endif %}public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)" and "[AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations)." +* **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into {% ifversion fpt %}private repositories{% else %} the repository{% endif %}. If push protection is enabled, {% data variables.product.prodname_dotcom %} also detects secrets when they are pushed to your repository. {% ifversion secret-scanning-enable-by-default-for-public-repos %}{% data variables.secret-scanning.user_alerts_caps %} and push protection are available and free of charge for all {% ifversion ghec %}user-owned {% endif %}public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)" and "[AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations)." {% ifversion dependabot-auto-triage-rules %} -- **{% data variables.dependabot.custom_rules_caps %}** - {% data reusables.dependabot.dependabot-custom-rules-ghas %} +* **{% data variables.dependabot.custom_rules_caps %}** - {% data reusables.dependabot.dependabot-custom-rules-ghas %} {% endif %} -- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." +* **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." {% ifversion fpt or ghec %} The table below summarizes the availability of {% data variables.product.prodname_GH_advanced_security %} features for public and private repositories. @@ -124,7 +124,7 @@ You can highlight your code security knowledge by earning a {% data variables.pr ## Further reading -- "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)" +* "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)" {% endif %} {% endif %} diff --git a/content/get-started/learning-about-github/access-permissions-on-github.md b/content/get-started/learning-about-github/access-permissions-on-github.md index 33bffec09c86..fd9c063685aa 100644 --- a/content/get-started/learning-about-github/access-permissions-on-github.md +++ b/content/get-started/learning-about-github/access-permissions-on-github.md @@ -31,10 +31,10 @@ A repository owned by a personal account has two permission levels: the _reposit ## Organization accounts Organization members can have _owner_{% ifversion fpt or ghec %}, _billing manager_,{% endif %} or _member_ roles. Owners have complete administrative access to your organization{% ifversion fpt or ghec %}, while billing managers can manage billing settings{% endif %}. Member is the default role for everyone else. You can manage access permissions for multiple members at a time with teams. For more information, see: -- "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" -- "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)" -- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)" -- "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)" +* "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" +* "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)" +* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)" +* "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)" ## Enterprise accounts @@ -52,4 +52,4 @@ If an enterprise uses {% data variables.product.prodname_emus %}, members are pr ## Further reading -- "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)" +* "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)" diff --git a/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md b/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md index 5932a37f0ae8..ee136c066046 100644 --- a/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md +++ b/content/get-started/learning-about-github/faq-about-changes-to-githubs-plans.md @@ -15,15 +15,15 @@ shortTitle: Changes to GitHub plans GitHub announced the following plans and pricing changes: -- GitHub Free for organizations is immediately available and includes private repositories for unlimited users -- All organizations previously using Team for Open Source now have GitHub Free -- GitHub Free for individual developers now includes unlimited collaborators -- Organizations and individuals using GitHub Free will receive GitHub Community Support -- GitHub Pro will now include 2GB of Packages storage and 10GB of data transfer -- GitHub Pro now has a reduced monthly price of $4 -- GitHub Team now has a reduced monthly price of $4 per user -- GitHub Team no longer has a required five-seat minimum -- GitHub Team includes 3,000 Actions minutes per month for private repositories +* GitHub Free for organizations is immediately available and includes private repositories for unlimited users +* All organizations previously using Team for Open Source now have GitHub Free +* GitHub Free for individual developers now includes unlimited collaborators +* Organizations and individuals using GitHub Free will receive GitHub Community Support +* GitHub Pro will now include 2GB of Packages storage and 10GB of data transfer +* GitHub Pro now has a reduced monthly price of $4 +* GitHub Team now has a reduced monthly price of $4 per user +* GitHub Team no longer has a required five-seat minimum +* GitHub Team includes 3,000 Actions minutes per month for private repositories ## How can I upgrade my plan? @@ -35,16 +35,16 @@ To downgrade your personal account or organizations's plan, see "[AUTOTITLE](/bi ## If I downgrade from GitHub Team or a Legacy plan to GitHub Free, what features will I lose? -- Required reviewers in private repositories -- Protected branches in private repositories -- Code owners in private repositories -- GitHub Pages in private repositories -- Wikis in private repositories -- Multiple assignees for issues and pull requests in private repositories -- Multiple pull request reviewers in private repositories -- Draft pull requests in private repositories -- Autolinked references in private repositories -- Standard support +* Required reviewers in private repositories +* Protected branches in private repositories +* Code owners in private repositories +* GitHub Pages in private repositories +* Wikis in private repositories +* Multiple assignees for issues and pull requests in private repositories +* Multiple pull request reviewers in private repositories +* Draft pull requests in private repositories +* Autolinked references in private repositories +* Standard support ## How can I create a GitHub Free or GitHub Team organization? diff --git a/content/get-started/learning-about-github/github-glossary.md b/content/get-started/learning-about-github/github-glossary.md index a1dce2b215ac..82c64d2f1a30 100644 --- a/content/get-started/learning-about-github/github-glossary.md +++ b/content/get-started/learning-about-github/github-glossary.md @@ -23,6 +23,6 @@ versions: ## Further reading -- [The Official Git Glossary](https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html) -- [Git documentation](https://git-scm.com/doc) -- [Git command list](https://git-scm.com/docs) +* [The Official Git Glossary](https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html) +* [Git documentation](https://git-scm.com/doc) +* [Git command list](https://git-scm.com/docs) diff --git a/content/get-started/learning-about-github/github-language-support.md b/content/get-started/learning-about-github/github-language-support.md index 5ecea0833656..0cc995bdaa93 100644 --- a/content/get-started/learning-about-github/github-language-support.md +++ b/content/get-started/learning-about-github/github-language-support.md @@ -47,7 +47,7 @@ Some features are supported for additional languages or package managers. If you **Notes:** {% ifversion fpt or ghec %}- The language support for {% data variables.product.prodname_copilot %} varies depending on the volume and diversity of training data for that language.{% endif %} -- The support of Gradle for the dependency graph and {% data variables.product.prodname_dependabot_alerts %} is limited to the upload of data obtained using the {% data variables.dependency-submission-api.name %}. -- PHP and Scala are supported for {% data variables.product.prodname_code_scanning %} by third-party actions. +* The support of Gradle for the dependency graph and {% data variables.product.prodname_dependabot_alerts %} is limited to the upload of data obtained using the {% data variables.dependency-submission-api.name %}. +* PHP and Scala are supported for {% data variables.product.prodname_code_scanning %} by third-party actions. {% endnote %} diff --git a/content/get-started/learning-about-github/githubs-plans.md b/content/get-started/learning-about-github/githubs-plans.md index 83d398ee68ea..535557be3293 100644 --- a/content/get-started/learning-about-github/githubs-plans.md +++ b/content/get-started/learning-about-github/githubs-plans.md @@ -32,33 +32,33 @@ When you read {% data variables.product.prodname_docs %}, make sure to select th With {% data variables.product.prodname_free_team %} for personal accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set. With {% data variables.product.prodname_free_user %}, your personal account includes: -- {% data variables.product.prodname_gcf %} -- {% data variables.product.prodname_dependabot_alerts %} -- Deployment protection rules for public repositories -- Two-factor authentication enforcement -- 500 MB {% data variables.product.prodname_registry %} storage {% ifversion fpt or ghec%} -- 120 {% data variables.product.prodname_github_codespaces %} core hours per month -- 15 GB {% data variables.product.prodname_github_codespaces %} storage per month {% endif %} -- {% data variables.product.prodname_actions %} features: - - 2,000 minutes per month - - Deployment protection rules for public repositories -- GitHub Pages in public repositories +* {% data variables.product.prodname_gcf %} +* {% data variables.product.prodname_dependabot_alerts %} +* Deployment protection rules for public repositories +* Two-factor authentication enforcement +* 500 MB {% data variables.product.prodname_registry %} storage {% ifversion fpt or ghec%} +* 120 {% data variables.product.prodname_github_codespaces %} core hours per month +* 15 GB {% data variables.product.prodname_github_codespaces %} storage per month {% endif %} +* {% data variables.product.prodname_actions %} features: + * 2,000 minutes per month + * Deployment protection rules for public repositories +* GitHub Pages in public repositories ## {% data variables.product.prodname_pro %} In addition to the features available with {% data variables.product.prodname_free_user %} for personal accounts, {% data variables.product.prodname_pro %} includes: -- {% data variables.contact.github_support %} via email -- 3,000 {% data variables.product.prodname_actions %} minutes per month -- 2 GB {% data variables.product.prodname_registry %} storage {% ifversion fpt or ghec%} -- 180 {% data variables.product.prodname_github_codespaces %} core hours per month -- 20 GB {% data variables.product.prodname_github_codespaces %} storage per month {% endif %} -- Advanced tools and insights in private repositories: - - Required pull request reviewers - - Multiple pull request reviewers - - Protected branches - - Code owners - - Auto-linked references - - {% data variables.product.prodname_pages %} +* {% data variables.contact.github_support %} via email +* 3,000 {% data variables.product.prodname_actions %} minutes per month +* 2 GB {% data variables.product.prodname_registry %} storage {% ifversion fpt or ghec%} +* 180 {% data variables.product.prodname_github_codespaces %} core hours per month +* 20 GB {% data variables.product.prodname_github_codespaces %} storage per month {% endif %} +* Advanced tools and insights in private repositories: + * Required pull request reviewers + * Multiple pull request reviewers + * Protected branches + * Code owners + * Auto-linked references + * {% data variables.product.prodname_pages %} {% note %} @@ -66,8 +66,8 @@ In addition to the features available with {% data variables.product.prodname_fr {% endnote %} - - Wikis - - Repository insights graphs: Pulse, contributors, traffic, commits, code frequency, network, and forks + * Wikis + * Repository insights graphs: Pulse, contributors, traffic, commits, code frequency, network, and forks {% data reusables.repositories.repo-insights-commit-limit %} ## {% data variables.product.prodname_free_team %} for organizations @@ -75,27 +75,27 @@ In addition to the features available with {% data variables.product.prodname_fr With {% data variables.product.prodname_free_team %} for organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. In addition to the features available with {% data variables.product.prodname_free_user %} for personal accounts, {% data variables.product.prodname_free_team %} for organizations includes: -- {% data variables.product.prodname_gcf %}{% ifversion team-discussions %} -- Team discussions{% endif %} -- Team access controls for managing groups -- 2,000 {% data variables.product.prodname_actions %} minutes per month -- 500 MB {% data variables.product.prodname_registry %} storage +* {% data variables.product.prodname_gcf %}{% ifversion team-discussions %} +* Team discussions{% endif %} +* Team access controls for managing groups +* 2,000 {% data variables.product.prodname_actions %} minutes per month +* 500 MB {% data variables.product.prodname_registry %} storage ## {% data variables.product.prodname_team %} In addition to the features available with {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %} includes: -- {% data variables.contact.github_support %} via email -- 3,000 {% data variables.product.prodname_actions %} minutes per month -- 2 GB {% data variables.product.prodname_registry %} storage -- Advanced tools and insights in private repositories: - - Required pull request reviewers - - Multiple pull request reviewers - - Draft pull requests - - Team pull request reviewers - - Protected branches - - Code owners - - Scheduled reminders - - {% data variables.product.prodname_pages %} +* {% data variables.contact.github_support %} via email +* 3,000 {% data variables.product.prodname_actions %} minutes per month +* 2 GB {% data variables.product.prodname_registry %} storage +* Advanced tools and insights in private repositories: + * Required pull request reviewers + * Multiple pull request reviewers + * Draft pull requests + * Team pull request reviewers + * Protected branches + * Code owners + * Scheduled reminders + * {% data variables.product.prodname_pages %} {% note %} @@ -103,12 +103,12 @@ In addition to the features available with {% data variables.product.prodname_fr {% endnote %} - - Wikis - - Repository insights graphs: Pulse, contributors, traffic, commits, code frequency, network, and forks + * Wikis + * Repository insights graphs: Pulse, contributors, traffic, commits, code frequency, network, and forks {% data reusables.repositories.repo-insights-commit-limit %} {%- ifversion fpt or ghec %} -- The option to enable or disable {% data variables.product.prodname_github_codespaces %} - - Organization owners can choose to enable or disable {% data variables.product.prodname_github_codespaces %} for the organization's private {% ifversion ghec %}and internal {% endif %}repositories, and can pay for the usage of members and collaborators. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization)" and [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)." +* The option to enable or disable {% data variables.product.prodname_github_codespaces %} + * Organization owners can choose to enable or disable {% data variables.product.prodname_github_codespaces %} for the organization's private {% ifversion ghec %}and internal {% endif %}repositories, and can pay for the usage of members and collaborators. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization)" and [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)." {%- endif %} {% data variables.product.company_short %} bills for {% data variables.product.prodname_team %} on a per-user basis. For more information, see "[About per-user pricing]({% ifversion not fpt %}/free-pro-team@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing){% ifversion fpt %}."{% else %}" in the Free, Pro, & Team documentation.{% endif %} @@ -121,25 +121,25 @@ In addition to the features available with {% data variables.product.prodname_fr In addition to the features available with {% data variables.product.prodname_team %}, {% data variables.product.prodname_enterprise %} includes: -- {% data variables.contact.enterprise_support %} -- Additional security, compliance, and deployment controls -- Authentication with SAML single sign-on -- Access provisioning with SAML or SCIM -- Deployment protection rules with {% data variables.product.prodname_actions %} for private or internal repositories -- {% data variables.product.prodname_github_connect %} -- The option to purchase {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." -- Additional features such as internal repositories{% ifversion repo-rules %}, security overview, and repository rules{% else %} and security overview{% endif %}. +* {% data variables.contact.enterprise_support %} +* Additional security, compliance, and deployment controls +* Authentication with SAML single sign-on +* Access provisioning with SAML or SCIM +* Deployment protection rules with {% data variables.product.prodname_actions %} for private or internal repositories +* {% data variables.product.prodname_github_connect %} +* The option to purchase {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." +* Additional features such as internal repositories{% ifversion repo-rules %}, security overview, and repository rules{% else %} and security overview{% endif %}. {% data variables.product.prodname_ghe_cloud %} specifically includes: -- 50,000 {% data variables.product.prodname_actions %} minutes per month - - Included minutes can be used with standard {% data variables.product.prodname_dotcom %}-hosted runners only. For more information about billing for {% data variables.actions.hosted_runners %}, see "[AUTOTITLE](/enterprise-cloud@latest/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#understanding-billing)." -- 50 GB {% data variables.product.prodname_registry %} storage -- A service level agreement for 99.9% monthly uptime -- The option to centrally manage policy and billing for multiple {% data variables.product.prodname_dotcom_the_website %} organizations with an enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/managing-your-enterprise-account/about-enterprise-accounts)." +* 50,000 {% data variables.product.prodname_actions %} minutes per month + * Included minutes can be used with standard {% data variables.product.prodname_dotcom %}-hosted runners only. For more information about billing for {% data variables.actions.hosted_runners %}, see "[AUTOTITLE](/enterprise-cloud@latest/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#understanding-billing)." +* 50 GB {% data variables.product.prodname_registry %} storage +* A service level agreement for 99.9% monthly uptime +* The option to centrally manage policy and billing for multiple {% data variables.product.prodname_dotcom_the_website %} organizations with an enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/managing-your-enterprise-account/about-enterprise-accounts)." - - If you upgrade an existing organization to {% data variables.product.prodname_ghe_cloud %}, your enterprise account will contain your organization. For more information, see "[AUTOTITLE]({% ifversion fpt or ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/upgrading-your-accounts-plan#upgrading-your-organizations-plan)" and "[AUTOTITLE]({% ifversion fpt or ghes %}/enterprise-cloud@latest{% endif %}/admin/managing-your-enterprise-account/creating-an-enterprise-account#about-enterprise-account-creation){% ifversion fpt or ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} -- The option to provision and manage the user accounts for your developers, by using {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users)." -- Additional features such as audit log streaming and IP allow list. For more information, see "[AUTOTITLE]({% ifversion fpt and ghes %}/enterprise-cloud@latest{% endif %}/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list){% ifversion fpt or ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} + * If you upgrade an existing organization to {% data variables.product.prodname_ghe_cloud %}, your enterprise account will contain your organization. For more information, see "[AUTOTITLE]({% ifversion fpt or ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/upgrading-your-accounts-plan#upgrading-your-organizations-plan)" and "[AUTOTITLE]({% ifversion fpt or ghes %}/enterprise-cloud@latest{% endif %}/admin/managing-your-enterprise-account/creating-an-enterprise-account#about-enterprise-account-creation){% ifversion fpt or ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +* The option to provision and manage the user accounts for your developers, by using {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users)." +* Additional features such as audit log streaming and IP allow list. For more information, see "[AUTOTITLE]({% ifversion fpt and ghes %}/enterprise-cloud@latest{% endif %}/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list){% ifversion fpt or ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} For a detailed list of the features available with {% data variables.product.prodname_enterprise %}, see our [Pricing](https://github.com/pricing) page. @@ -149,4 +149,4 @@ You can set up trials to evaluate {% data variables.product.prodname_ghe_cloud % ## Further reading -- "[About per-user pricing]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing)"{% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} +* "[About per-user pricing]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing)"{% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} diff --git a/content/get-started/learning-about-github/types-of-github-accounts.md b/content/get-started/learning-about-github/types-of-github-accounts.md index 86af7098f4c2..ddbea77d6e91 100644 --- a/content/get-started/learning-about-github/types-of-github-accounts.md +++ b/content/get-started/learning-about-github/types-of-github-accounts.md @@ -24,9 +24,9 @@ topics: ## About accounts on {% data variables.product.product_name %} With {% data variables.product.product_name %}, you can store and collaborate on code. Accounts allow you to organize and control access to that code. There are three types of accounts on {% data variables.product.product_name %}. -- Personal accounts -- Organization accounts -- Enterprise accounts +* Personal accounts +* Organization accounts +* Enterprise accounts Every person who uses {% data variables.product.product_name %} signs into a personal account. An organization account enhances collaboration between multiple personal accounts, and {% ifversion fpt or ghec %}an enterprise account{% else %}the enterprise account for {% data variables.location.product_location %}{% endif %} allows central management of multiple organizations. @@ -81,6 +81,6 @@ Your enterprise account is a collection of all the organizations {% ifversion gh ## Further reading {% ifversion fpt or ghec %} -- "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)"{% endif %} -- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)" -- [Organizing people for successful collaboration](https://vimeo.com/333786093) video in {% data variables.product.company_short %} Resources +* "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)"{% endif %} +* "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)" +* [Organizing people for successful collaboration](https://vimeo.com/333786093) video in {% data variables.product.company_short %} Resources 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 6af9321352b1..18314e812b7b 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 @@ -10,8 +10,8 @@ This guide will walk you through setting up, configuring and managing your {% da {% data variables.product.prodname_dotcom %} provides two types of Enterprise products: -- **{% data variables.product.prodname_ghe_cloud %}** -- **{% data variables.product.prodname_ghe_server %}** +* **{% 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. @@ -69,8 +69,8 @@ To audit access to enterprise-owned resources or user license usage, you can vie ## Part 3: Managing security with {% data variables.product.prodname_ghe_cloud %} -- [Managing security with {% data variables.product.prodname_emus %}](#managing-security-with-enterprise-managed-users) -- [Managing security without {% data variables.product.prodname_emus %}](#managing-security-without-enterprise-managed-users) +* [Managing security with {% data variables.product.prodname_emus %}](#managing-security-with-enterprise-managed-users) +* [Managing security without {% data variables.product.prodname_emus %}](#managing-security-without-enterprise-managed-users) ### Managing security with {% data variables.product.prodname_emus %} 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 37f75c655a2a..bf80116fc770 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 @@ -9,8 +9,8 @@ This guide will walk you through setting up, configuring and managing {% data va {% 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 %}** +* **{% data variables.product.prodname_ghe_cloud %}** +* **{% data variables.product.prodname_ghe_server %}** {% 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. 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 c00fae1f7af3..844b8b8a7d06 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -133,4 +133,4 @@ You can read documentation that reflects the features available with {% data var ## Further reading -- "[AUTOTITLE](/get-started/onboarding/getting-started-with-your-github-account)" +* "[AUTOTITLE](/get-started/onboarding/getting-started-with-your-github-account)" 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 9b565745e754..f95383311202 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 @@ -236,6 +236,6 @@ For more information, see "[AUTOTITLE](/code-security/supply-chain-security)." ## Further reading -- "[AUTOTITLE](/get-started/onboarding/getting-started-with-github-team)" +* "[AUTOTITLE](/get-started/onboarding/getting-started-with-github-team)" {% endif %} {% endif %} diff --git a/content/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications.md b/content/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications.md index 568b0d28b8ea..e7bca0574b43 100644 --- a/content/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications.md +++ b/content/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications.md @@ -24,34 +24,34 @@ With {% data variables.product.prodname_certifications %}, you can showcase your With the {% data variables.product.prodname_dotcom %} Foundations certificate, you can highlight your understanding of the foundational topics and concepts of collaborating, contributing, and working on {% data variables.product.prodname_dotcom %}. This exam covers: -- Collaboration -- {% data variables.product.prodname_dotcom %} products -- Git basics -- Working within {% data variables.product.prodname_dotcom %} repositories +* Collaboration +* {% data variables.product.prodname_dotcom %} products +* Git basics +* Working within {% data variables.product.prodname_dotcom %} repositories ### {% data variables.product.prodname_actions %} Certification You can certify your proficiency in automating workflows and accelerating development with {% data variables.product.prodname_actions %} by earning a {% data variables.product.prodname_actions %} certificate. This exam covers: -- Streamlining workflows -- Automating tasks -- Optimizing software pipelines +* Streamlining workflows +* Automating tasks +* Optimizing software pipelines ### {% data variables.product.prodname_GH_advanced_security %} Certification You can highlight your code security knowledge with the {% data variables.product.prodname_GH_advanced_security %} certificate. This exam covers: -- Vulnerability identification -- Workflow security -- Security implementation +* Vulnerability identification +* Workflow security +* Security implementation ### {% data variables.product.prodname_dotcom %} Administration Certification You can certify your ability to optimize and manage a healthy {% data variables.product.prodname_dotcom %} environment with the {% data variables.product.prodname_dotcom %} Admin exam. This exam covers: -- Repository management -- Workflow optimization -- Efficient collaboration +* Repository management +* Workflow optimization +* Efficient collaboration ## Getting started with {% data variables.product.prodname_certifications %} @@ -63,5 +63,5 @@ After successful completion of a certificate exam, you will receive a Credly bad ## Further reading -- [{% data variables.product.prodname_certifications %} Program FAQs](https://examregistration.github.com/faq) -- [{% data variables.product.prodname_certifications %} - Candidate Handbook](https://examregistration.github.com/handbook) +* [{% data variables.product.prodname_certifications %} Program FAQs](https://examregistration.github.com/faq) +* [{% data variables.product.prodname_certifications %} - Candidate Handbook](https://examregistration.github.com/handbook) diff --git a/content/get-started/showcase-your-expertise-with-github-certifications/registering-for-a-github-certifications-exam.md b/content/get-started/showcase-your-expertise-with-github-certifications/registering-for-a-github-certifications-exam.md index 5e2c9bb99ce2..79e8103e15a0 100644 --- a/content/get-started/showcase-your-expertise-with-github-certifications/registering-for-a-github-certifications-exam.md +++ b/content/get-started/showcase-your-expertise-with-github-certifications/registering-for-a-github-certifications-exam.md @@ -33,9 +33,9 @@ To gain admission to the testing center or online-proctored exam, you must prese Acceptable forms include: -- International Travel Passport -- Driver's License -- Government ID card (with photo), such as state or provincial ID, visa, green card +* International Travel Passport +* Driver's License +* Government ID card (with photo), such as state or provincial ID, visa, green card If you do not have a qualifying ID issued from the country in which you are testing, a passport from your country of citizenship is required. diff --git a/content/get-started/start-your-journey/about-github-and-git.md b/content/get-started/start-your-journey/about-github-and-git.md index bb15cbc9a939..aca3e122517f 100644 --- a/content/get-started/start-your-journey/about-github-and-git.md +++ b/content/get-started/start-your-journey/about-github-and-git.md @@ -22,10 +22,10 @@ redirect_from: {% data variables.product.prodname_dotcom %} is a {% ifversion not ghes %}cloud-based {% endif %}platform where you can store, share, and work together with others to write code. Storing your code in a "repository" on {% data variables.product.prodname_dotcom %} allows you to: -- **Showcase or share** your work. -- **Track and manage** changes to your code over time. -- Let others **review** your code, and make suggestions to improve it. -- **Collaborate** on a shared project, without worrying that your changes will impact the work of your collaborators before you're ready to integrate them. +* **Showcase or share** your work. +* **Track and manage** changes to your code over time. +* Let others **review** your code, and make suggestions to improve it. +* **Collaborate** on a shared project, without worrying that your changes will impact the work of your collaborators before you're ready to integrate them. Collaborative working, one of {% data variables.product.prodname_dotcom %}’s fundamental features, is made possible by the open-source software, Git, upon which {% data variables.product.prodname_dotcom %} is built. @@ -34,10 +34,10 @@ Collaborative working, one of {% data variables.product.prodname_dotcom %}’s f Git is a version control system that intelligently tracks changes in files. Git is particularly useful when you and a group of people are all making changes to the same files at the same time. Typically, to do this in a Git-based workflow, you would: -- **Create a branch** off from the main copy of files that you (and your collaborators) are working on. -- **Make edits** to the files independently and safely on your own personal branch. -- Let Git intelligently **merge** your specific changes back into the main copy of files, so that your changes don't impact other people's updates. -- Let Git **keep track** of your and other people's changes, so you all stay working on the most up-to-date version of the project. +* **Create a branch** off from the main copy of files that you (and your collaborators) are working on. +* **Make edits** to the files independently and safely on your own personal branch. +* Let Git intelligently **merge** your specific changes back into the main copy of files, so that your changes don't impact other people's updates. +* Let Git **keep track** of your and other people's changes, so you all stay working on the most up-to-date version of the project. If you want to learn more about Git, see "[AUTOTITLE](/get-started/using-git/about-git)." @@ -51,8 +51,8 @@ However, most people work on their files locally (on their own computer), then c Once you start to collaborate with others and all need to work on the same repository at the same time, you’ll continually: -- **Pull** all the latest changes made by your collaborators from the remote repository on {% data variables.product.prodname_dotcom %}. -- **Push** back your own changes to the same remote repository on {% data variables.product.prodname_dotcom %}. +* **Pull** all the latest changes made by your collaborators from the remote repository on {% data variables.product.prodname_dotcom %}. +* **Push** back your own changes to the same remote repository on {% data variables.product.prodname_dotcom %}. Git figures out how to intelligently merge this flow of changes, and {% data variables.product.prodname_dotcom %} helps you manage the flow through features such as "pull requests." @@ -60,21 +60,21 @@ Git figures out how to intelligently merge this flow of changes, and {% data var If you're new to {% data variables.product.prodname_dotcom %}, and unfamiliar with Git, we recommend working through the articles in the "[AUTOTITLE](/get-started/start-your-journey)" category. The articles focus on tasks you can complete directly in your browser on {% data variables.product.prodname_dotcom %} and will help you to: -- **Create an account** on {% data variables.product.prodname_dotcom %}. -- **Learn the "{% data variables.product.prodname_dotcom %} Flow"**, and the key principles of collaborative working (branches, commits, pull requests, merges). -- **Personalise your profile** to share your interests and skills. -- **Explore {% data variables.product.prodname_dotcom %}** to find inspiration for your own projects and connect with others. -- Learn how to **download** interesting code for your own use. -- Learn how to **upload** something you're working on to a {% data variables.product.prodname_dotcom %} repository. +* **Create an account** on {% data variables.product.prodname_dotcom %}. +* **Learn the "{% data variables.product.prodname_dotcom %} Flow"**, and the key principles of collaborative working (branches, commits, pull requests, merges). +* **Personalise your profile** to share your interests and skills. +* **Explore {% data variables.product.prodname_dotcom %}** to find inspiration for your own projects and connect with others. +* Learn how to **download** interesting code for your own use. +* Learn how to **upload** something you're working on to a {% data variables.product.prodname_dotcom %} repository. {% ifversion fpt or ghec %} ## Next steps -- "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)" +* "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)" {% endif %} ## Further reading -- "[AUTOTITLE](/get-started/using-github/connecting-to-github)" +* "[AUTOTITLE](/get-started/using-github/connecting-to-github)" diff --git a/content/get-started/start-your-journey/creating-an-account-on-github.md b/content/get-started/start-your-journey/creating-an-account-on-github.md index 925d2c86bef6..f8ff4a7af9c3 100644 --- a/content/get-started/start-your-journey/creating-an-account-on-github.md +++ b/content/get-started/start-your-journey/creating-an-account-on-github.md @@ -40,11 +40,11 @@ If you're having problems verifying your email address, there are some troublesh ## Next steps -- Now that you've created your personal account, we'll start to explore the basics of {% data variables.product.prodname_dotcom %}. In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/hello-world)," you'll learn about repositories and how to create one, and you'll be introduced to concepts such as branching, commits, and pull requests. -- We strongly recommend that you configure 2FA for your account. 2FA is an extra layer of security that can help keep your account secure. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)." +* Now that you've created your personal account, we'll start to explore the basics of {% data variables.product.prodname_dotcom %}. In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/hello-world)," you'll learn about repositories and how to create one, and you'll be introduced to concepts such as branching, commits, and pull requests. +* We strongly recommend that you configure 2FA for your account. 2FA is an extra layer of security that can help keep your account secure. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)." ## Further reading -- "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)" -- "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)" -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)" +* "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)" +* "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)" +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)" diff --git a/content/get-started/start-your-journey/downloading-files-from-github.md b/content/get-started/start-your-journey/downloading-files-from-github.md index c84017f7f510..4d4c9f25d42c 100644 --- a/content/get-started/start-your-journey/downloading-files-from-github.md +++ b/content/get-started/start-your-journey/downloading-files-from-github.md @@ -22,9 +22,9 @@ redirect_from: {% endif %} There are different ways to get a copy of a repository's files on {% data variables.product.product_name %}. You can: -- **Download** a snapshot of a repository's files as a zip file to your own (local) computer. -- **Clone** a repository to your local computer using Git. -- **Fork** a repository to create a new repository on {% data variables.product.prodname_dotcom %}. +* **Download** a snapshot of a repository's files as a zip file to your own (local) computer. +* **Clone** a repository to your local computer using Git. +* **Fork** a repository to create a new repository on {% data variables.product.prodname_dotcom %}. Each of these methods has its own use case, which we'll explain in the next section. @@ -40,7 +40,7 @@ This tutorial focuses on downloading a repository's files to your local computer ## Prerequisites -- You must have a {% data variables.product.prodname_dotcom %} account. +* You must have a {% data variables.product.prodname_dotcom %} account. ## Downloading a repository's files @@ -56,8 +56,8 @@ You now have a copy of the repository's files saved as a zip file on your local ## Next steps -- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/uploading-a-project-to-github)," you'll learn how to upload your own files to a remote repository on {% data variables.product.product_name %}. +* In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/uploading-a-project-to-github)," you'll learn how to upload your own files to a remote repository on {% data variables.product.product_name %}. ## Further reading -- "[AUTOTITLE](/repositories/working-with-files/using-files/downloading-source-code-archives)" +* "[AUTOTITLE](/repositories/working-with-files/using-files/downloading-source-code-archives)" diff --git a/content/get-started/start-your-journey/finding-inspiration-on-github.md b/content/get-started/start-your-journey/finding-inspiration-on-github.md index bfc744a82623..c3c3239d4d42 100644 --- a/content/get-started/start-your-journey/finding-inspiration-on-github.md +++ b/content/get-started/start-your-journey/finding-inspiration-on-github.md @@ -25,10 +25,10 @@ topics: {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} is a vast open-source community. {% endif %}You can explore {% data variables.product.product_name %} to find interesting repositories, topics, code, people, and organizations that can inspire your own work, or support your own learning. Once you've found something that interests you, you can: -- **Star** the repository or topic, so you can easily find it again later. -- **Follow** people or organizations, so you can stay updated on their activities. -- **Download** useful repositories or code, and customize it for your own use. -- **Contribute** to another user's project, by opening a pull request. +* **Star** the repository or topic, so you can easily find it again later. +* **Follow** people or organizations, so you can stay updated on their activities. +* **Download** useful repositories or code, and customize it for your own use. +* **Contribute** to another user's project, by opening a pull request. Once you star repositories or follow people, you will see updates on their activities on your {% data reusables.user-settings.personal_dashboard %}. @@ -67,10 +67,10 @@ Following people and organizations on {% data variables.product.product_name %} ## Next steps -- {% data reusables.support.connect-in-the-forum-bootcamp %} -- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/downloading-files-from-github)," you'll learn how to download files from {% data variables.product.product_name %} for your own use, and learn the differences between downloading, cloning, and forking repositories. +* {% data reusables.support.connect-in-the-forum-bootcamp %} +* In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/downloading-files-from-github)," you'll learn how to download files from {% data variables.product.product_name %} for your own use, and learn the differences between downloading, cloning, and forking repositories. ## Further reading -- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard)"{% ifversion fpt or ghec %} -- "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)"{% endif %} +* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard)"{% ifversion fpt or ghec %} +* "[AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)"{% endif %} diff --git a/content/get-started/start-your-journey/git-and-github-learning-resources.md b/content/get-started/start-your-journey/git-and-github-learning-resources.md index d39a99a5c94a..87fbe55efdfe 100644 --- a/content/get-started/start-your-journey/git-and-github-learning-resources.md +++ b/content/get-started/start-your-journey/git-and-github-learning-resources.md @@ -20,28 +20,28 @@ shortTitle: Learning resources ## Using {% data variables.product.product_name %} Become better acquainted with {% data variables.product.product_name %} through our "[AUTOTITLE](/get-started/using-github)" articles: -- To review the fundamentals of a {% data variables.product.product_name %} workflow, see "[AUTOTITLE](/get-started/using-github/github-flow)." -- To learn about the various tools for working with repositories hosted on {% data variables.product.product_name %}, and how to choose a tool that best suits your needs, see "[AUTOTITLE](/get-started/using-github/connecting-to-github)." -- To understand the different communication tools on {% data variables.product.product_name %}, such as {% data variables.product.prodname_github_issues %}{% ifversion fpt or ghec %}, {% data variables.product.prodname_discussions %},{% endif %} and pull requests, see "[AUTOTITLE](/get-started/using-github/communicating-on-github)." +* To review the fundamentals of a {% data variables.product.product_name %} workflow, see "[AUTOTITLE](/get-started/using-github/github-flow)." +* To learn about the various tools for working with repositories hosted on {% data variables.product.product_name %}, and how to choose a tool that best suits your needs, see "[AUTOTITLE](/get-started/using-github/connecting-to-github)." +* To understand the different communication tools on {% data variables.product.product_name %}, such as {% data variables.product.prodname_github_issues %}{% ifversion fpt or ghec %}, {% data variables.product.prodname_discussions %},{% endif %} and pull requests, see "[AUTOTITLE](/get-started/using-github/communicating-on-github)." ## Using Git Familiarize yourself with Git through our series of articles: -- "[AUTOTITLE](/get-started/getting-started-with-git)." -- "[AUTOTITLE](/get-started/using-git)." +* "[AUTOTITLE](/get-started/getting-started-with-git)." +* "[AUTOTITLE](/get-started/using-git)." There are also lots of other online reading resources to help you learn Git: -- [Official Git project site](https://git-scm.com). -- [ProGit book](http://git-scm.com/book). -- [Git command list](https://git-scm.com/docs). +* [Official Git project site](https://git-scm.com). +* [ProGit book](http://git-scm.com/book). +* [Git command list](https://git-scm.com/docs). ## Online courses -- {% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). +* {% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). -- [Git branching](http://learngitbranching.js.org/) is a free interactive tool for learning and practising Git concepts. +* [Git branching](http://learngitbranching.js.org/) is a free interactive tool for learning and practising Git concepts. -- An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) can also teach you the basics of Git. +* An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) can also teach you the basics of Git. ## Training diff --git a/content/get-started/start-your-journey/hello-world.md b/content/get-started/start-your-journey/hello-world.md index a25ee2ccc6a4..b817cde65a5a 100644 --- a/content/get-started/start-your-journey/hello-world.md +++ b/content/get-started/start-your-journey/hello-world.md @@ -19,16 +19,16 @@ This tutorial teaches you {% data variables.product.product_name %} essentials l In this quickstart guide, you will: -- Create and use a repository. -- Start and manage a new branch. -- Make changes to a file and push them to {% data variables.product.product_name %} as commits. -- Open and merge a pull request. +* Create and use a repository. +* Start and manage a new branch. +* Make changes to a file and push them to {% data variables.product.product_name %} as commits. +* Open and merge a pull request. ### Prerequisites -- You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %} +* You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %} -- You don't need to know how to code, use the command line, or install Git (the version control software that {% data variables.product.product_name %} is built on). +* You don't need to know how to code, use the command line, or install Git (the version control software that {% data variables.product.product_name %} is built on). ## Step 1: Create a repository @@ -59,9 +59,9 @@ When you create a branch off the `main` branch, you're making a copy, or snapsho This diagram shows: -- The `main` branch -- A new branch called `feature` -- The journey that `feature` takes before it's merged into `main` +* The `main` branch +* A new branch called `feature` +* The journey that `feature` takes before it's merged into `main` ![Diagram of the two branches. The "feature" branch diverges from the "main" branch, goes through stages for "Commit changes," "Submit pull request," and "Discuss proposed changes," and is then merged back into main.](/assets/images/help/repository/branching.png) @@ -148,17 +148,17 @@ By completing this tutorial, you've learned to create a project and make a pull As part of that, we've learned how to: -- Create a repository. -- Start and manage a new branch. -- Change a file and commit those changes to {% data variables.product.product_name %}. -- Open and merge a pull request. +* Create a repository. +* Start and manage a new branch. +* Change a file and commit those changes to {% data variables.product.product_name %}. +* Open and merge a pull request. ## Next steps -- Take a look at your {% data variables.product.product_name %} profile and you'll see your work reflected on your contribution graph. -- If you want to practice the skills you've learned in this tutorial again, try the [{% data variables.product.prodname_learning %}](https://skills.github.com/) "Introduction to {% data variables.product.prodname_dotcom %}" course. -- In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile)," you'll learn how to personalize your profile and you'll also learn some basic Markdown syntax for writing on {% data variables.product.product_name %}. +* Take a look at your {% data variables.product.product_name %} profile and you'll see your work reflected on your contribution graph. +* If you want to practice the skills you've learned in this tutorial again, try the [{% data variables.product.prodname_learning %}](https://skills.github.com/) "Introduction to {% data variables.product.prodname_dotcom %}" course. +* In the next tutorial, "[AUTOTITLE](/get-started/start-your-journey/setting-up-your-profile)," you'll learn how to personalize your profile and you'll also learn some basic Markdown syntax for writing on {% data variables.product.product_name %}. ## Further reading -- "[AUTOTITLE](/get-started/using-github/github-flow)" +* "[AUTOTITLE](/get-started/using-github/github-flow)" diff --git a/content/get-started/start-your-journey/setting-up-your-profile.md b/content/get-started/start-your-journey/setting-up-your-profile.md index 989cb53a17e9..32aa4497d83d 100644 --- a/content/get-started/start-your-journey/setting-up-your-profile.md +++ b/content/get-started/start-your-journey/setting-up-your-profile.md @@ -18,9 +18,9 @@ redirect_from: Your profile page on {% data variables.product.prodname_dotcom %} is a place where people can find out more about you. You can use your profile to: -- **Share** your interests and skills. -- **Showcase** your projects and contributions. -- **Express** your identity{% ifversion fpt or ghec %} and show the {% data variables.product.prodname_dotcom %} community who you are{% endif %}. +* **Share** your interests and skills. +* **Showcase** your projects and contributions. +* **Express** your identity{% ifversion fpt or ghec %} and show the {% data variables.product.prodname_dotcom %} community who you are{% endif %}. In this tutorial, you'll learn how to personalize your profile by adding a profile picture, bio, and a profile README. @@ -28,7 +28,7 @@ You'll also learn the basics of Markdown syntax, which is what you'll use to for ### Prerequisites -- You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %} +* You must have a {% data variables.product.prodname_dotcom %} account. {% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %} ## Adding a profile picture and bio @@ -73,17 +73,17 @@ In the following steps, we'll create and edit your profile README. {% data reusables.profile.edit-profile-readme %} 1. In the "Edit" view, you'll see some pre-populated text to get you started. On line 1, delete the text that says `### Hi there` and type `# About me`. - - In Markdown syntax, `###` renders the plain text as a small ("third-level") heading, while `##` or `#` renders a second- and first-level heading respectively. + * In Markdown syntax, `###` renders the plain text as a small ("third-level") heading, while `##` or `#` renders a second- and first-level heading respectively. 1. Toggle to "Preview" to see how the plain text now renders. You should see the new text displayed as a much larger heading. 1. Toggle back to the "Edit" view. 1. Delete line 3 and line 16. - - This HTML syntax (e.g. ` diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index b5bb43a038c6..d84066053e63 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -217,5 +217,5 @@ To use a published package from {% data variables.product.prodname_registry %}, ## Further reading -- "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" -- "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" +* "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)" +* "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 0ecbcaf4caad..043727b2b9c3 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -104,8 +104,8 @@ $ npm login --scope=@NAMESPACE --auth-type=legacy --registry=https://HOSTNAME/_r **Note:** -- Package names and scopes must only use lowercase letters. -- The tarball for an npm version must be smaller than 256MB in size. +* Package names and scopes must only use lowercase letters. +* The tarball for an npm version must be smaller than 256MB in size. {% endnote %} {% else %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index 13e6b8601438..ab9740baf1cd 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -54,10 +54,10 @@ Replace `NAMESPACE` with the name of the personal account or organization {% ifv To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a _nuget.config_ file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. You must replace: -- `USERNAME` with the name of your personal account on {% data variables.product.prodname_dotcom %}. -- `TOKEN` with your {% data variables.product.pat_v1 %}. -- `NAMESPACE` with the name of the personal account or organization {% ifversion packages-nuget-v2 %}to which your packages are scoped{% else %}that owns the repository where your packages are hosted{% endif %}.{% ifversion ghes %} -- `HOSTNAME` with the host name for {% data variables.location.product_location %}.{% endif %} +* `USERNAME` with the name of your personal account on {% data variables.product.prodname_dotcom %}. +* `TOKEN` with your {% data variables.product.pat_v1 %}. +* `NAMESPACE` with the name of the personal account or organization {% ifversion packages-nuget-v2 %}to which your packages are scoped{% else %}that owns the repository where your packages are hosted{% endif %}.{% ifversion ghes %} +* `HOSTNAME` with the host name for {% data variables.location.product_location %}.{% endif %} {% ifversion ghes %}If your instance has subdomain isolation enabled: {% endif %} @@ -152,10 +152,10 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag 1. Add your project's specific information to your project's file, which ends in _.csproj_. Make sure to replace: - - `1.0.0` with the version number of the package. - - `OWNER` with the name of the personal account or organization that owns the repository to which you want to {% ifversion packages-nuget-v2 %}link your package{% else %}publish your package{% endif %}. - - `REPOSITORY` with the name of the repository to which you want to connect your package.{% ifversion ghes %} - - `HOSTNAME` with the host name for {% data variables.location.product_location %}.{% endif %} + * `1.0.0` with the version number of the package. + * `OWNER` with the name of the personal account or organization that owns the repository to which you want to {% ifversion packages-nuget-v2 %}link your package{% else %}publish your package{% endif %}. + * `REPOSITORY` with the name of the repository to which you want to connect your package.{% ifversion ghes %} + * `HOSTNAME` with the host name for {% data variables.location.product_location %}.{% endif %} ``` xml @@ -273,4 +273,4 @@ If you're using a `GITHUB_TOKEN` to authenticate to a {% data variables.product. ## Further reading -- "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" +* "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index f4dc19f15d8e..ec3fad745b0b 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -21,13 +21,13 @@ shortTitle: RubyGems registry ## Prerequisites -- You must have RubyGems 2.4.1 or higher. To find your RubyGems version: +* You must have RubyGems 2.4.1 or higher. To find your RubyGems version: ```shell gem --version ``` -- You must have bundler 1.6.4 or higher. To find your Bundler version: +* You must have bundler 1.6.4 or higher. To find your Bundler version: ```shell $ bundle --version @@ -64,10 +64,10 @@ For example, you would create or edit a _~/.gem/credentials_ to include the foll ``` To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by updating your gem sources to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY_URL{% endif %}/NAMESPACE/`. You must replace: -- `USERNAME` with your {% data variables.product.prodname_dotcom %} username. -- `TOKEN` with your {% data variables.product.pat_v1 %}. -- `NAMESPACE` with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem is scoped{% else %}that owns the repository containing the gem{% endif %}.{% ifversion ghes %} -- `REGISTRY_URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace HOSTNAME with the hostname of your {% data variables.product.prodname_ghe_server %} instance. +* `USERNAME` with your {% data variables.product.prodname_dotcom %} username. +* `TOKEN` with your {% data variables.product.pat_v1 %}. +* `NAMESPACE` with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem is scoped{% else %}that owns the repository containing the gem{% endif %}.{% ifversion ghes %} +* `REGISTRY_URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace HOSTNAME with the hostname of your {% data variables.product.prodname_ghe_server %} instance. {% endif %} If you would like your package to be available globally, you can run the following command to add your registry as a source. @@ -171,4 +171,4 @@ You can use gems from {% data variables.product.prodname_registry %} much like y ## Further reading -- "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" +* "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)"