jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-06 06:02:35 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into sm-for-all-orgs-docs

Browse Source
This commit is contained in:
Sarita Iyer
2022-07-27 17:18:50 -04:00
committed by GitHub
parent a0af09964f bf00dcb019
commit dd01e9d3fb
673 changed files with 5229 additions and 3316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
data/features/actions-stable-actor-ids.yml Normal file
View File

@@ -0,0 +1,7 @@
# Issue 7387
# Differentiating triggering actor from executing actor
versions:
fpt: '*'
ghec: '*'
ghes: '>=3.7'
ghae: 'issue-7387'

5
data/features/audit-data-retention-tab.yml Normal file
View File

@@ -0,0 +1,5 @@
# Reference #5104
# Documentation for the "Audit data retention" tab in the enterprise audit log
versions:
ghes: '>=3.4'
ghae: 'issue-5104'

4
data/features/dependency-review-action-licenses.yml Normal file
View File

@@ -0,0 +1,4 @@
# Reference: Issue #7486 Configuring the dependency review action - [Public Beta] for GHES
versions:
fpt: '*'
ghec: '*'

5
data/features/enable-git-events.yml Normal file
View File

@@ -0,0 +1,5 @@
# Reference: #7283
# Documentation for enabling Git events in the audit log
versions:
ghes: '>=3.5'
ghae: 'issue-7283'

7
data/features/file-finder-exclusion-controls.yml Normal file
View File

@@ -0,0 +1,7 @@
# Reference: Issue #7579 - Improved file finder exclusion controls
versions:
fpt: '*'
ghec: '*'
ghes: '>=3.7'
ghae: 'issue-7579'

6
data/features/git-events-audit-log.yml Normal file
View File

@@ -0,0 +1,6 @@
# Reference: #6724
# Documentation for Git events in the audit log
versions:
ghec: '*'
ghes: '>=3.5'
ghae: 'issue-6724'

5
data/features/pages-custom-workflow.yml Normal file
View File

@@ -0,0 +1,5 @@
# Issue 7066
# Publishing Pages via custom Actions workflow
versions:
fpt: '*'
ghec: '*'

8
data/features/projects-v1.yml Normal file
View File

@@ -0,0 +1,8 @@
# Issue 6980
# Projects (classic)
# n.b. /managing-project-boards/copying-a-project-board.md retains ghec/fpt versioning.
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'

6
data/features/projects-v2.yml Normal file
View File

@@ -0,0 +1,6 @@
# Issue 6980
# ProjectV2 GA
versions:
fpt: '*'
ghec: '*'
ghae: 'issue-6980'

2
data/release-notes/enterprise-server/3-5/0-rc1.yml
View File

@@ -291,7 +291,7 @@ sections:
- `git.fetch`
- `git.push`
Due to the large number of Git events logged, we recommend you monitor your instance's file storage and review your related alert configurations. For more information, see "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#git-category-actions)" and "[Monitoring storage](/admin/enterprise-management/monitoring-your-appliance/recommended-alert-thresholds#monitoring-storage)."
Due to the large number of Git events logged, we recommend you monitor your instance's file storage and review your related alert configurations. For more information, see "[Configuring the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise#managing-git-events-in-the-audit-log)."
- heading: Improvements to CODEOWNERS
notes:

4
data/release-notes/enterprise-server/3-5/0.yml
View File

@@ -284,8 +284,8 @@ sections:
- `git.fetch`
- `git.push`
Due to the large number of Git events logged, we recommend you monitor your instance's file storage and review your related alert configurations. For more information, see "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#git-category-actions)" and "[Monitoring storage](/admin/enterprise-management/monitoring-your-appliance/recommended-alert-thresholds#monitoring-storage)."
Due to the large number of Git events logged, we recommend you monitor your instance's file storage and review your related alert configurations. For more information, see "[Configuring the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise#managing-git-events-in-the-audit-log)."
- heading: Improvements to CODEOWNERS
notes:
# https://github.com/github/releases/issues/1994

3
data/reusables/audit_log/audit-data-retention-tab.md Normal file
View File

@@ -0,0 +1,3 @@
1. Under "Audit log", click **Audit Data Retention**.
![Screenshot of the "Audit Data Retention" tab](/assets/images/help/enterprises/audit-data-retention-tab.png)

1
data/reusables/audit_log/audit-log-action-categories.md
View File

@@ -61,7 +61,6 @@
| `external_identity` | Contains activities related to a user in an Okta group.
{%- endif %}
| `gist` | Contains activities related to Gists.
| `git` | Contains activities related to Git events.
| `hook` | Contains activities related to webhooks.
| `integration` | Contains activities related to integrations in an account.
| `integration_installation` | Contains activities related to integrations installed in an account.

7
data/reusables/audit_log/git-events-not-in-search-results.md Normal file
View File

@@ -0,0 +1,7 @@
{% ifversion git-events-audit-log %}
{% note %}
**Note:** Git events are not included in search results.
{% endnote %}
{% endif %}

2
data/reusables/audit_log/retention-periods.md
View File

@@ -1,3 +1,3 @@
The audit log lists events triggered by activities that affect your enterprise{% ifversion not ghec %}. Audit logs for {% data variables.product.product_name %} are retained indefinitely.{% else %} within the current month and up to the previous six months. The audit log retains Git events for seven days.{% endif %}
The audit log lists events triggered by activities that affect your enterprise{% ifversion not ghec %}. Audit logs for {% data variables.product.product_name %} are retained indefinitely{% ifversion audit-data-retention-tab %}, unless an enterprise owner configured a different retention period. For more information, see "[Configuring the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise)."{% else %}.{% endif %}{% else %} within the current month and up to the previous six months. The audit log retains Git events for seven days.{% endif %}
{% data reusables.audit_log.only-three-months-displayed %}

12
data/reusables/copilot/dotcom-settings.md
View File

@@ -2,7 +2,9 @@
Once you have an active {% data variables.product.prodname_copilot %} trial or subscription, you can adjust {% data variables.product.prodname_copilot %} settings for your personal account on {% data variables.product.prodname_dotcom %} in the [{% data variables.product.prodname_copilot %} settings](https://github.com/settings/copilot). The settings apply anywhere that you use {% data variables.product.prodname_copilot %}. You can configure the suggestions that {% data variables.product.prodname_copilot %} offers and how {% data variables.product.company_short %} uses your telemetry data.
### Enabling or disabling duplication detection
## Enabling or disabling duplication detection
{% data variables.product.prodname_copilot %} includes a filter which detects code suggestions matching public code on {% data variables.product.prodname_dotcom %}. You can choose to enable or disable the filter. When the filter is enabled, {% data variables.product.prodname_copilot %} checks code suggestions with their surrounding code of about 150 characters against public code on {% data variables.product.prodname_dotcom %}. If there is a match or near match, the suggestion will not be shown to you.
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.copilot-settings %}
@@ -10,12 +12,16 @@ Once you have an active {% data variables.product.prodname_copilot %} trial or s
![Screenshot of duplication detection option](/assets/images/help/copilot/duplication-detection.png)
{% data reusables.copilot.save-settings %}
### Enabling or disabling telemetry
## Enabling or disabling telemetry
You can configure how {% data variables.product.prodname_copilot %} uses your data. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your telemetry settings, see "[{% data variables.product.company_short %} Terms for Additional Products and Features](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)."
You can choose whether your code snippets are collected and retained by GitHub and further processed and shared with Microsoft and OpenAI by adjusting your user settings. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your telemetry settings, see "[{% data variables.product.company_short %} Terms for Additional Products and Features](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq-privacy).
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.copilot-settings %}
1. To allow or prevent {% data variables.product.prodname_dotcom %} using your telemetry data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets for product improvements**.
![Screenshot of telemetry option](/assets/images/help/copilot/telemetry-option.png)
{% data reusables.copilot.save-settings %}
## Further reading
- [{% data variables.product.prodname_copilot %} FAQ](https://github.com/features/copilot/#faq)

3
data/reusables/dependency-review/action-enterprise.md Normal file
View File

@@ -0,0 +1,3 @@
{% ifversion ghes or ghae %}
Enterprise owners and people with admin access to a repository can add the {% data variables.product.prodname_dependency_review_action %} to their enterprise and repository, respectively.
{% endif %}

18
data/reusables/gated-features/code-scanning.md
View File

@@ -1,7 +1,13 @@
{% ifversion fpt %} {% data variables.product.prodname_code_scanning_capc %} is available for all public repositories. {% data variables.product.prodname_code_scanning_capc %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}.
{%- elsif ghec %} {% data variables.product.prodname_code_scanning_capc %} is available for all public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.
{%- elsif ghes %}{% data variables.product.prodname_code_scanning_capc %} is available for organization-owned repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled.
{%- ifversion fpt %}
{% data variables.product.prodname_code_scanning_capc %} is available for all public repositories on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_code_scanning_capc %} is also available for private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}.
{%- elsif ghec %}
{% data variables.product.prodname_code_scanning_capc %} is available for all public repositories on {% data variables.product.prodname_dotcom_the_website %}. To use {% data variables.product.prodname_code_scanning %} in a private repository owned by an organization, you must have a license for {% data variables.product.prodname_GH_advanced_security %}.
{%- elsif ghes %}
{% data variables.product.prodname_code_scanning_capc %} is available for organization-owned repositories in {% data variables.product.product_name %}. This feature requires a license for {% data variables.product.prodname_GH_advanced_security %}.
{%- elsif ghae %}
{% data variables.product.prodname_code_scanning_capc %} is available as part of {% data variables.product.prodname_GH_advanced_security %}, which is free during the beta release.
{%- else %}
{% data variables.product.prodname_code_scanning_capc %} is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %}
{% data variables.product.prodname_code_scanning_capc %} is available for organization-owned repositories in {% data variables.product.product_name %}. This is a {% data variables.product.prodname_GH_advanced_security %} feature (free during the beta release).
{%- endif %} For more information, see "[GitHub's products](/articles/githubs-products)."

2
data/reusables/gated-features/copilot.md
View File

@@ -1 +1 @@
{% data variables.product.prodname_copilot %} is available to {% data variables.product.company_short %} customers with a personal account on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_copilot %} is free to use for verified students and open source maintainers. If you are not a student or open source maintainer, you can try {% data variables.product.prodname_copilot %} for free with a one-time 60 day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[About billing for {% data variables.product.prodname_copilot %}](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)."
{% data variables.product.prodname_copilot %} is available to {% data variables.product.company_short %} customers with a personal account on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_copilot %} is free to use for verified students and maintainers of popular open source projects. If you are not a student or maintainer of a popular open source project, you can try {% data variables.product.prodname_copilot %} for free with a one-time 60 day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[About billing for {% data variables.product.prodname_copilot %}](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)."

1
data/reusables/gated-features/historical-insights-for-projects.md Normal file
View File

@@ -0,0 +1 @@
Historical charts are available with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations. You can save unlimited charts in private projects with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations and {% data variables.product.prodname_pro %} for users. Users and organizations using a public project can also save unlimited charts. Users and organizations using {% data variables.product.prodname_free_team %} or a legacy plan can save two charts in private projects. {% data reusables.gated-features.more-info %}

2
data/reusables/pages/admin-must-push.md
View File

@@ -1,5 +1,5 @@
{% tip %}
**Note**: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.
**Note**: {% ifversion pages-custom-workflow %}If you are publishing from a branch and{% else %}If{% endif %} your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.
{% endtip %}

2
data/reusables/pages/check-workflow-run.md
View File

@@ -1,5 +1,5 @@
{% ifversion fpt %}
1. If your {% data variables.product.prodname_pages %} site is built from a public repository, it is built and deployed with a {% data variables.product.prodname_actions %} workflow run unless you've configured your {% data variables.product.prodname_pages %} site to use a different CI tool. For more information about how to view the workflow status, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
1. Unless your {% data variables.product.prodname_pages %} site is built from a private or internal repository and published from a branch, your site is built and deployed with a {% data variables.product.prodname_actions %} workflow. For more information about how to view the workflow status, see "[Viewing workflow run history](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."
{% note %}

2
data/reusables/pages/configure-publishing-source.md
View File

@@ -1 +1 @@
1. Configure your publishing source. For more information, see "[Configuring a publishing source for your {% data variables.product.prodname_pages %} site](/articles/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source)."
1. Configure your publishing source. For more information, see "[Configuring a publishing source for your {% data variables.product.prodname_pages %} site](/articles/configuring-a-publishing-source-for-your-github-pages-site)."

2
data/reusables/pages/decide-publishing-source.md
View File

@@ -1 +1 @@
1. Decide which publishing source you want to use. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)."
1. Decide which publishing source you want to use. For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."

2
data/reusables/pages/navigate-publishing-source.md
View File

@@ -1 +1 @@
1. Navigate to the publishing source for your site. For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)."
1. Navigate to the publishing source for your site. For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."

4
data/reusables/pages/new-or-existing-repo.md
View File

@@ -1,4 +1,6 @@
If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code to that project's repository, in a `/docs` folder on the default branch or on a different branch. For example, if you're creating a site to publish documentation for a project that's already on {% data variables.product.product_name %}, you may want to store the source code for the site in the same repository as the project.
You can either create a repository or choose an existing repository for your site.
If you want to create a {% data variables.product.prodname_pages %} site for a repository where not all of the files in the repository are related to the site, you will be able to configure a publishing source for your site. For example, you can have a dedicated branch and folder to hold your site source files{% ifversion pages-custom-workflow %}, or you can use a custom {% data variables.product.prodname_actions %} workflow to build and deploy your site source files{% endif %}.
{% ifversion fpt or ghec %}If the account that owns the repository uses {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_free_team %} for organizations, the repository must be public.{% endif %}

1
data/reusables/pages/pages-about-branch-source.md Normal file
View File

@@ -0,0 +1 @@
You can specify which branch and folder to use as your publishing source. The source branch can be any branch in your repository, and the source folder can either be the root of the repository (`/`) on the source branch or a `/docs` folder on the source branch. Whenever changes are pushed to the source branch, the changes in the source folder will be published to your {% data variables.product.prodname_pages %} site.

13
data/reusables/pages/pages-about-publishing-source.md Normal file
View File

@@ -0,0 +1,13 @@
{% ifversion pages-custom-workflow %}
You can publish your site when changes are pushed to a specific branch, or you can write a {% data variables.product.prodname_actions %} workflow to publish your site.
If you do not need any control over the build process for your site, we recommend that you publish your site when changes are pushed to a specific branch. {% data reusables.pages.pages-about-branch-source %}
If you want to use a build process other than Jekyll or you do not want a dedicated branch to hold your compiled static files, we recommend that you write a {% data variables.product.prodname_actions %} workflow to publish your site. {% data variables.product.product_name %} provides starter workflows for common publishing scenarios to help you write your workflow.
{% else %}
Your {% data variables.product.prodname_pages %} site will publish whenever changes are pushed to a specific branch. {% data reusables.pages.pages-about-branch-source %}
{% endif %}

9
data/reusables/pages/pages-custom-workflow-beta.md Normal file
View File

@@ -0,0 +1,9 @@
{% ifversion pages-custom-workflow %}
{% note %}
Note: Publishing your {% data variables.product.prodname_pages %} site with a custom {% data variables.product.prodname_actions %} workflow is in beta and subject to change.
{% endnote %}
{% endif %}

2
data/reusables/pages/test-locally.md
View File

@@ -1 +1 @@
Changes to your site are published automatically when the changes are merged into your site's publishing source. If you want to preview your changes first, you can make the changes locally instead of on {% data variables.product.product_name %}. Then, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)."
{% ifversion pages-custom-workflow %}If you are publishing from a branch, changes{% else %}Changes{% endif %} to your site are published automatically when the changes are merged into your site's publishing source. {% ifversion pages-custom-workflow %}If you are publishing from a custom {% data variables.product.prodname_actions %} workflow, changes are published whenever your workflow is triggered (typically by a push to the default branch). {% endif %}If you want to preview your changes first, you can make the changes locally instead of on {% data variables.product.product_name %}. Then, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)."

2
data/reusables/project-management/automate-project-board-permissions.md
View File

@@ -1 +1 @@
To set up automatic workflows for a repository project board, you must have write access to the repository. Organization owners and members can configure automatic workflows on an organization-wide project board.
To set up automatic workflows for a repository {% data variables.projects.projects_v1_board %}, you must have write access to the repository. Organization owners and members can configure automatic workflows on an organization-wide {% data variables.projects.projects_v1_board %}.

2
data/reusables/project-management/cascading-permissions.md
View File

@@ -1 +1 @@
If a person has multiple avenues of access to an organization project board (individually, through a team, or as an organization member), the highest project board permission level overrides lower permission levels.
If a person has multiple avenues of access to an organization {% data variables.projects.projects_v1_board %} (individually, through a team, or as an organization member), the highest {% data variables.projects.projects_v1_board %} permission level overrides lower permission levels.

2
data/reusables/project-management/click-menu.md
View File

@@ -1 +1 @@
1. On the top-right side of the project board, click {% octicon "three-bars" aria-label="The three-bars octicon" %} **Menu**.
1. On the top-right side of the {% data variables.projects.projects_v1_board %}, click {% octicon "three-bars" aria-label="The three-bars octicon" %} **Menu**.

2
data/reusables/project-management/copy-project-boards.md
View File

@@ -1,3 +1,3 @@
{% ifversion fpt or ghec %}
You can also copy a project board to reuse its customizations for similar projects. For more information, see "[Copying a project board](/articles/copying-a-project-board)."
You can also copy a {% data variables.projects.projects_v1_board %} to reuse its customizations for similar projects. For more information, see "[Copying a {% data variables.product.prodname_project_v1 %}](/articles/copying-a-project-board)."
{% endif %}

2
data/reusables/project-management/edit-in-project.md
View File

@@ -1 +1 @@
You can view and make lightweight edits to issues and pull requests within your project board by clicking on the issue or pull request's title.
You can view and make lightweight edits to issues and pull requests within your {% data variables.projects.projects_v1_board %} by clicking on the issue or pull request's title.

2
data/reusables/project-management/link-repos-to-project-board.md
View File

@@ -1 +1 @@
You can link up to twenty-five repositories to your organization or user-owned project board. Linking repositories makes it easier to add issues and pull requests from those repositories to your project board using **{% octicon "plus" aria-label="The Plus icon" %} Add cards** or from the issue or pull requests sidebar.
You can link up to twenty-five repositories to your organization or user-owned {% data variables.projects.projects_v1_board %}. Linking repositories makes it easier to add issues and pull requests from those repositories to your {% data variables.projects.projects_v1_board %} using **{% octicon "plus" aria-label="The Plus icon" %} Add cards** or from the issue or pull requests sidebar.

6
data/reusables/project-management/project-board-permissions.md
View File

@@ -1,3 +1,3 @@
- **Read**, which gives people permission to view a project board.
- **Write**, which gives people permission to view a project board, link repositories to a project board, and interact with a project board. For more information, see "[Linking a repository to a project board](/articles/linking-a-repository-to-a-project-board)."
- **Admin**, which gives people permission to view a project board, interact with a project board, manage project board settings, and manage other people's access to the project board.
- **Read**, which gives people permission to view a {% data variables.projects.projects_v1_board %}.
- **Write**, which gives people permission to view a {% data variables.projects.projects_v1_board %}, link repositories to a {% data variables.projects.projects_v1_board %}, and interact with a {% data variables.projects.projects_v1_board %}. For more information, see "[Linking a repository to a {% data variables.product.prodname_project_v1 %}](/articles/linking-a-repository-to-a-project-board)."
- **Admin**, which gives people permission to view a {% data variables.projects.projects_v1_board %}, interact with a {% data variables.projects.projects_v1_board %}, manage {% data variables.projects.projects_v1_board %} settings, and manage other people's access to the {% data variables.projects.projects_v1_board %}.

2
data/reusables/project-management/project-board-visibility.md
View File

@@ -1 +1 @@
By default, user-owned and organization-wide project boards are private and only visible to people with read, write, or admin permissions to the project board. {% ifversion ghae %}An internal{% else %}A public{% endif %} project board is visible to {% ifversion ghae %}anyone with access to your enterprise on {% data variables.product.prodname_ghe_managed %}{% elsif ghes %}anyone with access to your {% data variables.product.prodname_ghe_server %} instance{% else %}anyone with the project board's URL{% endif %}. Repository-level project boards share the visibility of their repository. That is, a private repository will have a private board, and this visibility cannot be changed.
By default, user-owned and organization-wide {% data variables.projects.projects_v1_boards %} are private and only visible to people with read, write, or admin permissions to the {% data variables.projects.projects_v1_board %}. {% ifversion ghae %}An internal{% else %}A public{% endif %} {% data variables.projects.projects_v1_board %} is visible to {% ifversion ghae %}any with access to your enterprise{% else %}anyone{% endif %} with the {% data variables.projects.projects_v1_board %}'s URL. Repository-level {% data variables.projects.projects_v1_boards %} share the visibility of their repository. That is, a private repository will have a private project, and this visibility cannot be changed.

2
data/reusables/project-management/project-progress-locations.md
View File

@@ -1 +1 @@
If progress tracking is enabled, a progress bar appears above the project board, on the project listing page, in the issue sidebar, and in references to the project on other project boards.
If progress tracking is enabled, a progress bar appears above the {% data variables.projects.projects_v1_board %}, on the project listing page, in the issue sidebar, and in references to the project on other {% data variables.projects.projects_v1_boards %}.

2
data/reusables/project-management/resync-automation.md
View File

@@ -1 +1 @@
When you close a project board, any workflow automation configured for the project board will pause. If you reopen a project board, you have the option to sync automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[Closing a project board](/articles/closing-a-project-board)."
When you close a {% data variables.projects.projects_v1_board %}, any workflow automation configured for the {% data variables.projects.projects_v1_board %} will pause. If you reopen a {% data variables.projects.projects_v1_board %}, you have the option to sync automation, which updates the position of the cards on the board according to the automation settings configured for the project. For more information, see "[Reopening a closed {% data variables.product.prodname_project_v1 %}](/articles/reopening-a-closed-project-board)" or "[Closing a {% data variables.product.prodname_project_v1 %}](/articles/closing-a-project-board)."

2
data/reusables/project-management/select-project.md
View File

@@ -1,2 +1,2 @@
1. In the projects list, click the name of the project board.
1. In the projects list, click the name of the {% data variables.projects.projects_v1_board %}.
![Select project](/assets/images/help/projects/select-project.png)

2
data/reusables/project-management/use-automated-template.md
View File

@@ -1 +1 @@
You can use a project board template to create a project board with automation already configured. For more information, see "[About project boards](/articles/about-project-boards#templates-for-project-boards)."
You can use a {% data variables.projects.projects_v1_board %} template to create a {% data variables.projects.projects_v1_board %} with automation already configured. For more information, see "[About {% data variables.product.prodname_projects_v1 %}](/articles/about-project-boards#templates-for-project-boards)."

2
data/reusables/projects/about-workflows.md
View File

@@ -1,3 +1,3 @@
Projects (beta) includes built-in workflows that you can use to update the **Status** of items based on certain events. For example, you can automatically set the status to **Todo** when an item is added to your project or set the status to **Done** when an issue is closed.
{% data variables.product.prodname_projects_v2 %} includes built-in workflows that you can use to update the **Status** of items based on certain events. For example, you can automatically set the status to **Todo** when an item is added to your project or set the status to **Done** when an issue is closed.
When your project initializes, two workflows are enabled by default: When issues or pull requests in your project are closed, their status is set to **Done**, and when pull requests in your project are merged, their status is set to **Done**.

7
data/reusables/projects/access-insights.md
View File

@@ -1,8 +1,3 @@
1. Navigate to your project.
2. In the top-right, to access insights, click {% octicon "graph" aria-label="the graph icon" %}.
{% note %}
**Note:** This feature is currently in a private preview and only available for some organizations. If the {% octicon "graph" aria-label="the graph icon" %} icon is not displayed in your project, insights is not yet enabled for your organization.
{% endnote %}
![Screenshot showing the insights icon](/assets/images/help/projects-v2/insights-button.png)

4
data/reusables/projects/add-draft-issue.md Normal file
View File

@@ -0,0 +1,4 @@
{% data reusables.projects.add-item-bottom-row %}
1. Type your idea, then press **Enter**.
![Screenshot showing pasting an issue URL to add it to the project](/assets/images/help/projects-v2/add-draft-issue.png)
1. To add body text, click on the title of the draft issue. In the markdown input box that appears, enter the text for the draft issue body, then click **Save**.

2
data/reusables/projects/add-item-bottom-row.md Normal file
View File

@@ -0,0 +1,2 @@
1. Place your cursor in the bottom row of the project, next to the {% octicon "plus" aria-label="plus icon" %}.
![Screenshot showing the bottom row to add an item](/assets/images/help/projects-v2/add-item.png)

4
data/reusables/projects/add-item-via-paste.md Normal file
View File

@@ -0,0 +1,4 @@
{% data reusables.projects.add-item-bottom-row %}
1. Paste the URL of the issue or pull request.
![Screenshot showing pasting an issue URL to add it to the project](/assets/images/help/projects-v2/paste-url-to-add.png)
3. To add the issue or pull request, press <kbd>Return</kbd>.

6
data/reusables/projects/bulk-add.md Normal file
View File

@@ -0,0 +1,6 @@
1. Optionally, to change the repository, click the dropdown and select a repository. You can also search for specific issues and pull requests.
![Screenshot showing repository dropdown](/assets/images/help/projects-v2/add-bulk-select-repo.png)
1. Select the issues and pull requests you want to add.
![Screenshot showing selecting issues and pull requests to add](/assets/images/help/projects-v2/add-bulk-select-issues.png)
1. Click **Add selected items**.
![Screenshot showing "add selected items" button](/assets/images/help/projects-v2/add-bulk-save.png)

13
data/reusables/projects/create-project.md
View File

@@ -1,8 +1,9 @@
1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your organization.
1. Click {% octicon "table" aria-label="The project icon" %} **Projects**.
1. Select the **New project** drop-down menu and click **New project (Beta)**.
![New project](/assets/images/help/issues/new_project_beta.png)
1. When prompted to select a template, click a template or, to start with an empty project, click "Table" or "Board". Then, click **Create**.
{% data reusables.profile.access_org %}
{% data reusables.user-settings.access_org %}
1. Under your organization name, click {% octicon "table" aria-label="The project icon" %} **Projects**.
![Screenshot showing the 'Projects' tab](/assets/images/help/projects-v2/tab-projects.png)
1. Click **New project**.
![Screenshot showing New project button](/assets/images/help/projects-v2/new-project-button.png)
1. When prompted to select a template, click a template or, to start with an empty project, click **Table** or **Board**. Then, click **Create**.
![Screenshot showing template selection modal](/assets/images/help/issues/projects-select-template.png)

11
data/reusables/projects/create-user-project.md
View File

@@ -1,7 +1,8 @@
1. On any {% data variables.product.product_name %} page, click on your avatar, then select **Your projects**.
1. Select the **New project** drop-down menu and click **New project (Beta)**.
![New project](/assets/images/help/issues/new_project_beta.png)
1. When prompted to select a template, click a template or, to start with an empty project, click "Table" or "Board". Then, click **Create**.
{% data reusables.profile.access_profile %}
1. On your profile, click {% octicon "table" aria-label="The project icon" %} **Projects**.
![Screenshot showing the 'Projects' tab](/assets/images/help/projects-v2/tab-projects.png)
1. Click **New project**.
![New project](/assets/images/help/projects-v2/new-project-button.png)
1. When prompted to select a template, click a template or, to start with an empty project, click **Table** or **Board**. Then, click **Create**.
![Screenshot showing template selection modal](/assets/images/help/issues/projects-select-template.png)

6
data/reusables/projects/enable-basic-workflow.md
View File

@@ -1,7 +1,13 @@
1. Navigate to your project.
1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu.
![Screenshot showing the menu icon](/assets/images/help/projects-v2/open-menu.png)
1. In the menu, click {% octicon "workflow" aria-label="The workflow icon" %} **Workflows**.
![Screenshot showing the 'Workflows' menu item](/assets/images/help/projects-v2/workflows-menu-item.png)
1. Under **Default workflows**, click on the workflow that you want to edit.
![Screenshot showing default workflows](/assets/images/help/projects-v2/default-workflows.png)
1. If the workflow can apply to both issues and pull requests, next to **When**, check the item type(s) that you want to act on.
![Screenshot showing the "when" configuration for a workflow](/assets/images/help/projects-v2/workflow-when.png)
1. Next to **Set**, choose the value that you want to set the status to.
![Screenshot showing the "set" configuration for a workflow](/assets/images/help/projects-v2/workflow-set.png)
1. If the workflow is disabled, click the toggle next to **Disabled** to enable the workflow.
![Screenshot showing the "enable" control for a workflow](/assets/images/help/projects-v2/workflow-enable.png)

8
data/reusables/projects/migrate-project-steps.md
View File

@@ -1,7 +1,7 @@
1. Next to the project you want to migrate, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu.
1. In the menu, click **Migrate to beta**.
![Screenshot showing migrate to beta option](/assets/images/help/issues/migrate-to-beta.png)
1. In the menu, click **Migrate**.
![Screenshot showing migrate option](/assets/images/help/issues/migrate-menu-item.png)
1. In the the popup, select what you want to happen to the project after it is migrated. We recommend selecting "Close the old project" so it's clear which project is in use.
![Screenshot showing migrate to beta option](/assets/images/help/issues/migrate-option.png)
![Screenshot showing migrate modal](/assets/images/help/issues/migrate-option.png)
1. In the bottom right of the popup, click **Start migration**.
![Screenshot showing migrate to beta option](/assets/images/help/issues/migrate-start.png)
![Screenshot showing start migration button](/assets/images/help/issues/migrate-start.png)

6
data/reusables/projects/new-field.md Normal file
View File

@@ -0,0 +1,6 @@
1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}.
![Screenshot showing new field button](/assets/images/help/projects-v2/new-field-button.png)
1. Click **New field**.
![Screenshot showing new field menu item](/assets/images/help/projects-v2/new-field-menu-item.png)
1. Type the name of your new field.
![Screenshot showing the field name](/assets/images/help/projects-v2/new-field-name.png)

2
data/reusables/projects/new-view.md Normal file
View File

@@ -0,0 +1,2 @@
1. To the right of your existing views, click **New view**
![Screenshot showing the column field menu](/assets/images/help/projects-v2/new-view.png)

1
data/reusables/projects/open-item-menu.md Normal file
View File

@@ -0,0 +1 @@
1. Select the {% octicon "triangle-down" aria-label="the item menu" %} (in table layout) or the {% octicon "kebab-horizontal" aria-label="the item menu" %} (in board layout).

2
data/reusables/projects/open-view-menu.md Normal file
View File

@@ -0,0 +1,2 @@
1. Click {% octicon "triangle-down" aria-label="the drop-down icon" %} next to the name of the currently open view.
![Screenshot showing the view menu icon](/assets/images/help/projects-v2/view-menu-icon.png)

3
data/reusables/projects/project-description.md
View File

@@ -2,9 +2,12 @@ You can set your project's description and README to share the purpose of your p
{% data reusables.projects.project-settings %}
1. To add a short description to your project, under "Add a description", type your description in the text box and click **Save**.
![Screenshot showing the 'Add my description' settings](/assets/images/help/projects-v2/edit-description.png)
1. To update your project's README, under "README", type your content in the text box.
- You can format your README using Markdown. For more information, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)."
- To toggle between the text box and a preview of your changes, click {% octicon "eye" aria-label="The preview icon" %} or {% octicon "pencil" aria-label="The edit icon" %}.
![Screenshot showing editing a project's README](/assets/images/help/projects-v2/edit-readme.png)
1. To save changes to your README, click **Save**.
![Screenshot showing the 'Save' button for a project's README](/assets/images/help/projects-v2/save-readme-button.png)
You can view and make quick changes to your project description and README by navigating to your project and clicking {% octicon "sidebar-expand" aria-label="The sidebar icon" %} in the top right.

4
data/reusables/projects/project-settings.md
View File

@@ -1,3 +1,5 @@
1. Navigate to your project.
1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu.
1. In the menu, click {% octicon "gear" aria-label="The gear icon" %} **Settings** to access the project settings.
![Screenshot showing the menu icon](/assets/images/help/projects-v2/open-menu.png)
2. In the menu, click {% octicon "gear" aria-label="The gear icon" %} **Settings** to access the project settings.
![Screenshot showing the 'Settings' menu item](/assets/images/help/projects-v2/settings-menu-item.png)

5
data/reusables/projects/project_boards_old.md
View File

@@ -3,9 +3,8 @@
{% note %}
**Notes:**
* Projects (beta), the all-new projects experience, is now available. For more information, see "[About projects (beta)](/issues/trying-out-the-new-projects-experience/about-projects)" and "[Migrating your project to Projects (beta)](/issues/trying-out-the-new-projects-experience/migrating-your-project)."
* You can only create a new classic project board for an organization, user, or repository that already has at least one classic project board. If you're unable to create a classic project board, create a beta project board instead.
* {% data variables.product.prodname_projects_v2 %}, the all-new projects experience, is now available. For more information about {% data variables.product.prodname_projects_v2 %}, see "[About {% data variables.product.prodname_projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)" and for information about migrating your {% data variables.projects.projects_v1_board %}, see "[Migrating from {% data variables.product.prodname_projects_v1_caps %}](/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic)."
* You can only create a new classic project board for an organization, user, or repository that already has at least one classic project board. If you're unable to create a classic project board, create a project board instead.
{% endnote %}

4
data/reusables/projects/projects-api.md
View File

@@ -3,8 +3,8 @@
**Notes:**
* This API only applies to project boards. Projects (beta) can be managed with the GraphQL API. For more information, see "[Using the API to manage projects (beta)](/issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects)."
* You can only create a new classic project board for an organization, user, or repository that already has at least one classic project board.
* This API only applies to {% data variables.product.prodname_projects_v1 %}. {% data variables.product.prodname_projects_v2 %} can be managed with the GraphQL API. For more information, see "[Using the API to manage projects](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)."
* You can only create a new {% data variables.projects.projects_v1_board %} for an organization, user, or repository that already has at least one {% data variables.projects.projects_v1_board %}.
{% endnote %}
{% endif %}

4
data/reusables/projects/reopen-a-project.md
View File

@@ -4,6 +4,8 @@
![Screenshot showing project close button](/assets/images/help/issues/closed-projects-tab.png)
1. Click the project you want to reopen.
1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu.
1. In the menu, to access the project settings, click {% octicon "gear" aria-label="The gear icon" %} **Settings**.
![Screenshot showing the menu icon](/assets/images/help/projects-v2/open-menu.png)
1. In the menu, click {% octicon "gear" aria-label="The gear icon" %} **Settings** to access the project settings.
![Screenshot showing the 'Settings' menu item](/assets/images/help/projects-v2/settings-menu-item.png)
1. At the bottom of the page, click **Re-open project**.
![Screenshot showing project re-open button](/assets/images/help/issues/reopen-project-button.png)

3
data/reusables/projects/save-view.md Normal file
View File

@@ -0,0 +1,3 @@
{% data reusables.projects.open-view-menu %}
1. Click **Save changes**.
![Screenshot showing the save menu item](/assets/images/help/projects-v2/save-view.png)

5
data/reusables/projects/select-an-item.md Normal file
View File

@@ -0,0 +1,5 @@
1. Select the item. To select multiple items, do one of the following:
- Hold <kbd>Command</kbd> (Mac) or <kbd>Ctrl</kbd> (Windows/Linux) and click each item.
- Select an item then press <kbd>Shift</kbd>+<kbd>↑</kbd> or <kbd>Shift</kbd>+<kbd>↓</kbd> to select additional items above or below the selected item.
- Select an item then press <kbd>Shift</kbd> and click another item to select all items between the two items.
- With a row or item already selected, press <kbd>Command</kbd>+<kbd>A</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>A</kbd> (Windows/Linux) to select all items in a column in a board layout or all items in a table layout.

5
data/reusables/repositories/anyone-can-view-anonymized-url.md Normal file
View File

@@ -0,0 +1,5 @@
{% warning %}
**Warning:** If you attach a file to a pull request, issue comment, or ticket in the {% data variables.contact.support_portal %}, anyone can view the anonymized URL without authentication, even if the pull request is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt or ghec %}For more information on anonymized URLs see "[About anonymized URLs](/github/authenticating-to-github/about-anonymized-urls)".{% endif %}
{% endwarning %}

2
data/reusables/support/submit-a-ticket.md
View File

@@ -36,6 +36,8 @@
- Steps to reproduce the issue
- Any special circumstances surrounding the discovery of the issue (for example, the first occurrence or occurrence after a specific event, frequency of occurrence, business impact of the problem, and suggested urgency)
- Exact wording of error messages
{% indented_data_reference reusables.repositories.anyone-can-view-anonymized-url spaces=3 %}
{%- ifversion ghes %}
1. Optionally, attach diagnostics files and other files by dragging and dropping, uploading, or pasting from the clipboard.
{%- endif %}

2
data/reusables/webhooks/project_card_short_desc.md
View File

@@ -1 +1 @@
Activity related to project cards. {% data reusables.webhooks.action_type_desc %} For more information, see the "[project cards](/rest/reference/projects#cards)" REST API.
Activity related to cards in a {% data variables.projects.projects_v1_board %}. {% data reusables.webhooks.action_type_desc %} For more information, see the "[project cards](/rest/reference/projects#cards)" REST API.

2
data/reusables/webhooks/project_column_short_desc.md
View File

@@ -1 +1 @@
Activity related to columns in a project board. {% data reusables.webhooks.action_type_desc %} For more information, see the "[project columns](/rest/reference/projects#columns)" REST API.
Activity related to columns in a {% data variables.projects.projects_v1_board %}. {% data reusables.webhooks.action_type_desc %} For more information, see the "[project columns](/rest/reference/projects#columns)" REST API.

2
data/reusables/webhooks/project_short_desc.md
View File

@@ -1 +1 @@
Activity related to project boards. {% data reusables.webhooks.action_type_desc %} For more information, see the "[projects](/rest/reference/projects)" REST API.
Activity related to {% data variables.projects.projects_v1_boards %}. {% data reusables.webhooks.action_type_desc %} For more information, see the "[projects](/rest/reference/projects)" REST API.

13
data/variables/product.yml
View File

@@ -85,6 +85,17 @@ prodname_codeql_cli: 'CodeQL CLI'
codeql_cli_ghes_recommended_version: >-
{% ifversion ghes < 3.3 %}2.6.3{% elsif ghes < 3.5 %}2.7.6{% elsif ghes = 3.5 %}2.8.5{% elsif ghes = 3.6 %}2.9.4{% elsif ghae-issue-7470 %}2.8.5{% elsif ghae %}2.7.6{% endif %}
# Projects v2
prodname_projects_v2: 'Projects'
prodname_projects_v1: >-
{% ifversion ghes or ghae %}project boards{% else %}projects (classic){% endif %}
prodname_projects_v1_caps: >-
{% ifversion ghes or ghae %}Project boards{% else %}Projects (classic){% endif %}
prodname_project_v1: >-
{% ifversion ghes or ghae %}project board{% else %}project (classic){% endif %}
prodname_project_v1_caps: >-
{% ifversion ghes or ghae %}Project board{% else %}Project (classic){% endif %}
# Apps, GitHub Marketplace, and integrations
prodname_marketplace: 'GitHub Marketplace'
prodname_github_app: 'GitHub App'
@@ -188,7 +199,7 @@ prodname_code_scanning_capc: 'Code scanning'
prodname_codeql_runner: 'CodeQL runner'
prodname_advisory_database: 'GitHub Advisory Database'
prodname_codeql_workflow: 'CodeQL analysis workflow'
prodname_dependency_review_action: 'Dependency Review GitHub Action'
prodname_dependency_review_action: 'dependency review action'
# Visual Studio
prodname_vs: 'Visual Studio'

15
data/variables/projects.yml Normal file
View File

@@ -0,0 +1,15 @@
projects_v2: 'projects'
projects_v2_caps: 'Projects'
project_v2: 'project'
project_v2_caps: 'Project'
projects_v1_board: >-
{% ifversion ghes or ghae %}project board{% else %}classic project{% endif %}
projects_v1_board_caps: >-
{% ifversion ghes or ghae %}Project board{% else %}Classic project{% endif %}
projects_v1_boards: >-
{% ifversion ghes or ghae %}project boards{% else %}classic projects{% endif %}
projects_v1_boards_caps: >-
{% ifversion ghes or ghae %}Project boards{% else %}Classic projects{% endif %}
command-palette-shortcut: '<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux)'