From 963508486cfb9c84c98994c54c9e70a2a7f1e331 Mon Sep 17 00:00:00 2001 From: pssduygu-tech Date: Sat, 9 May 2026 10:54:06 +0300 Subject: [PATCH] Delete content/issues directory --- content/issues/index.md | 64 -- .../index.md | 19 - .../about-automation-for-project-boards.md | 46 - .../about-project-boards.md | 80 -- .../changing-project-board-visibility.md | 27 - .../closing-a-project-board.md | 32 - ...nfiguring-automation-for-project-boards.md | 37 - .../creating-a-project-board.md | 111 --- .../deleting-a-project-board.md | 30 - .../editing-a-project-board.md | 34 - .../managing-project-boards/index.md | 23 - ...linking-a-repository-to-a-project-board.md | 34 - .../reopening-a-closed-project-board.md | 29 - ...es-and-pull-requests-to-a-project-board.md | 64 -- .../adding-notes-to-a-project-board.md | 64 -- .../archiving-cards-on-a-project-board.md | 30 - .../filtering-cards-on-a-project-board.md | 43 - .../index.md | 18 - ...tracking-progress-on-your-project-board.md | 22 - .../adding-items-automatically.md | 84 -- .../archiving-items-automatically.md | 57 -- .../automating-projects-using-actions.md | 320 ------- .../automating-your-project/index.md | 15 - .../using-the-api-to-manage-projects.md | 833 ------------------ .../using-the-built-in-automations.md | 38 - .../copying-an-existing-project.md | 34 - .../creating-projects/creating-a-project.md | 42 - .../creating-projects/index.md | 13 - .../migrating-from-projects-classic.md | 53 -- .../changing-the-layout-of-a-view.md | 41 - .../customizing-the-board-layout.md | 78 -- .../customizing-the-roadmap-layout.md | 69 -- .../customizing-the-table-layout.md | 70 -- .../filtering-projects.md | 252 ------ .../index.md | 16 - .../managing-your-views.md | 65 -- .../finding-your-projects.md | 84 -- .../index.md | 25 - .../learning-about-projects/about-projects.md | 75 -- .../best-practices-for-projects.md | 145 --- .../learning-about-projects/index.md | 11 - .../quickstart-for-projects.md | 259 ------ .../adding-items-to-your-project.md | 108 --- .../archiving-items-from-your-project.md | 48 - .../converting-draft-issues-to-issues.md | 34 - .../editing-items-in-your-project.md | 71 -- .../managing-items-in-your-project/index.md | 13 - .../adding-your-project-to-a-repository.md | 41 - .../adding-your-project-to-a-team.md | 49 -- .../closing-and-deleting-your-projects.md | 50 -- .../exporting-your-projects-data.md | 24 - .../managing-your-project/index.md | 15 - .../managing-access-to-your-projects.md | 110 --- ...-project-templates-in-your-organization.md | 90 -- .../managing-visibility-of-your-projects.md | 42 - .../sharing-project-updates.md | 33 - .../understanding-fields/about-date-fields.md | 27 - .../about-issue-fields.md | 61 -- .../about-iteration-fields.md | 77 -- ...ent-issue-and-sub-issue-progress-fields.md | 42 - .../about-pull-request-fields.md | 33 - .../about-single-select-fields.md | 54 -- .../about-text-and-number-fields.md | 43 - .../about-the-issue-type-field.md | 24 - .../deleting-custom-fields.md | 19 - .../understanding-fields/index.md | 22 - .../renaming-custom-fields.md | 18 - .../about-insights-for-projects.md | 44 - .../configuring-charts.md | 20 - .../creating-charts.md | 17 - .../index.md | 12 - .../administering-issues/closing-an-issue.md | 25 - .../administering-issues/deleting-an-issue.md | 33 - .../duplicating-an-issue.md | 30 - .../administering-issues/index.md | 16 - ...-issues-or-pull-requests-as-a-duplicate.md | 31 - .../pinning-an-issue-to-your-repository.md | 23 - ...sferring-an-issue-to-another-repository.md | 54 -- .../triaging-an-issue-with-ai.md | 36 - .../tracking-your-work-with-issues/index.md | 17 - .../learning-about-issues/about-issues.md | 85 -- .../learning-about-issues/index.md | 12 - ...-tracking-work-for-your-team-or-project.md | 213 ----- .../learning-about-issues/quickstart.md | 130 --- .../using-issues/about-slash-commands.md | 32 - .../adding-and-managing-issue-fields.md | 89 -- .../using-issues/adding-sub-issues.md | 47 - ...and-pull-requests-to-other-github-users.md | 62 -- .../using-issues/browsing-sub-issues.md | 30 - .../creating-a-branch-for-an-issue.md | 38 - .../using-issues/creating-an-issue.md | 180 ---- .../creating-issue-dependencies.md | 34 - .../using-issues/editing-an-issue.md | 58 -- ...-and-searching-issues-and-pull-requests.md | 302 ------- .../using-issues/index.md | 23 - .../linking-a-pull-request-to-an-issue.md | 91 -- ...aging-issue-fields-in-your-organization.md | 134 --- ...managing-issue-types-in-an-organization.md | 43 - ...ng-all-of-your-issues-and-pull-requests.md | 59 -- .../about-milestones.md | 32 - ...ilestones-with-issues-and-pull-requests.md | 31 - ...milestones-for-issues-and-pull-requests.md | 37 - ...g-issues-and-pull-requests-by-milestone.md | 32 - .../index.md | 19 - .../managing-labels.md | 106 --- .../viewing-your-milestones-progress.md | 29 - 106 files changed, 6940 deletions(-) delete mode 100644 content/issues/index.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/index.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/index.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/index.md delete mode 100644 content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md delete mode 100644 content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md delete mode 100644 content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md delete mode 100644 content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md delete mode 100644 content/issues/planning-and-tracking-with-projects/automating-your-project/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations.md delete mode 100644 content/issues/planning-and-tracking-with-projects/creating-projects/copying-an-existing-project.md delete mode 100644 content/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project.md delete mode 100644 content/issues/planning-and-tracking-with-projects/creating-projects/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md delete mode 100644 content/issues/planning-and-tracking-with-projects/finding-your-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/closing-and-deleting-your-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/exporting-your-projects-data.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md delete mode 100644 content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/sharing-project-updates.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-parent-issue-and-sub-issue-progress-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-pull-request-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/index.md delete mode 100644 content/issues/planning-and-tracking-with-projects/understanding-fields/renaming-custom-fields.md delete mode 100644 content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md delete mode 100644 content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md delete mode 100644 content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md delete mode 100644 content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/index.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/deleting-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/duplicating-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/index.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/pinning-an-issue-to-your-repository.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/transferring-an-issue-to-another-repository.md delete mode 100644 content/issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai.md delete mode 100644 content/issues/tracking-your-work-with-issues/index.md delete mode 100644 content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md delete mode 100644 content/issues/tracking-your-work-with-issues/learning-about-issues/index.md delete mode 100644 content/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project.md delete mode 100644 content/issues/tracking-your-work-with-issues/learning-about-issues/quickstart.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/about-slash-commands.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/creating-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/editing-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/index.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md delete mode 100644 content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/about-milestones.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/index.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/managing-labels.md delete mode 100644 content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md diff --git a/content/issues/index.md b/content/issues/index.md deleted file mode 100644 index 4611a87f5844..000000000000 --- a/content/issues/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "{% data variables.product.prodname_github_issues %} documentation" -shortTitle: "{% data variables.product.prodname_github_issues %}" -intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to plan and track your work.' -introLinks: - overview: /issues/tracking-your-work-with-issues/learning-about-issues/about-issues - quickstart: /issues/tracking-your-work-with-issues/learning-about-issues/quickstart -includedCategories: - - Create and work with issues - - Triage and organize issues - - Set up and manage projects - - Manage project items and fields - - Customize project views and insights - - Automate your project - - Use project boards (classic) -carousels: - recommended: - - /issues/tracking-your-work-with-issues/learning-about-issues/quickstart - - /issues/tracking-your-work-with-issues/learning-about-issues/about-issues - - /issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project - - /issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects - - /issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects - - /issues/tracking-your-work-with-issues/using-issues/creating-an-issue - - /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view - - /issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations - - /issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai -layout: discovery-landing -versions: - fpt: '*' - ghes: '*' - ghec: '*' -children: - - /tracking-your-work-with-issues - - /planning-and-tracking-with-projects - - /organizing-your-work-with-project-boards - - /using-labels-and-milestones-to-track-work -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests - - /github/managing-your-work-on-github/managing-your-work-with-issues - - /github/managing-your-work-on-github - - /categories/100/articles - - /categories/managing-projects - - /categories/managing-projects-on-github - - /categories/managing-your-work-on-github - - /about-issues - - /creating-an-issue - - /deleting-an-issue - - /opening-an-issue-from-a-comment - - /opening-an-issue-from-code - - /transferring-an-issue-to-another-repository - - /pinning-an-issue-to-your-repository - - /creating-a-permanent-link-to-a-code-snippet - - /managing-labels - - /about-task-lists - - /about-automation-for-issues-and-pull-requests-with-query-parameters - - /file-attachments-on-issues-and-pull-requests - - /assigning-issues-and-pull-requests-to-other-github-users - - /viewing-all-of-your-issues-and-pull-requests - - /disabling-issues - - /linking-a-pull-request-to-an-issue - - /about-duplicate-issues-and-pull-requests - - /issues/guides - - /video-transcripts/transcript-using-projects-for-feature-planning ---- diff --git a/content/issues/organizing-your-work-with-project-boards/index.md b/content/issues/organizing-your-work-with-project-boards/index.md deleted file mode 100644 index fda306899925..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 'Organizing your work with {% data variables.product.prodname_projects_v1 %}' -shortTitle: '{% data variables.product.prodname_projects_v1_caps %}' -intro: 'Use {% data variables.product.prodname_projects_v1 %} to manage your work on {% data variables.product.prodname_dotcom %}' -allowTitleToDifferFromFilename: true -versions: - feature: projects-v1 -children: - - /managing-project-boards - - /tracking-work-with-project-boards -redirect_from: - - /adding-issues-and-pull-requests-to-a-project-board - - /adding-notes-to-a-project-board - - /tracking-progress-on-your-project-board - - /filtering-cards-on-a-project-board - - /archiving-cards-on-a-project-board ---- - -{% data reusables.projects.project_boards_old %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards.md deleted file mode 100644 index d8d8ccf03292..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: 'About automation for {% data variables.product.prodname_projects_v1 %}' -intro: 'You can configure automatic workflows to keep the status of {% data variables.projects.projects_v1_board %} cards in sync with the associated issues and pull requests.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/about-automation-for-project-boards - - /articles/about-automation-for-project-boards - - /github/managing-your-work-on-github/about-automation-for-project-boards -versions: - feature: projects-v1 -shortTitle: 'Automation for {% data variables.product.prodname_projects_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -{% data reusables.project-management.automate-project-board-permissions %} For more information, see [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization). - -You can automate actions based on triggering events for {% data variables.projects.projects_v1_board %} columns. This eliminates some of the manual tasks in managing a {% data variables.projects.projects_v1_board %}. For example, you can configure a "To do" column, where any new issues or pull requests you add to a {% data variables.projects.projects_v1_board %} are automatically moved to the configured column. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards). - -{% data reusables.project-management.use-automated-template %} - -{% data reusables.project-management.copy-project-boards %} - -{% data variables.projects.projects_v1_board_caps %} automation can also help teams develop a shared understanding of a {% data variables.projects.projects_v1_board %}'s purpose and the team's development process by creating a standard workflow for certain actions. - -{% data reusables.project-management.resync-automation %} - -## Automation options - -| Column preset | Configuration options | -| --- | --- | -| To do | | -| In progress | | -| Done | | - -## Project progress tracking - -You can track the progress on your {% data variables.projects.projects_v1_board %}. Cards in the "To do", "In progress", or "Done" columns count toward the overall project progress. {% data reusables.project-management.project-progress-locations %} - -For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board). - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards){% ifversion fpt or ghec %} -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board){% endif %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md deleted file mode 100644 index 0560bc1f168c..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: 'About {% data variables.product.prodname_projects_v1 %}' -intro: '{% data variables.product.prodname_projects_v1_caps %} on {% data variables.product.github %} help you organize and prioritize your work. {% ifversion projects-v1-can-create %} You can create {% data variables.projects.projects_v1_boards %} for specific feature work, comprehensive roadmaps, or even release checklists. With {% data variables.product.prodname_projects_v1 %}, you have the flexibility to create customized workflows that suit your needs.{% endif %}' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/about-project-boards - - /articles/about-projects - - /articles/about-project-boards - - /github/managing-your-work-on-github/about-project-boards - - /issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board -versions: - feature: projects-v1 -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- - -{% data reusables.projects.project_boards_old %} - -{% data variables.projects.projects_v1_boards_caps %} are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can drag and drop or use keyboard shortcuts to reorder cards within a column, move cards from column to column, and change the order of columns. - -{% data variables.projects.projects_v1_board_caps %} cards contain relevant metadata for issues and pull requests, like labels, assignees, the status, and who opened it. {% data reusables.project-management.edit-in-project %} - -You can create notes within columns to serve as task reminders, references to issues and pull requests from any repository, or to add information related to the {% data variables.projects.projects_v1_board %}. You can create a reference card for another {% data variables.projects.projects_v1_board %} by adding a link to a note. If the note isn't sufficient for your needs, you can convert it to an issue. For more information on converting notes to issues, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board). - -Types of {% data variables.projects.projects_v1_boards %}: - -* **User-owned {% data variables.projects.projects_v1_board %}** can contain issues and pull requests from any personal repository. -* **Organization-wide {% data variables.projects.projects_v1_board %}** can contain issues and pull requests from any repository that belongs to an organization. {% data reusables.project-management.link-repos-to-project-board %} For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board). -* **Repository {% data variables.projects.projects_v1_board %}** are scoped to issues and pull requests within a single repository. They can also include notes that reference issues and pull requests in other repositories. - -## {% ifversion projects-v1-can-create %}Creating and viewing{% else %}Viewing{% endif %} {% data variables.projects.projects_v1_boards %} - -{% ifversion projects-v1-can-create %} - -To create a {% data variables.projects.projects_v1_board %} for your organization, you must be an organization member. Organization owners and people with {% data variables.projects.projects_v1_board %} admin permissions can customize access to the {% data variables.projects.projects_v1_board %}. - -{% data reusables.projects.owners-can-limit-visibility-permissions %} - -{% endif %} - -If an organization-owned {% data variables.projects.projects_v1_board %} includes issues or pull requests from a repository that you don't have permission to view, the card will be redacted. For more information, see [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization). - -The activity view shows the {% data variables.projects.projects_v1_board %}'s recent history, such as cards someone created or moved between columns. To access the activity view, click **Menu** and scroll down. - -To find specific cards on a {% data variables.projects.projects_v1_board %} or view a subset of the cards, you can filter {% data variables.projects.projects_v1_board %} cards. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board). - -To simplify your workflow and keep completed tasks off your {% data variables.projects.projects_v1_board %}, you can archive cards. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board). - -If you've completed all of your {% data variables.projects.projects_v1_board %} tasks or no longer need to use your {% data variables.projects.projects_v1_board %}, you can close the {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board). - -You can also [disable {% data variables.projects.projects_v1_boards %} in a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) or [disable {% data variables.projects.projects_v1_boards %} in your organization](/organizations/managing-organization-settings/disabling-project-boards-in-your-organization), if you prefer to track your work in a different way. - -{% ifversion projects-v1-can-create %}{% data reusables.project-management.project-board-import-with-api %}{% endif %} - -{% ifversion projects-v1-can-create %} - -## Templates for {% data variables.projects.projects_v1_boards %} - -You can use templates to quickly set up a new {% data variables.projects.projects_v1_board %}. When you use a template to create a {% data variables.projects.projects_v1_board %}, your new board will include columns as well as cards with tips for using {% data variables.product.prodname_projects_v1 %}. You can also choose a template with automation already configured. - -| Template | Description | -| --- | --- | -| Basic kanban | Track your tasks with To do, In progress, and Done columns | -| Automated kanban | Cards automatically move between To do, In progress, and Done columns | -| Automated kanban with review | Cards automatically move between To do, In progress, and Done columns, with additional triggers for pull request review status | -| Bug triage | Triage and prioritize bugs with To do, High priority, Low priority, and Closed columns | - -For more information on automation for {% data variables.product.prodname_projects_v1 %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards). - -{% data reusables.project-management.copy-project-boards %} - -{% endif %} - -## Further reading - -{%- ifversion projects-v1-can-create %}- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board){% endif %} -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board) -* [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization) -* [AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#project-boards) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md deleted file mode 100644 index 4f13607903bb..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: 'Changing {% data variables.product.prodname_project_v1 %} visibility' -intro: 'As an organization owner or {% data variables.projects.projects_v1_board %} admin, you can make a {% data variables.projects.projects_v1_board %} public or private.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/changing-project-board-visibility - - /articles/changing-project-board-visibility - - /github/managing-your-work-on-github/changing-project-board-visibility -versions: - feature: projects-v1 -shortTitle: Change visibility -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -{% data reusables.project-management.project-board-visibility %} - -> [!NOTE] -> {% data reusables.projects.owners-can-limit-visibility-permissions %} -> * When you make your {% data variables.projects.projects_v1_board %} public, organization members are given read access by default. You can give specific organization members write or admin permissions by giving access to teams they're on or by adding them to the {% data variables.projects.projects_v1_board %} as a collaborator. For more information, see [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization). - -1. Navigate to the {% data variables.projects.projects_v1_board %} you want to make public or private. -{% data reusables.project-management.click-menu %} -{% data reusables.project-management.access-collaboration-settings %} -{% data reusables.project-management.choose-visibility %} -1. Click **Save**. diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md deleted file mode 100644 index 68904e97aab1..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: 'Closing a {% data variables.product.prodname_project_v1 %}' -intro: 'If you''ve completed all the tasks in a {% data variables.projects.projects_v1_board %} or no longer need to use a {% data variables.projects.projects_v1_board %}, you can close the {% data variables.projects.projects_v1_board %}.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/closing-a-project-board - - /articles/closing-a-project - - /articles/closing-a-project-board - - /github/managing-your-work-on-github/closing-a-project-board -versions: - feature: projects-v1 -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -When you close a {% data variables.projects.projects_v1_board %}, any configured workflow automation will pause by default. - -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 board. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board) or [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards). - -1. Navigate to the list of {% data variables.projects.projects_v1_boards %} in your repository or organization, or owned by your personal account. -1. In the projects list, next to the {% data variables.projects.projects_v1_board %} you want to close, click {% octicon "kebab-horizontal" aria-label="Project menu" %}. -![Screenshot showing the projects index. The project menu icon is highlighted with an orange rectangle.](/assets/images/help/projects/project-list-action-chevron.png) -1. Click **Close**. - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board) -* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) -* [AUTOTITLE](/organizations/managing-organization-settings/disabling-project-boards-in-your-organization) -* [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md deleted file mode 100644 index dd0135149dd5..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Configuring automation for {% data variables.product.prodname_projects_v1 %} -intro: You can set up automatic workflows to move issues and pull requests to a {% data variables.projects.projects_v1_board %} column when a specified event occurs. -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/configuring-automation-for-project-boards - - /articles/configuring-automation-for-project-boards - - /github/managing-your-work-on-github/configuring-automation-for-project-boards -versions: - feature: projects-v1 -shortTitle: Configure automation -allowTitleToDifferFromFilename: true -contentType: how-tos -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -{% data reusables.project-management.automate-project-board-permissions %} For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards). - -{% data reusables.project-management.use-automated-template %} - -{% data reusables.project-management.resync-automation %} - -> [!TIP] -> To edit columns that already have configured automation, click **Manage** at the bottom of the column. - -1. Navigate to the {% data variables.projects.projects_v1_board %} you want to automate. -1. In the column you want to automate, click {% octicon "kebab-horizontal" aria-label="Column menu" %}. -![Screenshot showing a column in a project. The menu icon is highlighted with an orange outline.](/assets/images/help/projects/edit-column-button.png) -1. Click **Manage automation**. -1. Using the Preset drop-down menu, select an automation preset. -1. Select the workflow automations you want to configure for the column. -1. Click **Update automation**. - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md deleted file mode 100644 index 265e5eb6e965..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Creating a {% data variables.product.prodname_project_v1 %} -intro: '{% data variables.projects.projects_v1_boards_caps %} can be used to create customized workflows to suit your needs, like tracking and prioritizing specific feature work, comprehensive roadmaps, or even release checklists.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/creating-a-project-board - - /articles/creating-a-project - - /articles/creating-a-project-board - - /github/managing-your-work-on-github/creating-a-project-board -versions: - feature: projects-v1-can-create -allowTitleToDifferFromFilename: true -contentType: how-tos -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -{% data reusables.project-management.use-automated-template %} - -{% data reusables.project-management.copy-project-boards %} - -{% data reusables.project-management.link-repos-to-project-board %} For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board). - -Once you've created your {% data variables.projects.projects_v1_board %}, you can add issues, pull requests, and notes to it. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board) and [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board). - -You can also configure workflow automations to keep your {% data variables.projects.projects_v1_board %} in sync with the status of issues and pull requests. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards). - -{% data reusables.project-management.project-board-import-with-api %} - -## Creating a user-owned {% data variables.projects.projects_v1_board %} - -{% data reusables.projects.classic-project-creation %} - -{% data reusables.profile.access_profile %} -1. On the top of your profile page, in the main navigation, click **{% octicon "project" aria-hidden="true" aria-label="project" %} Projects**. - - ![Screenshot showing profile tabs. The 'Projects' tab is highlighted with an orange outline.](/assets/images/help/projects-v2/tab-projects.png) - -1. Click **Projects (classic)**. -{% data reusables.project-management.click-new-project %} -{% data reusables.project-management.create-project-name-description %} -{% data reusables.project-management.choose-template %} -{% data reusables.project-management.choose-visibility %} -{% data reusables.project-management.linked-repositories %} -{% data reusables.project-management.create-project-button %} -{% data reusables.project-management.add-column-new-project %} -{% data reusables.project-management.name-project-board-column %} -{% data reusables.project-management.select-column-preset %} -{% data reusables.project-management.select-automation-options-new-column %} -{% data reusables.project-management.click-create-column %} -{% data reusables.project-management.add-more-columns %} - -{% data reusables.project-management.edit-project-columns %} - -## Creating an organization-wide {% data variables.projects.projects_v1_board %} - -{% data reusables.projects.classic-project-creation %} - -> [!NOTE] -> {% data reusables.projects.owners-can-limit-visibility-permissions %} - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.organizations.organization-wide-project %} -1. Click **Projects (classic)**. -{% data reusables.project-management.click-new-project %} -{% data reusables.project-management.create-project-name-description %} -{% data reusables.project-management.choose-template %} -{% data reusables.project-management.choose-visibility %} -{% data reusables.project-management.linked-repositories %} -{% data reusables.project-management.create-project-button %} -{% data reusables.project-management.add-column-new-project %} -{% data reusables.project-management.name-project-board-column %} -{% data reusables.project-management.select-column-preset %} -{% data reusables.project-management.select-automation-options-new-column %} -{% data reusables.project-management.click-create-column %} -{% data reusables.project-management.add-more-columns %} - -{% data reusables.project-management.edit-project-columns %} - -{% ifversion projects-v1-create-repo-project %} - -## Creating a repository {% data variables.projects.projects_v1_board %} - -{% data reusables.projects.classic-project-creation %} - -{% data reusables.repositories.navigate-to-repo %} -1. Under your repository name, click **{% octicon "project" aria-hidden="true" aria-label="project" %} Projects**. -1. Click **Projects (classic)**. -{% data reusables.project-management.click-new-project %} -{% data reusables.project-management.create-project-name-description %} -{% data reusables.project-management.choose-template %} -{% data reusables.project-management.create-project-button %} -{% data reusables.project-management.add-column-new-project %} -{% data reusables.project-management.name-project-board-column %} -{% data reusables.project-management.select-column-preset %} -{% data reusables.project-management.select-automation-options-new-column %} -{% data reusables.project-management.click-create-column %} -{% data reusables.project-management.add-more-columns %} - -{% data reusables.project-management.edit-project-columns %} - -{% endif %} - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board){% ifversion fpt or ghec %} -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board){% endif %} -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md deleted file mode 100644 index 66180edf82c7..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: 'Deleting a {% data variables.product.prodname_project_v1 %}' -intro: 'You can delete an existing {% data variables.projects.projects_v1_board %} if you no longer need access to its contents.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/deleting-a-project-board - - /articles/deleting-a-project - - /articles/deleting-a-project-board - - /github/managing-your-work-on-github/deleting-a-project-board -versions: - feature: projects-v1 -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -> [!TIP] -> If you'd like to retain access to a completed or unneeded {% data variables.projects.projects_v1_board %} without losing access to its contents, you can [close the {% data variables.projects.projects_v1_board %}](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board) instead of deleting it. - -1. Navigate to the {% data variables.projects.projects_v1_board %} you want to delete. -{% data reusables.project-management.click-menu %} -{% data reusables.project-management.click-edit-sidebar-menu-project-board %} -1. Click **Delete project**. -1. To confirm that you want to delete the {% data variables.projects.projects_v1_board %}, click **OK**. - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board) -* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) -* [AUTOTITLE](/organizations/managing-organization-settings/disabling-project-boards-in-your-organization) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md deleted file mode 100644 index 5f17419eeb2d..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: 'Editing a {% data variables.product.prodname_project_v1 %}' -intro: 'You can edit the title and description of an existing {% data variables.projects.projects_v1_board %}.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/editing-a-project-board - - /articles/editing-a-project - - /articles/editing-and-deleting-a-project - - /articles/editing-a-project-board - - /github/managing-your-work-on-github/editing-a-project-board -versions: - feature: projects-v1 -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -{% ifversion projects-v1-can-create %} - -> [!TIP] -> For details on adding, removing, or editing columns in your {% data variables.projects.projects_v1_board %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board). - -{% endif %} - -1. Navigate to the {% data variables.projects.projects_v1_board %} you want to edit. -{% data reusables.project-management.click-menu %} -{% data reusables.project-management.click-edit-sidebar-menu-project-board %} -1. Modify the {% data variables.projects.projects_v1_board %} name and description as needed, then click **Save project**. - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/index.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/index.md deleted file mode 100644 index 163c47fb7e4b..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: 'Managing {% data variables.product.prodname_projects_v1 %}' -shortTitle: 'Managing {% data variables.product.prodname_projects_v1 %}' -intro: 'Learn how to create and manage {% data variables.projects.projects_v1_boards %}' -versions: - feature: projects-v1 -children: - - /about-project-boards - - /creating-a-project-board - - /editing-a-project-board - - /linking-a-repository-to-a-project-board - - /about-automation-for-project-boards - - /configuring-automation-for-project-boards - - /changing-project-board-visibility - - /closing-a-project-board - - /reopening-a-closed-project-board - - /deleting-a-project-board -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards -allowTitleToDifferFromFilename: true ---- - -{% data reusables.projects.project_boards_old %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md deleted file mode 100644 index d4259ef5975f..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: 'Linking a repository to a {% data variables.product.prodname_project_v1 %}' -intro: 'You can link a repository to your organization''s or personal account''s {% data variables.projects.projects_v1_board %}.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/linking-a-repository-to-a-project-board - - /articles/linking-a-repository-to-a-project-board - - /github/managing-your-work-on-github/linking-a-repository-to-a-project-board -versions: - feature: projects-v1 -shortTitle: Link repository to board -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -Anyone with write permissions to a {% data variables.projects.projects_v1_board %} can link repositories owned by that organization or personal account to the {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization) or [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account). - -{% data reusables.project-management.link-repos-to-project-board %} You can add issues and pull requests from any unlinked repositories by typing the issue or pull request URL in a card. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board). - -1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to link a repository. -{% data reusables.project-management.click-menu %} -{% data reusables.project-management.access-collaboration-settings %} -1. In the left sidebar, click **Linked repositories**. -1. Click **Link a repository**. -1. Search for the repository you'd like to link. -1. Click **Link**. To unlink, click **Unlink**. - -> [!NOTE] -> In order to link a repository to your organization or user owned {% data variables.projects.projects_v1_board %} the repository needs to have issues enabled. That is, the repository has an "Issues" tab (in forked repositories issues are disabled by default). For information on how to enable or disable issues for a repository, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues). - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md deleted file mode 100644 index a55d7c55f01a..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: 'Reopening a closed {% data variables.product.prodname_project_v1 %}' -intro: 'You can reopen a closed {% data variables.projects.projects_v1_board %} and restart any workflow automation that was configured for the {% data variables.projects.projects_v1_board %}.' -redirect_from: - - /github/managing-your-work-on-github/managing-project-boards/reopening-a-closed-project-board - - /articles/reopening-a-closed-project-board - - /github/managing-your-work-on-github/reopening-a-closed-project-board -versions: - feature: projects-v1 -shortTitle: 'Reopen {% data variables.product.prodname_project_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -When you close a {% data variables.projects.projects_v1_board %}, any workflow automation that was configured for the {% data variables.projects.projects_v1_board %} will pause by default. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board). - -When 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 board. - -1. Navigate to the {% data variables.projects.projects_v1_board %} you want to reopen. -{% data reusables.project-management.click-menu %} -1. Choose whether to sync automation for your {% data variables.projects.projects_v1_board %} or reopen your {% data variables.projects.projects_v1_board %} without syncing. - * To reopen your {% data variables.projects.projects_v1_board %} and sync automation, click **Reopen and sync project**. - * To reopen your {% data variables.projects.projects_v1_board %} without syncing automation, using the reopen drop-down menu, click **Reopen only**. Then, click **Reopen only**. - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards) diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md deleted file mode 100644 index 018ccf8a8631..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: 'Adding issues and pull requests to a {% data variables.product.prodname_project_v1 %}' -intro: 'You can add issues and pull requests to a {% data variables.projects.projects_v1_board %} in the form of cards and triage them into columns.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board - - /articles/adding-issues-and-pull-requests-to-a-project - - /articles/adding-issues-and-pull-requests-to-a-project-board - - /github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board -versions: - feature: projects-v1 -shortTitle: 'Add issues & PRs to {% data variables.product.prodname_project_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -You can add issue or pull request cards to your {% data variables.projects.projects_v1_board %} by: -* Dragging cards from the **Triage** section in the sidebar. -* Typing the issue or pull request URL in a card. -* Searching for issues or pull requests in the {% data variables.projects.projects_v1_board %} search sidebar. - -You can put a maximum of 2,500 cards into each project column. If a column has reached the maximum number of cards, no cards can be moved into that column. - -> [!NOTE] -> You can also add notes to your {% data variables.projects.projects_v1_board %} to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.github %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board). - -{% data reusables.project-management.edit-in-project %} - -{% data reusables.project-management.link-repos-to-project-board %} When you search for issues and pull requests to add to your {% data variables.projects.projects_v1_board %}, the search automatically scopes to your linked repositories. You can remove these qualifiers to search within all organization repositories. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board). - -## Adding issues and pull requests to a {% data variables.projects.projects_v1_board %} - -1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to add issues and pull requests. -1. In your {% data variables.projects.projects_v1_board %}, click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add cards**. -![Screenshot showing the header of a project. The "Add cards" button is highlighted with an orange outline.](/assets/images/help/projects/add-cards-button.png) -1. Search for issues and pull requests to add to your {% data variables.projects.projects_v1_board %} using search qualifiers such as `is:issue is:open`. For more information on search qualifiers you can use, see [AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests). - - > [!TIP] - > * You can also add an issue or pull request by typing the URL in a card. - > * If you're working on a specific feature, you can apply a label to each related issue or pull request for that feature, and then easily add cards to your {% data variables.projects.projects_v1_board %} by searching for the label name. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels). - -1. From the filtered list of issues and pull requests, drag the card you'd like to add to your {% data variables.projects.projects_v1_board %} and drop it in the correct column. Alternatively, you can move cards using keyboard shortcuts. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} - - > [!TIP] - > You can drag and drop or use keyboard shortcuts to reorder cards and move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} - -## Adding issues and pull requests to a {% data variables.projects.projects_v1_board %} from the sidebar - -1. On the right side of an issue or pull request, click **Projects {% octicon "gear" aria-hidden="true" aria-label="gear" %}**. - - ![Screenshot showing an issue's sidebar. The "Projects" section header is highlighted with an orange outline.](/assets/images/help/projects-v2/issue-sidebar-projects.png) - -1. Click the **Recent**, **Repository**, **User**, or **Organization** tab for the {% data variables.projects.projects_v1_board %} you would like to add to. -1. Type the name of the project in **Filter projects** field. -1. Select one or more {% data variables.projects.projects_v1_boards %} where you want to add the issue or pull request. -1. Click **Awaiting triage**{% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %}, then click the column where you want your issue or pull request. The card will move to the bottom of the {% data variables.projects.projects_v1_board %} column you select. - ![Screenshot showing the projects section in an issue's sidebar. The awaiting triage option is highlighted with an orange outline.](/assets/images/help/projects/sidebar-select-project-board-column-menu.png) - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board) diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md deleted file mode 100644 index 83f6b9f30d50..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: 'Adding notes to a {% data variables.product.prodname_project_v1 %}' -intro: 'You can add notes to a {% data variables.projects.projects_v1_board %} to serve as task reminders or to add information related to the {% data variables.projects.projects_v1_board %}.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/adding-notes-to-a-project-board - - /articles/adding-notes-to-a-project - - /articles/adding-notes-to-a-project-board - - /github/managing-your-work-on-github/adding-notes-to-a-project-board -versions: - feature: projects-v1 -shortTitle: 'Add notes to {% data variables.product.prodname_project_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -> [!TIP] -> * You can format your note using Markdown syntax. For example, you can use headings, links, task lists, or emoji. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). -> * You can drag and drop or use keyboard shortcuts to reorder notes and move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} -> * Your {% data variables.projects.projects_v1_board %} must have at least one column before you can add notes.{% ifversion projects-v1-can-create %} For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board).{% endif %} - -When you add a URL for an issue, pull request, or another {% data variables.projects.projects_v1_board %} to a note, you'll see a preview in a summary card below your text. - -## Adding notes to a {% data variables.projects.projects_v1_board %} - -1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to add notes. -1. In the column you want to add a note to, click {% octicon "plus" aria-label="Add a note to this column" %}. - ![Screenshot showing a project column. The 'add a note to this column' button is highlighted with an orange outline.](/assets/images/help/projects/add-note-button.png) -1. Type your note, then click **Add**. - - > [!TIP] - > You can reference an issue or pull request in your note by typing its URL in the card. - -## Converting a note to an issue - -If you've created a note and find that it isn't sufficient for your needs, you can convert it to an issue. - -When you convert a note to an issue, the issue is automatically created using the content from the note. The first line of the note will be the issue title and any additional content from the note will be added to the issue description. - -> [!TIP] -> You can add content in the body of your note to @mention someone, link to another issue or pull request, and add emoji. These {% data variables.product.prodname_dotcom %} Flavored Markdown features aren't supported within {% data variables.projects.projects_v1_board %} notes, but once your note is converted to an issue, they'll appear correctly. For more information on using these features, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github). - -1. Navigate to the note that you want to convert to an issue. -{% data reusables.project-management.project-note-more-options %} -1. Click **Convert to issue**. -1. If the card is on an organization-wide {% data variables.projects.projects_v1_board %}, in the drop-down menu, choose the repository you want to add the issue to. -1. Optionally, edit the pre-filled issue title, and type an issue body. -1. Click **Convert to issue**. -1. The note is automatically converted to an issue. In the {% data variables.projects.projects_v1_board %}, the new issue card will be in the same location as the previous note. - -## Editing and removing a note - -1. Navigate to the note that you want to edit or remove. -{% data reusables.project-management.project-note-more-options %} -1. To edit the contents of the note, click **Edit note**. -1. To delete the contents of the notes, click **Delete note**. - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) -{%- ifversion projects-v1-can-create %}- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board){% endif %} -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board) diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md deleted file mode 100644 index 0fa4e685c51a..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: 'Archiving cards on a {% data variables.product.prodname_project_v1 %}' -intro: 'You can archive {% data variables.projects.projects_v1_board %} cards to declutter your workflow without losing the historical context of a project.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/archiving-cards-on-a-project-board - - /articles/archiving-cards-on-a-project-board - - /github/managing-your-work-on-github/archiving-cards-on-a-project-board -versions: - feature: projects-v1 -shortTitle: 'Archive cards on {% data variables.product.prodname_project_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -Automation in your {% data variables.projects.projects_v1_board %} does not apply to archived {% data variables.projects.projects_v1_board %} cards. For example, if you close an issue in a {% data variables.projects.projects_v1_board %}'s archive, the archived card does not automatically move to the "Done" column. When you restore a card from the {% data variables.projects.projects_v1_board %} archive, the card will return to the column where it was archived. - -## Archiving cards on a {% data variables.projects.projects_v1_board %} - -1. In a {% data variables.projects.projects_v1_board %}, find the card you want to archive, then click {% octicon "kebab-horizontal" aria-label="Card menu" %}. -![Screenshot showing a card on a project. The card menu icon is highlighted with an orange outline.](/assets/images/help/projects/select-archiving-options-project-board-card.png) -1. Click **Archive**. - -## Restoring cards on a {% data variables.projects.projects_v1_board %} from the sidebar - -{% data reusables.project-management.click-menu %} -1. Click {% octicon "kebab-horizontal" aria-label="Project menu" %}, then click **View archive**. - ![Screenshot showing the project menu. The "View archive" option is highlighted with an orange outline.](/assets/images/help/projects/select-view-archive-option-project-board-card.png) -1. Above the {% data variables.projects.projects_v1_board %} card you want to unarchive, click **Restore**. diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md deleted file mode 100644 index a1c5e1243c75..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: 'Filtering cards on a {% data variables.product.prodname_project_v1 %}' -intro: 'You can filter the cards on a {% data variables.projects.projects_v1_board %} to search for specific cards or view a subset of the cards.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/filtering-cards-on-a-project-board - - /articles/filtering-cards-on-a-project-board - - /github/managing-your-work-on-github/filtering-cards-on-a-project-board -versions: - feature: projects-v1 -shortTitle: 'Filter cards on {% data variables.product.prodname_project_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -On a card, you can click any assignee, milestone, or label to filter the {% data variables.projects.projects_v1_board %} by that qualifier. To clear the search, you can click the same assignee, milestone, or label again. - -You can also use the "Filter cards" search bar at the top of each {% data variables.projects.projects_v1_board %} to search for cards. You can filter cards using the following search qualifiers in any combination, or by simply typing some text you'd like to search for. - -* Filter cards by author using `author:USERNAME` -* Filter cards by assignee using `assignee:USERNAME` or `no:assignee` -* Filter cards by label using `label:LABEL`, `label:"MULTI-WORD LABEL NAME"`, or `no:label` -* Filter by milestone by using `milestone:MY-MILESTONE` -* Filter cards by state using `state:open`, `state:closed`, or `state:merged` -* Filter by review status using `review:none`, `review:required`, `review:approved`, or `review:changes_requested` -* Filter by check status using `status:pending`, `status:success`, or `status:failure` -* Filter cards by type using `type:issue`, `type:pr`, or `type:note` -* Filter cards by state and type using `is:open`, `is:closed`, or `is:merged`; and `is:issue`, `is:pr`, or `is:note` -* Filter cards by issues that are linked to a pull request by a closing reference using `linked:pr` -* Filter cards by repository in an organization-wide {% data variables.projects.projects_v1_board %} using `repo:ORGANIZATION/REPOSITORY` - -1. Navigate to the {% data variables.projects.projects_v1_board %} that contains the cards you want to filter. -1. Above the project card columns, click into the "Filter cards" search bar and type a search query to filter the cards. - -> [!TIP] -> You can drag and drop filtered cards or use keyboard shortcuts to move them between columns. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} - -## Further reading - -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board) -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board) diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/index.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/index.md deleted file mode 100644 index 571411012885..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 'Tracking progress on your {% data variables.product.prodname_projects_v1 %}' -shortTitle: 'Tracking {% data variables.product.prodname_projects_v1 %}' -intro: 'Learn how to track your work on {% data variables.projects.projects_v1_board %}' -versions: - feature: projects-v1 -children: - - /adding-issues-and-pull-requests-to-a-project-board - - /adding-notes-to-a-project-board - - /tracking-progress-on-your-project-board - - /filtering-cards-on-a-project-board - - /archiving-cards-on-a-project-board -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards -allowTitleToDifferFromFilename: true ---- - -{% data reusables.projects.project_boards_old %} diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md deleted file mode 100644 index 276f12552b01..000000000000 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: 'Tracking progress on your {% data variables.product.prodname_project_v1 %}' -intro: 'You can see the overall progress of your {% data variables.projects.projects_v1_board %} in a progress bar.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards/tracking-progress-on-your-project-board - - /articles/tracking-progress-on-your-project-board - - /github/managing-your-work-on-github/tracking-progress-on-your-project-board -versions: - feature: projects-v1 -shortTitle: 'Track progress on {% data variables.product.prodname_project_v1 %}' -allowTitleToDifferFromFilename: true -category: - - Use project boards (classic) ---- -{% data reusables.projects.project_boards_old %} - -{% data reusables.project-management.project-progress-locations %} - -1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to enable or disable project progress tracking. -{% data reusables.project-management.click-menu %} -{% data reusables.project-management.click-edit-sidebar-menu-project-board %} -1. Select or deselect **Track project progress**. diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md deleted file mode 100644 index 5be8eedd51d3..000000000000 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Adding items automatically -intro: You can configure your project's built-in workflows to automatically add items from {% ifversion projects-v2-duplicate-auto-add %}repositories{% else%}a repository{% endif %} that match a filter. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -contentType: tutorials -category: - - Automate your project ---- -{% ifversion ghes %} - -{% data reusables.projects.enable_enterprise_workflows %} - -{% endif %} - -## About automatically adding items - -You can configure your project's built-in workflows to automatically add new items as they are created or updated in a repository. You can define a filter to only add items that meet your criteria. {% ifversion projects-v2-duplicate-auto-add %} You can also create multiple auto-add workflows, each workflow can have a unique filter and target a different repository. {% endif %} - -When you enable the auto-add workflow, existing items matching your criteria will not be added. The workflow will add items when created or updated if the item matches your filter. For more information on manually adding items, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project#bulk-adding-issues-and-pull-requests). - -The auto-add workflow supports a subset of filters. You can use the following filters when configuring your workflow. - -| Qualifier | Possible values -| --- | --- | -| `is` | open, closed, merged, draft, issue, pr -| `label` | "label name" -| `reason` | completed, reopened, "not planned" -| `assignee` | {% data variables.product.github %} username -| `no` | label, assignee, reason - -All filters, other than `no`, support negation. For example, you could use `-label:bug` to add issues that do not have the "bug" label. - -{% ifversion projects-v2-duplicate-auto-add %} - -The auto-add workflow is limited per plan. - -| Product | Maximum auto-add workflows | -|------- | ------- | -| {% data variables.product.prodname_free_user %} | 1 | -| {% data variables.product.prodname_pro %} | 5 | -| {% data variables.product.prodname_team %} | 5 | -| {% data variables.product.prodname_ghe_cloud %} | 20 | -| {% data variables.product.prodname_ghe_server %} | 20 | - -{% endif %} - -## Configuring the auto-add workflow in your project - -{% data reusables.projects.access-workflows %} -1. In the "Default workflows" list, click **Auto-add to project**{% ifversion projects-v2-duplicate-auto-add %} or one of the auto-add workflows you have previously duplicated{% endif %}. - -1. To start editing the workflow, in the top right, click **Edit**. - - ![Screenshot showing the workflow menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) - -1. Under "Filters", select the repository you want to add items from. -1. Next to the repository selection, type the filter criteria you want items to match before they are automatically added to your project. -1. To enable the new workflow, click **Save and turn on workflow**. - -{% ifversion projects-v2-duplicate-auto-add %} - -## Duplicating the auto-add workflow - -You can create additional duplicates of the auto-add workflow, up to a maximum defined for your plan (see the table earlier in this article). Each workflow can target a different repository. You can target the same repository with multiple workflows if the filter is unique for each workflow. - -Once you have duplicated a workflow, you can click **Edit** to start making changes to it. For more information, see [Configuring the auto-add workflow in your project](#configuring-the-auto-add-workflow-in-your-project). - -{% data reusables.projects.access-workflows %} -1. In the list of workflows, next to "Auto-add to project" click {% octicon "kebab-horizontal" aria-label="kebab-horizontal" %}. - - ![Screenshot showing the list of workflows. The ellipsis button next to the auto-add workflow is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-add-menu.png) - -1. In the menu, click **{% octicon "duplicate" aria-label="duplicate" %} Duplicate workflow**. -1. To save your new workflow, when prompted, type the name you want to use for the new workflow. - -{% endif %} - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations) diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md deleted file mode 100644 index 7a584d8a6a69..000000000000 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Archiving items automatically -shortTitle: Archiving items automatically -intro: You can configure your project's built-in workflows to automatically archive items that match a filter. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -contentType: tutorials -category: - - Automate your project ---- - -{% ifversion ghes %} - -{% data reusables.projects.enable_enterprise_workflows %} - -{% endif %} - -## About automatically archiving items - -{% ifversion projects-single-limit %} -You can configure your project's built-in workflows to automatically archive items. Archiving items helps you improve focus by removing old items from your project views. An archived item retains all of its custom field data and can be viewed or restored from the archive page. -{% else %} -You can configure your project's built-in workflows to automatically archive items. Archiving items will help you stay below the limit of {% data variables.projects.item_limit %} items in each project.{% endif %} - -The auto-archive workflow supports a subset of filters. You can use the following filters when configuring your workflow. - -| Qualifier | Possible values -| --- | --- | -| `is` | `open`, `closed`, `merged`, `draft`, `issue`, `pr` -| `reason` | `completed`, `reopened`, `"not planned"` -| `updated` | <@today-14d (the last 14 days), <@today-3w (the last 3 weeks), <@today-1m (the last month) - -{% data reusables.projects.last-updated-explanation %} - -Additionally, items are also marked as updated when field values in your project are changed. - -When you enable automatic archiving for issues or pull requests, items in your project that already meet your criteria will also be archived. There may be some delay in archiving large numbers of items that already meet the criteria. - -{% ifversion projects-single-limit %}Your project can contain up to {% data variables.projects.item_limit %} items across both active views and the archive page. Once that limit has been reached, you will need to delete items from your project to free up more space.{% else %} Projects also have a limit on the number of archived items they can contain. Your project can contain up to {% data variables.projects.legacy_archived_item_limit %} archived items.{% endif %} For more information on permanently deleting items, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project#deleting-items). - -## Configuring automatic archiving in your project - -{% data reusables.projects.access-workflows %} -1. In the "Default workflows" list, click **Auto-archive items**. -1. In the top right, click **Edit**. - - ![Screenshot showing a project's menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) - -1. In the "Filters" field, type the filter criteria you want to use to automatically archive items. You can only use the `is`, `reason`, and `updated` filters. -1. To save your changes and enable the workflow, click **Save and turn on workflow**. - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations) diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md deleted file mode 100644 index 48f10ead7a54..000000000000 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md +++ /dev/null @@ -1,320 +0,0 @@ ---- -title: Automating {% data variables.product.prodname_projects_v2 %} using Actions -shortTitle: Automating with Actions -intro: You can use {% data variables.product.prodname_actions %} to automate your projects. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/automating-projects -allowTitleToDifferFromFilename: true -layout: inline -contentType: tutorials -category: - - Automate your project ---- - - -## {% data variables.product.prodname_actions %} workflows - -This article demonstrates how to use the GraphQL API and {% data variables.product.prodname_actions %} to add a pull request to an organization project. In the example workflows, when the pull request is marked as "ready for review", a new task is added to the project with a "Status" field set to "Todo", and the current date is added to a custom "Date posted" field. - -You can copy one of the workflows below and modify it as described in the table below to meet your needs. - -A project can span multiple repositories, but a workflow is specific to a repository. Add the workflow to each repository that you want your project to track. For more information about creating workflow files, see [AUTOTITLE](/actions/quickstart). - -This article assumes that you have a basic understanding of {% data variables.product.prodname_actions %}. For more information about {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions). - -For more information about other changes you can make to your project through the API, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects). - -You may also want to use the **actions/add-to-project** workflow, which is maintained by {% data variables.product.company_short %} and will add the current issue or pull request to the project specified. For more information, see the [actions/add-to-project](https://github.com/actions/add-to-project) repository and README. - -> [!NOTE] -> `GITHUB_TOKEN` is scoped to the repository level and cannot access {% data variables.projects.projects_v2 %}. To access {% data variables.projects.projects_v2 %} you can either create a {% data variables.product.prodname_github_app %} (recommended for organization projects) or a {% data variables.product.pat_generic %} (recommended for user projects). Workflow examples for both approaches are shown below. - -## Example workflow authenticating with a {% data variables.product.prodname_github_app %} - -For more information about authenticating in a {% data variables.product.prodname_actions %} workflow with a {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow). - -1. Create a {% data variables.product.prodname_github_app %} or choose an existing {% data variables.product.prodname_github_app %} owned by your organization. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app). -1. Give your {% data variables.product.prodname_github_app %} read and write permissions to organization projects. For this specific example, your {% data variables.product.prodname_github_app %} will also need read permissions to repository pull requests and repository issues. For more information, see [AUTOTITLE](/apps/maintaining-github-apps/editing-a-github-apps-permissions). - - > [!NOTE] - > You can control your app's permission to organization projects and to repository projects. You must give permission to read and write organization projects; permission to read and write repository projects will not be sufficient. - -1. Install the {% data variables.product.prodname_github_app %} in your organization. Install it for all repositories that your project needs to access. For more information, see [AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps#installing-your-private-github-app-on-your-repository). -1. Store your {% data variables.product.prodname_github_app %}'s ID as a configuration variable in your repository or organization. In the following workflow, replace `APP_ID` with the name of the configuration variable. You can find your app ID on the settings page for your app or through the App API. For more information, see [AUTOTITLE](/rest/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). -1. Generate a private key for your app. Store the contents of the resulting file as a secret in your repository or organization. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following workflow, replace `APP_PEM` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about storing secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). -1. In the following workflow, replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. In order for this specific example to work, your project must also have a "Date posted" date field. - -```yaml annotate copy -# -name: Add PR to project -# This workflow runs whenever a pull request in the repository is marked as "ready for review". -on: - pull_request: - types: - - ready_for_review -jobs: - track_pr: - runs-on: ubuntu-latest - steps: - # Uses the [actions/create-github-app-token](https://github.com/marketplace/actions/create-github-app-token) action to generate an installation access token for your app from the app ID and private key. The installation access token is accessed later in the workflow as `{% raw %}${{ steps.generate-token.outputs.token }}{% endraw %}`. - # - # Replace `APP_ID` with the name of the configuration variable that contains your app ID. - # - # Replace `APP_PEM` with the name of the secret that contains your app private key. - - name: Generate token - id: generate-token - uses: actions/create-github-app-token@v2 - with: - app-id: {% raw %}${{ vars.APP_ID }}{% endraw %} - private-key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} - # Sets environment variables for this step. - # - # Replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. - # - # Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. - - name: Get project data - env: - GH_TOKEN: {% raw %}${{ steps.generate-token.outputs.token }}{% endraw %} - ORGANIZATION: YOUR_ORGANIZATION - PROJECT_NUMBER: YOUR_PROJECT_NUMBER - # Uses [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) to query the API for the ID of the project and return the name and ID of the first 20 fields in the project. `fields` returns a union and the query uses inline fragments (`... on`) to return information about any `ProjectV2Field` and `ProjectV2SingleSelectField` fields. The response is stored in a file called `project_data.json`. - run: | - gh api graphql -f query=' - query($org: String!, $number: Int!) { - organization(login: $org){ - projectV2(number: $number) { - id - fields(first:20) { - nodes { - ... on ProjectV2Field { - id - name - } - ... on ProjectV2SingleSelectField { - id - name - options { - id - name - } - } - } - } - } - } - }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json - - # Parses the response from the API query and stores the relevant IDs as environment variables. Modify this to get the ID for different fields or options. For example: - # - # - To get the ID of a field called `Team`, add `echo 'TEAM_FIELD_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Team") | .id' project_data.json) >> $GITHUB_ENV`. - # - To get the ID of an option called `Octoteam` for the `Team` single select field, add `echo 'OCTOTEAM_OPTION_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Team") |.options[] | select(.name=="Octoteam") |.id' project_data.json) >> $GITHUB_ENV`. - # - # **Note:** This workflow assumes that you have a project with a single select field called "Status" that includes an option called "Todo" and a date field called "Date posted". You must modify this section to match the fields that are present in your table. - - echo 'PROJECT_ID='$(jq '.data.organization.projectV2.id' project_data.json) >> $GITHUB_ENV - echo 'DATE_FIELD_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Date posted") | .id' project_data.json) >> $GITHUB_ENV - echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV - echo 'TODO_OPTION_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Status") | .options[] | select(.name=="Todo") |.id' project_data.json) >> $GITHUB_ENV - -# Sets environment variables for this step. `GH_TOKEN` is the token generated in the first step. `PR_ID` is the ID of the pull request that triggered this workflow. - - name: Add PR to project - env: - GH_TOKEN: {% raw %}${{ steps.generate-token.outputs.token }}{% endraw %} - PR_ID: {% raw %}${{ github.event.pull_request.node_id }}{% endraw %} - # Uses [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) and the API to add the pull request that triggered this workflow to the project. The `jq` flag parses the response to get the ID of the created item. - run: | - item_id="$( gh api graphql -f query=' - mutation($project:ID!, $pr:ID!) { - addProjectV2ItemById(input: {projectId: $project, contentId: $pr}) { - item { - id - } - } - }' -f project=$PROJECT_ID -f pr=$PR_ID --jq '.data.addProjectV2ItemById.item.id')" - - # Stores the ID of the created item as an environment variable. - echo 'ITEM_ID='$item_id >> $GITHUB_ENV - -# Saves the current date as an environment variable in `yyyy-mm-dd` format. - - name: Get date - run: echo "DATE=$(date +"%Y-%m-%d")" >> $GITHUB_ENV - -# Sets environment variables for this step. `GH_TOKEN` is the token generated in the first step. - - name: Set fields - env: - GH_TOKEN: {% raw %}${{ steps.generate-token.outputs.token }}{% endraw %} - # Sets the value of the `Status` field to `Todo`. Sets the value of the `Date posted` field. - run: | - gh api graphql -f query=' - mutation ( - $project: ID! - $item: ID! - $status_field: ID! - $status_value: String! - $date_field: ID! - $date_value: Date! - ) { - set_status: updateProjectV2ItemFieldValue(input: { - projectId: $project - itemId: $item - fieldId: $status_field - value: { - singleSelectOptionId: $status_value - } - }) { - projectV2Item { - id - } - } - set_date_posted: updateProjectV2ItemFieldValue(input: { - projectId: $project - itemId: $item - fieldId: $date_field - value: { - date: $date_value - } - }) { - projectV2Item { - id - } - } - }' -f project=$PROJECT_ID -f item=$ITEM_ID -f status_field=$STATUS_FIELD_ID -f status_value={% raw %}${{ env.TODO_OPTION_ID }}{% endraw %} -f date_field=$DATE_FIELD_ID -f date_value=$DATE --silent -``` - -## Example workflow authenticating with a {% data variables.product.pat_generic %} - -1. Create a {% data variables.product.pat_v1 %} with the `project` and `repo` scopes. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). -1. Save the {% data variables.product.pat_generic %} as a secret in your repository or organization. -1. In the following workflow, replace `YOUR_TOKEN` with the name of the secret. Replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. - -```yaml annotate copy -# This workflow runs whenever a pull request in the repository is marked as "ready for review". -name: Add PR to project -on: - pull_request: - types: - - ready_for_review -jobs: - track_pr: - runs-on: ubuntu-latest - steps: - # Sets environment variables for this step. - # - # If you are using a {% data variables.product.pat_generic %}, replace `YOUR_TOKEN` with the name of the secret that contains your {% data variables.product.pat_generic %}. - # - # Replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. - # - # Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. - - name: Get project data - env: - GH_TOKEN: {% raw %}${{ secrets.YOUR_TOKEN }}{% endraw %} - ORGANIZATION: YOUR_ORGANIZATION - PROJECT_NUMBER: YOUR_PROJECT_NUMBER - # Uses [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) to query the API for the ID of the project and return the name and ID of the first 20 fields in the project. `fields` returns a union and the query uses inline fragments (`... on`) to return information about any `ProjectV2Field` and `ProjectV2SingleSelectField` fields. The response is stored in a file called `project_data.json`. - run: | - gh api graphql -f query=' - query($org: String!, $number: Int!) { - organization(login: $org){ - projectV2(number: $number) { - id - fields(first:20) { - nodes { - ... on ProjectV2Field { - id - name - } - ... on ProjectV2SingleSelectField { - id - name - options { - id - name - } - } - } - } - } - } - }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json - - # Parses the response from the API query and stores the relevant IDs as environment variables. Modify this to get the ID for different fields or options. For example: - # - # - To get the ID of a field called `Team`, add `echo 'TEAM_FIELD_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Team") | .id' project_data.json) >> $GITHUB_ENV`. - # - To get the ID of an option called `Octoteam` for the `Team` single select field, add `echo 'OCTOTEAM_OPTION_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Team") |.options[] | select(.name=="Octoteam") |.id' project_data.json) >> $GITHUB_ENV`. - # - # **Note:** This workflow assumes that you have a project with a single select field called "Status" that includes an option called "Todo" and a date field called "Date posted". You must modify this section to match the fields that are present in your table. - - echo 'PROJECT_ID='$(jq '.data.organization.projectV2.id' project_data.json) >> $GITHUB_ENV - echo 'DATE_FIELD_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Date posted") | .id' project_data.json) >> $GITHUB_ENV - echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV - echo 'TODO_OPTION_ID='$(jq '.data.organization.projectV2.fields.nodes[] | select(.name== "Status") | .options[] | select(.name=="Todo") |.id' project_data.json) >> $GITHUB_ENV - -# Sets environment variables for this step. Replace `YOUR_TOKEN` with the name of the secret that contains your {% data variables.product.pat_generic %}. - - name: Add PR to project - env: - GH_TOKEN: {% raw %}${{ secrets.YOUR_TOKEN }}{% endraw %} - PR_ID: {% raw %}${{ github.event.pull_request.node_id }}{% endraw %} - # Uses [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) and the API to add the pull request that triggered this workflow to the project. The `jq` flag parses the response to get the ID of the created item. - run: | - item_id="$( gh api graphql -f query=' - mutation($project:ID!, $pr:ID!) { - addProjectV2ItemById(input: {projectId: $project, contentId: $pr}) { - item { - id - } - } - }' -f project=$PROJECT_ID -f pr=$PR_ID --jq '.data.addProjectV2ItemById.item.id')" - - # Stores the ID of the created item as an environment variable. - echo 'ITEM_ID='$item_id >> $GITHUB_ENV - -# Saves the current date as an environment variable in `yyyy-mm-dd` format. - - name: Get date - run: echo "DATE=$(date +"%Y-%m-%d")" >> $GITHUB_ENV - -# Sets environment variables for this step. Replace `YOUR_TOKEN` with the name of the secret that contains your {% data variables.product.pat_generic %}. - - name: Set fields - env: - GH_TOKEN: {% raw %}${{ secrets.YOUR_TOKEN }}{% endraw %} - # Sets the value of the `Status` field to `Todo`. Sets the value of the `Date posted` field. - run: | - gh api graphql -f query=' - mutation ( - $project: ID! - $item: ID! - $status_field: ID! - $status_value: String! - $date_field: ID! - $date_value: Date! - ) { - set_status: updateProjectV2ItemFieldValue(input: { - projectId: $project - itemId: $item - fieldId: $status_field - value: { - singleSelectOptionId: $status_value - } - }) { - projectV2Item { - id - } - } - set_date_posted: updateProjectV2ItemFieldValue(input: { - projectId: $project - itemId: $item - fieldId: $date_field - value: { - date: $date_value - } - }) { - projectV2Item { - id - } - } - }' -f project=$PROJECT_ID -f item=$ITEM_ID -f status_field=$STATUS_FIELD_ID -f status_value={% raw %}${{ env.TODO_OPTION_ID }}{% endraw %} -f date_field=$DATE_FIELD_ID -f date_value=$DATE --silent - -``` diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/index.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/index.md deleted file mode 100644 index f38849ff5cc7..000000000000 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 'Automating your {% data variables.projects.project_v2 %}' -shortTitle: 'Automating {% data variables.projects.projects_v2 %}' -intro: 'Learn how to use the built-in workflows, {% data variables.product.prodname_actions %}, and the API to automate your projects.' -versions: - feature: projects-v2 -children: - - /using-the-built-in-automations - - /using-the-api-to-manage-projects - - /automating-projects-using-actions - - /adding-items-automatically - - /archiving-items-automatically -allowTitleToDifferFromFilename: true ---- - diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md deleted file mode 100644 index b0bbac4bfc56..000000000000 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ /dev/null @@ -1,833 +0,0 @@ ---- -title: Using the API to manage {% data variables.product.prodname_projects_v2 %} -shortTitle: Automating with the API -intro: You can use the GraphQL API to automate your projects. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/using-the-api-to-manage-projects -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Automate your project ---- - -This article demonstrates how to use the GraphQL API to manage a project. For more information about how to use the API in a {% data variables.product.prodname_actions %} workflow, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions). For a full list of the available data types, see [AUTOTITLE](/graphql/reference). - -## Authentication - -{% curl %} - -In all of the following `curl` command examples, replace `TOKEN` with a token that has the `read:project` scope (for queries) or `project` scope (for queries and mutations). The token can be a {% data variables.product.pat_v1 %} for a user or an installation access token for a {% data variables.product.prodname_github_app %}. For more information about creating a {% data variables.product.pat_generic %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). For more information about creating an installation access token for a {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app). - -When using an installation access token for a {% data variables.product.prodname_github_app %}, some GraphQL mutations require additional permissions. For example, when using the `createProjectV2` mutation, if you specify a `repositoryId` input parameter, the `Contents` permission for that repository is also required in order to link the project to the target repository. - -{% endcurl %} - -{% cli %} - -{% data reusables.cli.cli-learn-more %} - -Before running {% data variables.product.prodname_cli %} commands, you must authenticate by running `gh auth login --scopes "project"`. If you only need to read, but not edit, projects, you can provide the `read:project` scope instead of `project`. For more information on command line authentication, see [gh auth login](https://cli.github.com/manual/gh_auth_login). - -{% endcli %} - -{% cli %} - -## Using variables - -In all of the following examples, you can use variables to simplify your scripts. Use `-F` to pass a variable that is a number, Boolean, or null. Use `-f` for other variables. For example, - -```shell -my_org="octo-org" -my_num=5 -gh api graphql -f query=' - query($organization: String! $number: Int!){ - organization(login: $organization){ - projectV2(number: $number) { - id - } - } - }' -f organization=$my_org -F number=$my_num -``` - -For more information, see [AUTOTITLE](/graphql/guides/forming-calls-with-graphql#working-with-variables). - -{% endcli %} - -## Finding information about projects - -Use queries to get data about projects. For more information, see [AUTOTITLE](/graphql/guides/forming-calls-with-graphql#about-queries). - -### Finding the node ID of an organization project - -To update your project through the API, you will need to know the node ID of the project. - -You can find the node ID of an organization project if you know the organization name and project number. Replace `ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `NUMBER` with the project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - organization(login: "ORGANIZATION"){ - projectV2(number: NUMBER) { - id - } - } - }' -``` - -{% endcli %} - -You can also find the node ID of all projects in your organization. The following example will return the node ID and title of the first 20 projects in an organization. Replace `ORGANIZATION` with the name of your organization. For example, `octo-org`. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - organization(login: "ORGANIZATION") { - projectsV2(first: 20) { - nodes { - id - title - } - } - } - }' -``` - -{% endcli %} - -### Finding the node ID of a user project - -To update your project through the API, you will need to know the node ID of the project. - -You can find the node ID of a user project if you know the project number. Replace `USER` with your user name. For example, `octocat`. Replace `NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/users/octocat/projects/5` has a project number of 5. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - user(login: "USER"){ - projectV2(number: NUMBER) { - id - } - } - }' -``` - -{% endcli %} - -You can also find the node ID for all of your projects. The following example will return the node ID and title of your first 20 projects. Replace `USER` with your username. For example, `octocat`. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - user(login: "USER") { - projectsV2(first: 20) { - nodes { - id - title - } - } - } - }' -``` - -{% endcli %} - -### Finding the node ID of a field - -To update the value of a field, you will need to know the node ID of the field. Additionally, you will need to know the ID of the options for single select fields and the ID of the iterations for iteration fields. - -The following example will return the ID, name, settings, and configuration for the first 20 fields in a project. Replace `PROJECT_ID` with the node ID of your project. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - node(id: "PROJECT_ID") { - ... on ProjectV2 { - fields(first: 20) { - nodes { - ... on ProjectV2Field { - id - name - } - ... on ProjectV2IterationField { - id - name - configuration { - iterations { - startDate - id - } - } - } - ... on ProjectV2SingleSelectField { - id - name - options { - id - name - } - } - } - } - } - } -}' -``` - -{% endcli %} - -The response will look similar to the following example: - -```json -{ - "data": { - "node": { - "fields": { - "nodes": [ - { - "id": "PVTF_lADOANN5s84ACbL0zgBZrZY", - "name": "Title" - }, - { - "id": "PVTF_lADOANN5s84ACbL0zgBZrZc", - "name": "Assignees" - }, - { - "id": "PVTSSF_lADOANN5s84ACbL0zgBZrZg", - "name": "Status", - "options": [ - { - "id": "f75ad846", - "name": "Todo" - }, - { - "id": "47fc9ee4", - "name": "In Progress" - }, - { - "id": "98236657", - "name": "Done" - } - ] - }, - { - "id": "PVTIF_lADOANN5s84ACbL0zgBah28", - "name": "Iteration", - "configuration": { - "iterations": [ - { - "startDate": "2022-05-29", - "id": "cfc16e4d" - } - ] - } - } - ] - } - } - } -} -``` - -Each field has an ID and name. Single select fields are returned as a `ProjectV2SingleSelectField` object and have an `options` field where you can find the ID of each option for the single select. Iteration fields are returned as a `ProjectV2IterationField` object and have a `configuration` field which includes an `iterations` field containing the ID and information about each iteration. - -If you just need the name and ID of a field, and do not need information about iterations or a single select field's options, you can make use of the `ProjectV2FieldCommon` object. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - node(id: "PROJECT_ID") { - ... on ProjectV2 { - fields(first: 20) { - nodes { - ... on ProjectV2FieldCommon { - id - name - } - } - } - } - } -}' -``` - -{% endcli %} - -The response when using the `ProjectV2FieldCommon` object will look similar to the following example: - -```json -{ - "data": { - "node": { - "fields": { - "nodes": [ - { - "__typename": "ProjectV2Field", - "id": "PVTF_lADOANN5s84ACbL0zgBZrZY", - "name": "Title" - }, - { - "__typename": "ProjectV2Field", - "id": "PVTF_lADOANN5s84ACbL0zgBZrZc", - "name": "Assignees" - }, - { - "__typename": "ProjectV2SingleSelectField", - "id": "PVTSSF_lADOANN5s84ACbL0zgBZrZg", - "name": "Status" - }, - { - "__typename": "ProjectV2IterationField", - "id": "PVTIF_lADOANN5s84ACbL0zgBah28", - "name": "Iteration" - } - ] - } - } - } -} -``` - -### Finding information about items in a project - -You can query the API to find information about items in your project. - -The following example will return the first 20 issues, pull requests, and draft issues in a project. For issues and pull requests, it will also return title and the first 10 assignees. For draft issue, it will return the title and body. The example will also return the field name and value for any text, date, or single select fields in the first 8 fields of the project. Replace `PROJECT_ID` with the node ID of your project. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - query{ - node(id: "PROJECT_ID") { - ... on ProjectV2 { - items(first: 20) { - nodes{ - id - fieldValues(first: 8) { - nodes{ - ... on ProjectV2ItemFieldTextValue { - text - field { - ... on ProjectV2FieldCommon { - name - } - } - } - ... on ProjectV2ItemFieldDateValue { - date - field { - ... on ProjectV2FieldCommon { - name - } - } - } - ... on ProjectV2ItemFieldSingleSelectValue { - name - field { - ... on ProjectV2FieldCommon { - name - } - } - } - } - } - content{ - ... on DraftIssue { - title - body - } - ...on Issue { - title - assignees(first: 10) { - nodes{ - login - } - } - } - ...on PullRequest { - title - assignees(first: 10) { - nodes{ - login - } - } - } - } - } - } - } - } - }' -``` - -{% endcli %} - -A project may contain items that a user does not have permission to view. In this case, the item type will be returned as `REDACTED`. - -## Updating projects - -Use mutations to update projects. For more information, see [AUTOTITLE](/graphql/guides/forming-calls-with-graphql#about-mutations). - -> [!NOTE] -> You cannot add and update an item in the same call. You must use `addProjectV2ItemById` to add the item and then use `updateProjectV2ItemFieldValue` to update the item. - -### Adding an item to a project - -The following example will add an issue or pull request to your project. Replace `PROJECT_ID` with the node ID of your project. Replace `CONTENT_ID` with the node ID of the issue or pull request that you want to add. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { - item { - id - } - } - }' -``` - -{% endcli %} - -The response will contain the node ID of the newly created item. - -```json -{ - "data": { - "addProjectV2ItemById": { - "item": { - "id": "PVTI_lADOANN5s84ACbL0zgBVd94" - } - } - } -} -``` - -If you try to add an item that already exists, the existing item ID is returned instead. - -### Adding a draft issue to a project - -The following example will add a draft issue to your project. Replace `PROJECT_ID` with the node ID of your project. Replace `TITLE` and `BODY` with the content you want for the new draft issue. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: \"PROJECT_ID\" title: \"TITLE\" body: \"BODY\"}) {projectItem {id}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { - projectItem { - id - } - } - }' -``` - -{% endcli %} - -The response will contain the node ID of the newly created draft issue. - -```json -{ - "data": { - "addProjectV2DraftIssue": { - "projectItem": { - "id": "PVTI_lADOANN5s84ACbL0zgBbxFc" - } - } - } -} -``` - -### Updating a project's settings - -The following example will update your project's settings. Replace `PROJECT_ID` with the node ID of your project. Set `public` to `true` to make your project public on {% data variables.product.github %}. Modify `readme` to make changes to your project's README. - -{% curl %} - -```shell -curl --request POST \ ---url https://api.github.com/graphql \ ---header 'Authorization: Bearer TOKEN' \ ---data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - updateProjectV2( - input: { - projectId: "PROJECT_ID", - title: "Project title", - public: false, - readme: "# Project README\n\nA long description", - shortDescription: "A short description" - } - ) { - projectV2 { - id - title - readme - shortDescription - } - } - }' -``` - -{% endcli %} - -### Updating a custom text, number, or date field - -The following example will update the value of a text field for an item. Replace `PROJECT_ID` with the node ID of your project. Replace `ITEM_ID` with the node ID of the item you want to update. Replace `FIELD_ID` with the ID of the field that you want to update. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\" fieldId: \"FIELD_ID\" value: { text: \"Updated text\" }}) { projectV2Item { id }}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - updateProjectV2ItemFieldValue( - input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" - value: { - text: "Updated text" - } - } - ) { - projectV2Item { - id - } - } - }' -``` - -{% endcli %} - -> [!NOTE] -> You cannot use `updateProjectV2ItemFieldValue` to change `Assignees`, `Labels`, `Milestone`, or `Repository` because these fields are properties of pull requests and issues, not of project items. Instead, you may use the following mutations: -> -> * [addAssigneesToAssignable](/graphql/reference/mutations#addassigneestoassignable) -> * [removeAssigneesFromAssignable](/graphql/reference/mutations#removeassigneesfromassignable) -> * [addLabelsToLabelable](/graphql/reference/mutations#addlabelstolabelable) -> * [removeLabelsFromLabelable](/graphql/reference/mutations#removelabelsfromlabelable) -> * [updateIssue](/graphql/reference/mutations#updateissue) -> * [updatePullRequest](/graphql/reference/mutations#updatepullrequest) -> * [transferIssue](/graphql/reference/mutations#transferissue) - -### Updating a single select field - -The following example will update the value of a single select field for an item. - -* `PROJECT_ID` - Replace this with the node ID of your project. -* `ITEM_ID` - Replace this with the node ID of the item you want to update. -* `FIELD_ID` - Replace this with the ID of the single select field that you want to update. -* `OPTION_ID` - Replace this with the ID of the desired single select option. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\" fieldId: \"FIELD_ID\" value: { singleSelectOptionId: \"OPTION_ID\" }}) { projectV2Item { id }}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - updateProjectV2ItemFieldValue( - input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" - value: { - singleSelectOptionId: "OPTION_ID" - } - } - ) { - projectV2Item { - id - } - } - }' -``` - -{% endcli %} - -### Updating an iteration field - -The following example will update the value of an iteration field for an item. - -* `PROJECT_ID` - Replace this with the node ID of your project. -* `ITEM_ID` - Replace this with the node ID of the item you want to update. -* `FIELD_ID` - Replace this with the ID of the iteration field that you want to update. -* `ITERATION_ID` - Replace this with the ID of the desired iteration. This can be either an active or completed iteration. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\" fieldId: \"FIELD_ID\" value: { iterationId: \"ITERATION_ID\" }}) { projectV2Item { id }}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - updateProjectV2ItemFieldValue( - input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" - value: { - iterationId: "ITERATION_ID" - } - } - ) { - projectV2Item { - id - } - } - }' -``` - -{% endcli %} - -### Deleting an item from a project - -The following example will delete an item from a project. Replace `PROJECT_ID` with the node ID of your project. Replace `ITEM_ID` with the node ID of the item you want to delete. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation { - deleteProjectV2Item( - input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - } - ) { - deletedItemId - } - }' -``` - -{% endcli %} - -## Managing projects - -### Creating projects - -You can use a mutation to create a new project. For more information, see [AUTOTITLE](/graphql/guides/forming-calls-with-graphql#about-mutations). - -To create a new project using the API, you'll need to provide a name for the project and the node ID of a {% data variables.product.github %} user or organization who will become the project's owner. - -You can find the node ID of a {% data variables.product.github %} user or organization if you know the username. Replace GITHUB_OWNER with the {% data variables.product.github %} username of the new project owner. - -{% curl %} - -```shell -curl --request GET \ - --url https://api.github.com/users/GITHUB_OWNER \ - --header 'Authorization: token TOKEN' \ - --header 'Accept: application/vnd.github+json' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api -H "Accept: application/vnd.github+json" /users/GITHUB_OWNER -``` - -{% endcli %} - -To create the project, replace `OWNER_ID` with the node ID of the new project owner and replace `PROJECT_NAME` with a name for the project. - -{% curl %} - -```shell -curl --request POST \ - --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ - --data '{"query":"mutation {createProjectV2(input: {ownerId: \"OWNER_ID\" title: \"PROJECT_NAME\"}) {projectV2 {id}}}"}' -``` - -{% endcurl %} - -{% cli %} - -```shell -gh api graphql -f query=' - mutation{ - createProjectV2( - input: { - ownerId: "OWNER_ID", - title: "PROJECT_NAME" - } - ){ - projectV2 { - id - } - } - }' -``` - -{% endcli %} - -## Using webhooks - -You can use webhooks to subscribe to events taking place in your project. For example, when an item is edited, {% data variables.product.github %} can send a HTTP POST payload to the webhook's configured URL which can trigger automation on your server. For more information about webhooks, see [AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks). To learn more about the `projects_v2_item` webhook event, see [AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#projects_v2_item). diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations.md deleted file mode 100644 index 6916d4efdb00..000000000000 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Using the built-in automations -shortTitle: Using built-in automations -intro: You can use built-in workflows to automate your projects. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -contentType: tutorials -category: - - Automate your project ---- - - -{% ifversion ghes %} - -{% data reusables.projects.enable_enterprise_workflows %} - -{% endif %} - -{% 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, close issues when the issue's status in your project is changed, 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**. - -You can also configure workflows to automatically archive items when they meet set criteria and to automatically add items from a repository when they match a filter. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically). - -## Enabling a built-in workflow - -You can enable or disable the built-in workflows for your project. - -{% data reusables.projects.access-workflows %} -1. Under "Default workflows," click on the workflow that you want to edit. -1. In the top right, click **Edit**. - - ![Screenshot showing a project's menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) - -1. Depending on the workflow you have selected, make changes to the fields to configure the workflow's behavior. -1. To save your changes and enable the workflow, click **Save and turn on workflow**. diff --git a/content/issues/planning-and-tracking-with-projects/creating-projects/copying-an-existing-project.md b/content/issues/planning-and-tracking-with-projects/creating-projects/copying-an-existing-project.md deleted file mode 100644 index 19e896d4e8b6..000000000000 --- a/content/issues/planning-and-tracking-with-projects/creating-projects/copying-an-existing-project.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Copying an existing {% data variables.projects.project_v2 %} -shortTitle: Copying a project -intro: You can use an existing project as a template by copying it. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - -## About copying projects - -You can copy an existing project and use it as a template to save time configuring your views and custom fields. - -When you copy a project, the new project will contain the same {% data reusables.projects.what-gets-copied %}. The new project will not contain the original project's items, collaborators, or team and repository links. - -{% data reusables.projects.org-templates %} - -## Copying an existing project - -1. Navigate to the project you want to copy. -1. In the top-right, click {% octicon "kebab-horizontal" aria-label="More options" %} to open the menu. - - ![Screenshot showing a project's menu bar. The menu icon is highlighted with an orange outline.](/assets/images/help/projects-v2/open-menu.png) - -1. In the menu, click **{% octicon "copy" aria-hidden="true" aria-label="copy" %} Make a copy**. -1. Optionally, if you want all draft issues to be copied with the project, in the "Make a copy" dialog, select **Draft issues will be copied if selected**. -1. Under "Owner", select either the organization that will own the new project or your personal account. -1. Under "New project name", type the name of the new project. -1. Click **Copy project**. diff --git a/content/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project.md b/content/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project.md deleted file mode 100644 index fac35789bad1..000000000000 --- a/content/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Creating a {% data variables.projects.project_v2 %} -intro: Learn how to create an organization or user project. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/creating-a-project -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - -{% data variables.product.prodname_projects_v2 %} are an adaptable collection of items that stay up-to-date with {% data variables.product.company_short %} data. Your projects can track issues, pull requests, and ideas that you note down. You can add custom fields and create views for specific purposes. - -You can also choose to use an existing project as a template and copy the views and custom fields to a new project. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/copying-an-existing-project). - -## Creating a project - -### Creating an organization project - -Organization projects can track issues and pull requests from the organization's repositories. {% data reusables.projects.org-templates %} - -{% data reusables.projects.create-project %} - -### Creating a user project - -User projects can track issues and pull requests from the repositories owned by your personal account. - -{% data reusables.projects.create-user-project %} - -## Updating your project description and README - -{% data reusables.projects.project-description %} - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) diff --git a/content/issues/planning-and-tracking-with-projects/creating-projects/index.md b/content/issues/planning-and-tracking-with-projects/creating-projects/index.md deleted file mode 100644 index 0cccc3eb8f08..000000000000 --- a/content/issues/planning-and-tracking-with-projects/creating-projects/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Creating {% data variables.projects.projects_v2 %}' -shortTitle: 'Creating {% data variables.projects.projects_v2 %}' -intro: 'Learn about creating projects and copying existing projects.' -versions: - feature: projects-v2 -children: - - /creating-a-project - - /copying-an-existing-project - - /migrating-from-projects-classic -allowTitleToDifferFromFilename: true ---- - diff --git a/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md b/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md deleted file mode 100644 index d3103e431df8..000000000000 --- a/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Migrating from {% data variables.product.prodname_projects_v1 %} -intro: You can migrate your {% data variables.projects.projects_v1_board %} to the new {% data variables.product.prodname_projects_v2 %} experience. -versions: - feature: projects-v2-migration -redirect_from: - - /issues/trying-out-the-new-projects-experience/migrating-your-project -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - -> [!NOTE] -> * If the project you are migrating contains more than {% data variables.projects.legacy_item_limit %} items, open issues will be prioritized followed by open pull requests and then notes. Remaining space will be used for closed issues, merged pull requested, and closed pull requests. Items that cannot be migrated due to this limit will be moved to the archive. If the archive limit of {% data variables.projects.legacy_archived_item_limit %} items is reached, additional items will not be migrated. -> * Note cards are converted to draft issues, and the contents are saved to the body of the draft issue. If information appears to be missing, make any hidden fields visible. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#showing-and-hiding-fields). -> * Automation will not be migrated. -> * Triage, archive, and activity will not be migrated. -> * After migration, the new migrated project and old project will not be kept in sync. -> * {% data reusables.projects.migration-permissions-warning %} - -## About project migration - -You can migrate your {% data variables.projects.projects_v1_boards %} to the new {% data variables.product.prodname_projects_v2 %} experience and try out tables, multiple views, new automation options, and powerful field types. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). - -## Migrating an organization {% data variables.projects.projects_v1_board %} - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.organizations.organization-wide-project %} -1. In the left sidebar, click **Projects (classic)**. -{% data reusables.projects.migrate-project-steps %} - -## Migrating a user {% data variables.projects.projects_v1_board %} - -1. In the upper-right corner of {% data variables.product.prodname_dotcom %}, click your profile picture, then click **Your projects**. - - ![Screenshot showing the profile picture menu. The "Your projects" link is highlighted with an orange outline.](/assets/images/help/projects-v2/projects-profile-menu.png) - -1. On the top of your profile page, in the main navigation, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. - ![Screenshot showing the tabs on a user profile. The 'Projects' tab is highlighted with an orange outline.](/assets/images/help/projects-v2/tab-projects.png) -1. Above the list of projects, click **Projects (classic)**. -{% data reusables.projects.migrate-project-steps %} - -## Migrating a repository {% data variables.projects.projects_v1_board %} - -> [!NOTE] -> {% data variables.projects.projects_v2_caps %} does not support repository level projects. When you migrate a repository {% data variables.projects.projects_v1_board %}, it will migrate to either the organization or personal account that owns the repository project, and the migrated project will be pinned to the original repository. - -{% data reusables.repositories.navigate-to-repo %} -1. Under your repository name, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -1. In the left sidebar, click **Projects (classic)**. -{% data reusables.projects.migrate-project-steps %} diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view.md deleted file mode 100644 index 0050b58658f8..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Changing the layout of a view -shortTitle: Changing the layout -intro: You can view your project as a high-density table, as a kanban board, or as a timeline-style roadmap. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/customizing-your-project-views - - /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-a-view -contentType: tutorials -category: - - Customize project views and insights ---- - -## About the table layout - -{% data reusables.projects.about-table-layout %} For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout). - -![Screenshot showing an example table layout.](/assets/images/help/projects-v2/example-table.png) - -## About the board layout - -{% data reusables.projects.about-board-layout %} For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout). - -![Screenshot showing an example board layout.](/assets/images/help/projects-v2/example-board.png) - -## About the roadmap layout - -{% data reusables.projects.about-roadmap-layout %} For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout). - -![Screenshot showing an example roadmap layout.](/assets/images/help/projects-v2/example-roadmap.png) - -## Changing the project layout - -You can set each view in your project to a different layout. - -{% data reusables.projects.open-view-menu %} - -1. Under "Layout", click either **Table**, **Board** or **Roadmap**. diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md deleted file mode 100644 index f822f52b94b4..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Customizing the board layout -shortTitle: Customizing boards -intro: You can use the board layout to arrange your project's items over customizable columns. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: tutorials -category: - - Customize project views and insights ---- - -## About the board layout - -{% data reusables.projects.about-board-layout %} - -For more information about changing a view to use the board layout, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#changing-the-project-layout). - -## Setting a limit on the number of items in a column - -You can set a limit for the number of cards in a particular column in a board layout. Setting a limit does not restrict anyone from adding cards that would exceed the column's limit, nor does it restrict any automations from adding cards. Column limits are unique to each view in your project. - -The current count of cards and the column's limit is displayed at the top of the column and is highlighted when the current count exceeds the limit. You can use column limits to communicate how you want the column to be used and to make clear at which point action needs to be taken to reduce the number of the cards in the column. - -1. Click {% octicon "kebab-horizontal" aria-label="Column context menu" %} next to the name of the column you want to modify. - ![Screenshot showing a top of a column in the table layout. The column context menu button is highlighted with an orange outline.](/assets/images/help/projects-v2/board-column-menu.png) -1. In the menu, click **{% octicon "number" aria-hidden="true" aria-label="number" %} Set column limit**. -1. Under "Column limit", type the card limit for this column. -1. Optionally, to remove the limit, clear the entry. -1. Click **Save**. - -## Showing and hiding fields - -{% data reusables.projects.customize.show-hide-field %} - -## Setting the column field in board layout - -In the board layout, you choose any single select or iteration field for your columns. If you drag an item to a new column, the value of that column is applied to the dragged item. For example, if you use the "Status" field for your board columns and then drag an item with a status of `In progress` to the `Done` column, the status of the item will switch to `Done`. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "columns" aria-hidden="true" aria-label="columns" %} Column field**. -1. Click the field you want to use. - -## Showing and hiding columns in board layout - -In the board layout, you can choose which columns to display. The available columns are made up of the contents of your selected column field. - -1. In the board layout, scroll to the right of your columns, and click {% octicon "plus" aria-label="Add a new column to the board" %}. - - ![Screenshot of a board layout scrolled to the very right. The "Add a new column to the board" button is highlighted with an orange outline.](/assets/images/help/projects-v2/board-add-column.png) - -1. Select the columns you want to show. - -## Slicing by field values - -{% data reusables.projects.customize.slice-panel %} - -## Sorting by field values - -You can sort items by a field value. - -> [!NOTE] -> When a board is sorted, you cannot manually reorder items within a column. You can continue to move items from column to column. - -{% data reusables.projects.customize.sort %} - -## Grouping by field values - -You can use a custom field value to group items and create horizontal sections on your board. These sections provide an additional way to organize and visually separate items. Additionally, horizontal grouping allows you to differentiate work according to work streams, team members, or varying levels of urgency or priority. - -{% data reusables.projects.customize.update-status %} - -{% data reusables.projects.customize.group-fields %} - -## Showing the sum of a number field - -{% data reusables.projects.customize.sum %} diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md deleted file mode 100644 index a7b068d4c200..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Customizing the roadmap layout -shortTitle: Customizing roadmaps -intro: You can use the roadmap layout to view your project's items on a timeline. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -contentType: tutorials -category: - - Customize project views and insights ---- - -## About the roadmap layout - -{% data reusables.projects.about-roadmap-layout %} - -For more information about changing a view to use the roadmap layout, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#changing-the-project-layout). - -## Setting the start and target date fields - -You can set the date or iteration fields that your roadmap will use to position items. When you set a view to a roadmap layout, {% data variables.product.company_short %} will attempt to use existing date and iteration fields you have already set up. For more information on creating new fields, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields). - -1. In the top right of your roadmap, click **{% octicon "calendar" aria-hidden="true" aria-label="calendar" %} Date fields**. - - ![Screenshot showing the menu items for a roadmap layout. The "Date fields" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/roadmap-menu-dates.png) - -1. Optionally, to create a new date or iteration field, click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} New field**, type the name of your field, and click **Save**. You can then select the new field or create another. -1. Select a date or iteration field for "Start date" and "Target date." - -## Setting vertical markers - -You can configure vertical markers on a roadmap to show your iterations, the dates of items in your project, and the milestones associated with items in your project. - -1. In the top right of your roadmap, click **{% octicon "location" aria-hidden="true" aria-label="location" %} Markers**. - - ![Screenshot showing the menu bar in a roadmap layout. The "Markers" button is highlighted with an orange outline.](/assets/images/help/projects-v2/markers.png) - -1. In the menu, select which markers you want to display on your roadmap. - -## Setting the zoom level - -You can choose the density of items on your roadmap. You can zoom in to show one month at a time or, for a greater overview, you can zoom out to show a quarter of a year or a full year. - -1. In the top right of your roadmap, click {% octicon "search" aria-label="The zoom icon next to Month, Quarter, or Year" %}. - - ![Screenshot showing the menu items for a roadmap layout. The "Zoom" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/roadmap-zoom-button.png) - -1. Select either **Month**, **Quarter**, or **Year**. - -## Slicing by field values - -{% data reusables.projects.customize.slice-panel %} - -## Sorting by field values - -You can sort items by a field value. - -{% data reusables.projects.customize.sort %} - -## Grouping by field values - -You can group items by a custom field value. - -{% data reusables.projects.customize.group-fields %} - -## Showing the sum of a number field - -{% data reusables.projects.customize.sum %} diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md deleted file mode 100644 index 0ab1e0d82696..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Customizing the table layout -shortTitle: Customizing tables -intro: You can use the table layout to build a spreadsheet using your project's items, {% data variables.product.company_short %} metadata, and your custom fields. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: tutorials -category: - - Customize project views and insights ---- - -## About the table layout - -{% data reusables.projects.about-table-layout %} - -For more information about changing a view to use the table layout, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#changing-the-project-layout). - -## Showing and hiding fields - -You can show or hide a specific field. - -{% data reusables.projects.customize.show-hide-field %} - -You can also hide individual fields using the field headers. - -1. Next to the field you want to hide, click {% octicon "kebab-horizontal" aria-label="Status column options" %}. - ![Screenshot showing a field header. The menu icon is highlighted with an orange outline.](/assets/images/help/projects-v2/modify-field-menu.png) -1. Click **{% octicon "eye-closed" aria-hidden="true" aria-label="eye-closed" %} Hide field**. - -## Grouping by field values - -You can group items by a custom field value. {% data reusables.projects.customize.update-status %} - -{% data reusables.projects.customize.group-fields %} - -## Slicing by field values - -{% data reusables.projects.customize.slice-panel %} - -## Reordering fields - -You can change the order of fields. - -1. Click the field header. - - ![Screenshot showing three field headers. One of the headers is highlighted with an orange outline.](/assets/images/help/projects-v2/select-field-header.png) - -1. While continuing to click, drag the field to the required location. - -## Reordering rows - -You can change the order of rows. - -1. Click the number at the start of the row. - - ![Screenshot showing three rows on a table layout. One of the row numbers is highlighted with an orange outline.](/assets/images/help/projects-v2/select-row-number.png) - -1. While continuing to click, drag the row to the required location. - -## Sorting by field values - -You can sort items by a field value. - -{% data reusables.projects.customize.sort %} - -## Showing the sum of a number field - -{% data reusables.projects.customize.sum %} diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects.md deleted file mode 100644 index 1949a6b1510f..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -title: Filtering {% data variables.projects.projects_v2 %} -intro: Use filters to choose which items appear in your project's views. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/filtering-projects -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Customize project views and insights ---- - -You can customize which items appear in your views using filters for item metadata, such as assignees and the labels applied to issues, and by the fields in your project. You can combine filters and save them as views. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views). - -To filter a view, click {% octicon "filter" aria-label="Filter by keyword or by field" %} and start typing the fields and values you would like to filter for. As you type, possible values will appear. You can also open the project command palette, by pressing {% data variables.projects.command-palette-shortcut %}, and type "Filter by" to choose from the available filters. - -![Screenshot of "Mona's project". A field labeled "Filter by keyword or by field" is highlighted with an orange outline.](/assets/images/help/projects-v2/filter-example.png) - -In board layout, you can click on item data to filter for items with that value. For example, click on an assignee to show only items for that assignee. To remove the filter, click the item data again. - -Using multiple filters will act as a logical AND filter. For example, `label:bug status:"In progress"` will return items with the `bug` label and the "In progress" status. You can also provide multiple values for the same field to act as a logical OR filter. For example, `label:bug,support` will return items with either the `bug` or `support` labels. {% data variables.product.prodname_projects_v2 %} does not currently support logical OR filters across multiple fields. - -The same filters are available for charts you create using insights for {% data variables.product.prodname_projects_v2 %}, allowing you to filter the data used to create your charts. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects). - -When you filter a view and then add an item, the filtered metadata will be applied to new item. For example, if you're filtering by `status:"In progress"` and you add an item, the new item will have its status set to "In progress." - -You can use filters to produce views for very specific purposes. For example, you could use `assignee:@me status:todo last-updated:5days` to create a view of all work assigned to the current user, with the "todo" status, that hasn't been updated in the last five days. You could create a triage view by using a negative filter, such as `no:label no:assignee repo:octocat/game`, which would show items without a label and without an assignee that are located in the `octocat/game` repository. - -## Filtering for fields - -| Qualifier | Example -| ---------- | ------------- -| assignee:USERNAME | **assignee:octocat** will show items assigned to @octocat. -| label:LABEL | **label:bug** will show items with the "bug" label applied. -| field:VALUE | **status:done** will show items with the "status" field set to "done." -| reviewers:USERNAME | **reviewers:octocat** will show items that have been reviewed by @octocat. -| milestone:"MILESTONE" | **milestone:"QA release"** will show items assigned to the "QA release" milestone. - -## Combining filters - -You can create filters for multiple fields. Your view will show items that match all filters. - -| Qualifier | Example -| ---------- | ------------- -|assignee:USERNAME field:VALUE | **assignee:octocat priority:1** will show items assigned to @octocat that have a priority of **1**. - -You can also filter for multiple values from the same field. If you separate the values with commas, your view will show items that match any of the provided values. - -| Qualifier | Example -| ---------- | ------------- -|assignee:USERNAME,USERNAME | **assignee:octocat,stevecat** will show items assigned to either @octocat or @stevecat. - -To filter for multiple values from the same field but show items that match all of the provided values, you can repeat the qualifier for each value. - -| Qualifier | Example -| ---------- | ------------- -|assignee:USERNAME assignee:USERNAME | **assignee:octocat assignee:stevecat** will show items that are assigned to both @octocat and @stevecat. - -You can also combine filters that match some and match all items. - -| Qualifier | Example -| ---------- | ------------- -|field:VALUE,VALUE assignee:USER assignee:USER | **label:bug,onboarding assignee:octocat assignee:stevecat** will show items that have either the bug or onboarding labels but are assigned to both @octocat and @stevecat. - -## Negating a filter - -You can invert any filter, including combinations, by prefixing with a hyphen. - -| Qualifier | Example -| ---------- | ------------- -|-assignee:USERNAME | **-assignee:octocat** will not show any items assigned to @octocat. -|-field:VALUE | **-status:done** will not show any items with a status of "done." -|-field:VALUE,VALUE | **-priority:1,2** will not show any items with a priority of either 1 or 2. - -## Filtering for items that have a value - -You can use `has:` to filter for items that have a value - -| Qualifier | Example -| ---------- | ------------- -|has:assignee | **has:assignee** will show items with an assignee. -|has:label | **has:label** will show items with a label. -|has:FIELD | **has:priority** will show items with a priority field value. - -## Filtering for items that are missing a value - -You can use `no:` to filter for items that are missing a value - -| Qualifier | Example -| ---------- | ------------- -|no:assignee | **no:assignee** will show any unassigned items. -|no:reviewers | **no:reviewers** will show pull requests that do not have a reviewer. -|no:FIELD | **no:priority** will show items with an empty priority field. - -You can also prefix a hyphen to negate this behavior and only return items that have a value. - -| Qualifier | Example -| ---------- | ------------- -|-no:assignee | **-no:assignee** will only show items that are assigned. -|-no:FIELD | **-no:priority** will only show items that have a value in the priority field. - -## Filtering by item location - -Use the `repo` qualifier to filter for items in a particular repository. - -| Qualifier | Example -| ---------- | ------------- -|repo:OWNER/REPO | **repo:octocat/game** will items in the "octocat/game" repository. - -## Filtering for item state or item type - -You can use the `is` qualifier to filter for particular types of item or items in particular states. - -| Qualifier | Example -| ---------- | ------------- -|is:STATE | **is:open** will show open issues and pull requests. -| | **is:closed** will show closed issues and pull requests. -| | **is:merged** will show any merged pull requests. -|is:TYPE | **is:issue** will show only issues. -| | **is:pr** will show only pull requests. -| | **is:draft** will show draft issues and draft pull requests. -| | **is:issue is:open** will show open issues. - -## Filtering by close reason - -You can filter closed items by their close reason. - -| Qualifier | Example -| ---------- | ------------- -|reason:CLOSE REASON | **reason:completed** will show items closed because they were completed. -| | **reason:"not planned"** will show closed items with the "not planned" reason. -| | **reason:reopened** will show items that have been reopened after previously being closed. - -## Filtering for when an item was last updated - -The `updated` filter field provides a more powerful and flexible way to filter items based on their last modification date. - -| Qualifier | Example -| ---------- | ------------- -| updated:NUMBERdays | **updated:@today** will show items updated today. -| | **updated:@today-1d** will show items updated 1 day ago. -| | **updated:>@today-1w** will show items last updated seven or more days ago. -| | **updated:>@today-30d** will show items last updated thirty or more days ago. -| | **-updated:@today** excludes items updated today. - -{% data reusables.projects.last-updated-explanation %} - -## Filtering number, date, and iteration fields - -You can use `>`, `>=`, `<`, and `<=` to compare number, date, and iteration fields. Dates should be provided in the `YYYY-MM-DD` format. - -| Qualifier | Example -| ---------- | ------------- -| field:>VALUE | **priority:>1** will show items with a priority greater than 1. -| field:>=VALUE | **date:>=2022-06-01** will show items with a date of "2022-06-01" or later. -| field:<VALUE | **iteration:<"Iteration 5"** will show items with an iteration before "Iteration 5." -| field:<=VALUE | **points:<=10** will show items with 10 or less points. - -You can also use `..` to filter for an inclusive range. When working with a range, `*` can be supplied as a wildcard operator. - -| Qualifier | Example -| ---------- | ------------- -| field:VALUE..VALUE | **priority:1..3** will show items with a priority of 1, 2, or 3. -| | **date:2022-01-01..2022-12-31** will show items from the year 2022. -| | **points:\*..10** will show items with an points value of anything up to and including 10. -| | **iteration:"Iteration 1..Iteration 4"** will show items in "Iteration 1", "Iteration 2", "Iteration 3", and "Iteration 4." - -## Filtering assignees and reviewers using keywords - -You can use the `@me` keyword to represent yourself in a filter. - -| Qualifier | Example -| ---------- | ------------- -| field:@me | **assignee:@me** will show items assigned to the signed-in user. -| | **-reviewers:@me** will show items that have not been reviewed by the signed-in user. - -## Filtering iteration and date fields using keywords - -You can use the `@previous`, `@current`, and `@next` keywords to filter for iterations relative to the current iteration. You can also use `@today` to filter for the current day. - -| Qualifier | Example -| ---------- | ------------- -| field:@keyword | **iteration:@current** will show items assigned to the current iteration. -| | **iteration:@next** will show items assigned to the next iteration. -| field:@today | **date:@today** will show items with their date set to the current day. - -You can also use `>`, `>=`, `<`, `<=`, `+`, `-`, and `..` ranges with keywords. - -| Qualifier | Example -| ---------- | ------------- -| field:@keyword..@keyword+n | **iteration:@current..@current+3** will show items assigned to the current iteration and the next three iterations. -| | **date:@today..@today+7** will show items with a date set to today or the next seven days. -| field:<@keyword | **iteration:<@current** will show items assigned to any iteration before the current iteration. -| field:>=@keyword | **date:>=@today** will show items with a date set to today or later. - -## Filtering by text fields - -You can filter by specific text fields or use a general text filter across all text fields and titles. When filtering with text that contains spaces or special characters, enclose your text in `"` or `'` quotation marks. - -| Qualifier | Example -| ---------- | ------------- -| field:"TEXT" | **title:"Bug fix"** will show items with titles that exactly match "Bug fix". -| field:TEXT | **note:complete** will show items with a note text field that exactly match "complete". -| TEXT | **API** will show items with "API" in the title or any other text field. -| field:TEXT TEXT | **label:bug rendering** will show items with the "bug" label and with "rendering" in the title or any other text field. - -For general text search across all text fields and titles, matches are based only on the beginning of a word, not any part of it. -For example, if the issue title is **"Document full-text search"**: - -* **Matches**: "Doc", "full", "search" -* **Doesn't match**: "cument", "ext", "arch" - -This approach helps keep general text search more precise and relevant. - -{% ifversion projects-v2-wildcard-text-filtering %} - -You can also use a * as a wildcard. - -| Qualifier | Example -| ---------- | ------------- -| field:*TEXT* | **label:*bug*** will show items with a label that contains the word "bug." -| field:TEXT* | **title:API*** will show items with a title that begins with "API." -| field:*TEXT | **label:*support** will show items with a label that ends with "support." - -{% endif %} - -{% ifversion issue-types %} - -## Filtering by issue type - -If your organization uses issue types, you can filter for particular types. - -| Qualifier | Example -| ---------- | ------------- -| type:"ISSUE TYPE" | **type:"bug"** will show issues with the "bug" type. - -{% endif %} - -{% ifversion sub-issues %} - -## Filtering by parent issue - -You can filter your sub-issues by their parent issue. - -| Qualifier | Example -| ---------- | ------------- -| parent-issue:OWNER/REPO#ISSUE NUMBER | **parent-issue:octocat/game#4** will show issues with issue #4 in octocat/game as their parent issue. - -{% endif %} diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/index.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/index.md deleted file mode 100644 index 2bedef7f1580..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'Customizing views in your {% data variables.projects.project_v2 %}' -shortTitle: Customizing views -intro: 'You can create multiple views to look at your project from different angles, deciding which items to show and how to present them.' -versions: - feature: projects-v2 -children: - - /changing-the-layout-of-a-view - - /customizing-the-table-layout - - /customizing-the-board-layout - - /customizing-the-roadmap-layout - - /filtering-projects - - /managing-your-views -allowTitleToDifferFromFilename: true ---- - diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md deleted file mode 100644 index 68ab30d01834..000000000000 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/managing-your-views.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Managing your views -intro: Learn how to create, save, and manage your project views. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: tutorials -category: - - Customize project views and insights ---- - - -## Creating a project view - -Project views allow you to quickly view specific aspects of your project. Each view is displayed on a separate tab in your project. - -For example, you can have: -* A view that shows all items not yet started (filter on "Status"). -* A view that shows the workload for each team (group by a custom "Team" field). -* A view that shows the items with the earliest target ship date (sort by a date field). - -To add a new view: - -{% data reusables.projects.new-view %} - -The new view is automatically saved. - -## Duplicating a view - -You can duplicate an existing view and use it as a base to make further changes. - -1. Switch to the view you want to duplicate. -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "versions" aria-hidden="true" aria-label="versions" %} Duplicate view**. - -## Saving changes to a view - -When you make changes to a view - for example, sorting, reordering, filtering, or grouping the data in a view - a dot is displayed next to the view name to indicate that there are unsaved changes. - -![Screenshot of a tab for a view labeled "Issues by priority." Next to the view's name, a dropdown icon is marked by a blue dot.](/assets/images/help/projects/unsaved-changes.png) - -If you don't want to save the changes, you can ignore this indicator. No one else will see your changes. - -{% data reusables.projects.save-view %} - -## Reordering saved views - -To change the order of the tabs that contain your saved views, click and drag a tab to a new location. The new tab order is automatically saved. - -## Renaming a saved view - -You can rename your saved views. The name change is automatically saved. - -1. Switch to the view you want to rename. -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Rename view**. -1. Type the new name for your view. -1. To save your changes, press Return. - -## Deleting a saved view - -1. Switch to the view you want to delete. -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete view**. diff --git a/content/issues/planning-and-tracking-with-projects/finding-your-projects.md b/content/issues/planning-and-tracking-with-projects/finding-your-projects.md deleted file mode 100644 index 15bdb6325084..000000000000 --- a/content/issues/planning-and-tracking-with-projects/finding-your-projects.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Finding your {% data variables.projects.projects_v2 %} -intro: Learn how to locate projects in your account, organizations, repositories, and teams. -redirect_from: - - /issues/planning-and-tracking-with-projects/learning-about-projects/finding-your-projects -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: concepts -category: - - Set up and manage projects ---- - -## Browsing all of your projects - -You can browse all of your projects, regardless of where they are located. You can see the projects you have recently viewed and the projects you have created, and apply your own filters. - -1. In the top left of any page, click {% octicon "three-bars" aria-label="Open global navigation menu" %} to open the global navigation menu. -1. In the menu, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -{% data reusables.projects.index-select %} - -## Finding an organization's projects - -You can view and filter all the projects owned by an organization that you have access to. - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -1. Under the organization name, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -{% data reusables.projects.index-select %} - -## Finding projects owned by your personal account - -You can view and filter projects that you have created under your personal account. - -{% data reusables.profile.access_profile %} -1. On your profile, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -{% data reusables.projects.index-select %} - -## Finding projects linked to a repository - -Repositories can be linked to organization-level and user-level projects. You can browse and filter the projects that are linked to a specific repository. For more information on linking projects to a repository, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository). - -1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your repository. -1. Click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. - - ![Screenshot showing a repository's tabs. The "Projects" tab is highlighted with an orange outline.](/assets/images/help/projects-v2/repo-tab.png) - -{% data reusables.projects.index-select %} - -## Finding projects linked to a team - -You can also link a project to specific teams in an organization and then browse and filter the projects that are associated with a particular team. For more information on linking projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team). - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.organizations.specific_team %} -1. Click **{% octicon "project" aria-hidden="true" aria-label="project" %} Projects**. - - ![Screenshot of the main page for a team. In the horizontal navigation bar, the "Projects" tab is outlined in dark orange.](/assets/images/help/organizations/team-project-board-button.png) - -{% data reusables.projects.index-select %} - -## Syntax for filtering a list of projects - -You can combine filters and even search project titles by including text. For example, `is:open creator:octocat game` will return open projects, created by the @octocat user, with the word "game" in the project title. You can use the search qualifiers in the following table to narrow down your search for a project. - -| Qualifier | Explanation -| ---------- | ------------- -| `is:open` | Returns projects that are currently open. | -| `is:closed` | Returns projects that are currently closed. | -| `is:template` | Returns projects that are marked as a template. | -| `is:private` | Returns projects are set to private visibility. | -| `is:public` | Returns projects are set to public visibility. | -| `creator:USERNAME` | Returns projects created by USERNAME. For example, `creator:octocat` will return projects created by @octocat. | - -You can also change how the projects are ordered. - -| Qualifier | Explanation -| ---------- | ------------- -| `sort:title-asc` | Sort by project title. | -| `sort:updated-asc` or `sort:updated-desc` | Sort by when the project was last updated. | -| `sort:created-asc` or `sort:created-desc` | Sort by when the project was created. | diff --git a/content/issues/planning-and-tracking-with-projects/index.md b/content/issues/planning-and-tracking-with-projects/index.md deleted file mode 100644 index cdfa40a7ac72..000000000000 --- a/content/issues/planning-and-tracking-with-projects/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: 'Planning and tracking with {% data variables.product.prodname_projects_v2 %}' -shortTitle: '{% data variables.product.prodname_projects_v2 %}' -intro: 'Build adaptable projects to track your work on {% data variables.product.company_short %}.' -versions: - feature: projects-v2 -children: - - /learning-about-projects - - /creating-projects - - /managing-items-in-your-project - - /understanding-fields - - /customizing-views-in-your-project - - /automating-your-project - - /viewing-insights-from-your-project - - /managing-your-project - - /finding-your-projects - - /sharing-project-updates -allowTitleToDifferFromFilename: true -redirect_from: - - /issues/trying-out-the-new-projects-experience ---- - -A project is an adaptable collection of items that you can view as a table, a kanban board, or a roadmap and that stays up-to-date with {% data variables.product.company_short %} data. Your projects can track issues, pull requests, and ideas that you note down. - -You can create and customize multiple views by filtering, sorting, and grouping issues and pull requests, visualize work with configurable charts, and add custom fields to track metadata specific to your team. Rather than enforcing a specific methodology, a project provides flexible features you can customize to your team’s needs and processes. diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects.md deleted file mode 100644 index f180b72a5084..000000000000 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: About {% data variables.product.prodname_projects_v2 %} -intro: '{% data variables.product.prodname_projects_v2 %} is an adaptable, flexible tool for planning and tracking work on {% data variables.product.company_short %}.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/about-projects -contentType: concepts -category: - - Set up and manage projects ---- - -## About {% data variables.product.prodname_projects_v2 %} - -A project is an adaptable table, board, and roadmap that integrates with your issues and pull requests on {% data variables.product.company_short %} to help you plan and track your work effectively at the user or organization level. You can create and customize multiple views by filtering, sorting, slicing, and grouping your issues and pull requests to manage your team backlogs and roadmaps, visualize work with configurable charts, add custom fields to track metadata specific to your team, create templates, share status updates, and automate your projects. Rather than enforcing a specific methodology, a project provides flexible features you can customize to your team’s needs and processes. - -To get started and create a project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project). To learn more about the different layouts, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view). - -### Staying up-to-date - -Your projects are built from the issues and pull requests you add, creating direct references between your project and your work. Information is synced automatically to your project as you make changes, updating your views and charts. This integration works both ways, so that when you change information about a pull request or issue in your project, the pull request or issue reflects that information. For example, change an assignee in your project and that change is shown in your issue. You can take this integration even further, group your project by assignee, and make changes to issue assignment by dragging issues into the different groups. - -To learn more about managing items in your project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project). - -### Viewing your project from different perspectives - -Quickly answer your most pressing questions by tailoring your project view to give you the information you need. You can save these views, allowing you to quickly return to them as needed and make them available to your team. Views not only let you scope down the items listed but also offer three different layout options. - -You can view your project as a high-density table layout, as a kanban board, or a timeline-style roadmap. These customized views help you manage your team backlog, perform iteration planning, plan your roadmap, plan for a feature release, or triage bugs, right next to the code. For more information about the different layout options, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view). - -### Adding metadata to your items - -You can use custom fields to add metadata to your issues, pull requests, and draft issues and build a richer view of item attributes. You’re not limited to the built-in metadata (assignee, milestone, labels, etc.) that currently exists for issues and pull requests. For example, you can add the following metadata as custom fields: - -* A date field to track target ship dates. -* A number field to track the complexity of a task. -* A single select field to track whether a task is Low, Medium, or High priority. -* A text field to add a quick note. -* An iteration field to plan work week-by-week, including support for breaks. - -You can use up to 50 fields in a project, including built-in metadata and custom fields. To learn more about the different fields you can add to a project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project). - -### Automating your projects - -There are a number of ways you can add automation to your project. Built-in workflows allow you to automatically set fields when items are added or changed, and you can also configure your project to automatically archive items when they meet certain criteria and automatically add items from a repository when they match set criteria. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations). - -You can also use the GraphQL API and {% data variables.product.prodname_actions %} to take even greater control of your project. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions). - -### Viewing charts and insights - -You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts. When you create a chart, you set the filters, chart type, the information displayed, and the chart is available to anyone that can view the project. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects). - -### Creating project templates - -You can create project templates for your organization, or set a project as a template, to share a pre-configured project with other people in your organization which they can then use as the base for their projects. Project templates include the views, custom fields, draft issues and associated fields, configured workflows (except any auto-add workflows), and insights. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization). - -### Sharing status updates - -You can keep your team up to date and share high-level overviews, which people can use to determine the status of your project. You can set a status, such as "On track" or "At risk", to allow people to quickly determine the current state of the project. You can also set start dates and target dates. Your status update can also contain a message that supports formatting with Markdown. Status updates are found on your project's side panel, below the description and README, and in the project's header and in lists when you're browsing projects. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates). - -## Next steps - -Here are some helpful resources for taking your next steps with {% data variables.product.prodname_projects_v2 %}: - -* To learn about getting started using projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects). -* To learn tips for managing your projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects). diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md deleted file mode 100644 index 56e03b109870..000000000000 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Best practices for {% data variables.product.prodname_projects_v2 %} -intro: Learn tips for managing your projects. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/best-practices-for-managing-projects -contentType: concepts -category: - - Set up and manage projects ---- - -You can use {% data variables.product.prodname_projects_v2 %} to manage your work on {% data variables.product.company_short %}, where your issues and pull requests live. Read on for tips to manage your projects efficiently and effectively. For more information about {% data variables.product.prodname_projects_v2 %}, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). - -## Communicate across your issues and pull requests - -Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected. - -## Break down large issues into smaller issues - -Breaking a large issue into smaller issues makes the work more manageable and enables team members to work in parallel. It also leads to smaller pull requests, which are easier to review. - -{% ifversion sub-issues %} - -{% data reusables.issues.about-sub-issues %} See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues). - -{% ifversion issue-types %} - -You can also use issue types to classify work in repositories across the organization alongside sub-issues. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization). - -{% endif %} - -{% endif %} - -To ensure efficient progress, clearly define which issues are blocked by, or blocking, other issues. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies). - -To track how smaller issues fit into the larger goal, use milestones or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels). - -## Make use of the description, README, and status updates to share information about a project - -Use your project's description and README to share information about the project. - -For example: - -* Explaining the purpose of the project. -* Describing the project views and how to use them. -* Including relevant links and people to contact for more information. - -Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project). - -You can also share high-level updates with other users of your project by posting status updates. Status updates allow you to mark the project with a status, such as "On track" or "At risk", set start and target dates, and share written updates with your team. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/sharing-project-updates). - -## Create customized views of your project items - -Use project views to look at your project from different angles using the table, board, and roadmap layout. Views allow you to manage your team backlog, weekly iterations, team roadmaps, and plans for a feature release, just to name a few. - -For example, you can customize views by: - -* Filtering by status to view all un-started items -* Grouping by a custom priority field to monitor the volume of high priority items -* Sorting by a custom date field to view the items with the earliest target ship date -* Slicing by assignee to view team capacity -* Showing a field sum for an estimate to highlight complexity for a group of items -* Adding a column limit to a board column to maintain focus - -Here is an example table layout: - -![Screenshot showing an example table layout.](/assets/images/help/projects-v2/example-table.png) - -Here is an example board layout: - -![Screenshot showing an example board layout.](/assets/images/help/projects-v2/example-board.png) - -Here is an example roadmap layout: - -![Screenshot showing an example roadmap layout.](/assets/images/help/projects-v2/example-roadmap.png) - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project). - -## Use different field types to add metadata to your project items - -Take advantage of the various field types to meet your needs and add metadata to your issues, pull requests, and draft issues for richer views. You’re not limited to the built-in metadata (assignee, milestone, labels, etc.) that currently exists for issues and pull requests. For example, you can add the following metadata as custom fields: - -* A date field to track target ship dates -* A number field to track the complexity of a task -* A single select field to track whether a task is Low, Medium, or High priority -* A text field to add a quick note -* An iteration field to plan work week-by-week, including support for breaks - -Use an iteration field to schedule work or create a timeline. You can group by iteration to see if items are balanced between iterations, or you can filter to focus on a single iteration. Iteration fields let you view work that you completed in past iterations, which can help with velocity planning and reflecting on your team's accomplishments. Iteration fields also support breaks to show when you and your team are taking time away from their iterations. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields). - -Use a single select field to track information about a task based on a preset list of values. For example, track priority or project phase. Since the values are selected from a preset list, you can easily group or filter to focus on items with a specific value. - -For more information about the different field types, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields). - -## Use automation to keep your projects up to date automatically - -You can automate tasks to spend less time on busy work and more time on the project itself. The less you need to remember to do manually, the more likely your project will stay up to date. - -{% data variables.product.prodname_projects_v2 %} offers built-in workflows. For example, when an issue is closed, you can automatically set the status to "Done". You can also configure built-in workflows to automatically archive items when they meet certain criteria and to automatically add items from a repository when they match a filter. - -Additionally, {% data variables.product.prodname_actions %} and the GraphQL API enable you to automate routine project management tasks. For example, to keep track of pull requests awaiting review, you can create a workflow that adds a pull request to a project and sets the status to "needs review"; this process can be automatically triggered when a pull request is marked as "ready for review." - -* For more information about the built-in workflows, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations). -* For more information about automatically archiving items, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically). -* For more information about automatically adding items, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically). -* For an example workflow, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions). -* For more information about the API, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects). -* For more information about {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions). - -## Create charts and insights to visualize and share progress - -You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts. When you create a chart, you set the filters, chart type, the information displayed, and the chart is available to anyone that can view the project. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects). - -## Create project templates to standardize your workflows - -You can create project templates for your organization, or set a project as a template, to share a pre-configured project with other people in your organization which they can then use as the base for their projects. Project templates include the views, custom fields, draft issues and associated fields, configured workflows (except any auto-add workflows), and insights. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization). - -## Link projects to teams and repositories - -You can add projects to your team to give the whole team collaborator access to their projects. When you add a project to a team, that project is listed on the team's projects page, making it easier for members to identify which projects a particular team uses. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team). - -You can also add projects to a repository that is owned by the same user or organization that owns the project. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository). - -## Have a single source of truth - -To prevent information from getting out of sync, maintain a single source of truth. For example, track a target ship date in a single location instead of spread across multiple fields. Then, if the target ship date shifts, you only need to update the date in one location. - -{% data variables.product.prodname_projects_v2 %} automatically stay up to date with {% data variables.product.company_short %} data, such as assignees, milestones, and labels. When one of these fields changes in an issue or pull request, the change is automatically reflected in your project. - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects) diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md deleted file mode 100644 index d8ec1d3ba8fc..000000000000 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: 'Learning about {% data variables.product.prodname_projects_v2 %}' -intro: 'Learn about {% data variables.product.prodname_projects_v2 %} and how to make the very best of this powerful tool.' -versions: - feature: projects-v2 -children: - - /about-projects - - /quickstart-for-projects - - /best-practices-for-projects -allowTitleToDifferFromFilename: true ---- diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md deleted file mode 100644 index be81025ecc1b..000000000000 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -title: Quickstart for {% data variables.product.prodname_projects_v2 %} -intro: Experience the speed, flexibility, and customization of {% data variables.product.prodname_projects_v2 %} by creating a project in this interactive guide. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/quickstart -contentType: get-started -category: - - Set up and manage projects ---- - -## Introduction - -This guide demonstrates how to use {% data variables.product.prodname_projects_v2 %} to plan and track work. In this guide, you will create a new project, customize views, and add custom fields to manage a team backlog, iteration planning, and a team roadmap to communicate priorities and progress with your collaborators. You'll also set up built-in workflows to automatically manage the items in your project and charts to visualize items in your project. - -## Prerequisites - -You can either create an organization project or a user project. To create an organization project, you need a {% data variables.product.prodname_dotcom %} organization. For more information about creating an organization, see [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch). - -In this guide, you will add issues from repositories owned by your organization (for organization projects) or by you (for user projects) to your new project. For more information about creating issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue). - -## Creating a project - -First, create an organization project or a user project. - -### Creating an organization project - -{% data reusables.projects.create-project %} - -### Creating a user project - -{% data reusables.projects.create-user-project %} - -## Setting your project description and README - -{% data reusables.projects.project-description %} - -## Adding items to your project - -Next, add a few items to your project. - -{% data reusables.projects.add-item-via-paste %} - -Repeat the above steps a few times to add multiple items to your project. - -For more information and other ways to add issues to your project, or about other items you can add to your project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project). - -## Adding draft issues to your project - -Next, add a draft issue to your project. - -{% data reusables.projects.add-draft-issue %} - -## Adding fields - -Next, create custom fields to manage the iteration, priority, and estimates for your project items. - -### Creating an iteration field - -Create an iteration field so you can plan and track your work over repeating blocks of time. Iterations can be configured to suit how you and your team works, with customizable lengths and the ability to insert breaks. - -{% data reusables.projects.new-field %} -1. Select **Iteration** -1. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. -1. Click **Save**. - -Specify an iteration for all items in your project. - -### Creating a priority field - -Now, create a custom field named `Priority` and containing the values: `High`, `Medium`, or `Low`. - -{% data reusables.projects.new-field %} -1. Select **Single select** -1. Below "Options," type the first option, "High." -1. To add additional fields, for "Medium" and "Low," click **Add option**. -1. Click **Save**. - -Specify a priority for all items in your project. - -![Screenshot showing a list of issues, each with a priority of "Low," "Medium," or "High" in the "Priority" field.](/assets/images/help/projects/priority-example.png) - -### Creating an estimate field - -Create a custom field named `Estimate` to track the complexity for each item. - -{% data reusables.projects.new-field %} -1. Select **Number** -1. Click **Save**. - -Specify an estimate for all items in your project. - -## Creating views - -Create views to visualize your items in a table, board, and roadmap. - -For more information on customizing views, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project). - -### Creating a team backlog - -You can use a table layout to visualize your team backlog as a spreadsheet, allowing you to view many fields and make edits. - -Select visible fields for your view to communicate the priority and progress of your team backlog. - -1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - - ![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png) - -1. Under "Hidden fields," click {% ifversion issue-types %}**Type**, {% endif %}**Status**, {% ifversion sub-issues %}**Sub-issues progress**, {% endif %}**Assignees**, **Linked pull requests**, **Priority**, and **Estimate**. - -Next, group all of the items in your project by priority to make it easier to focus on the high priority items. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "rows" aria-hidden="true" aria-label="rows" %} Group**. -1. Click **Priority**. - -Now, move items between groups to change their priority. - -1. Choose an item. -1. Drag and drop the item into a different priority group. When you do this, the priority of the item will change to be the priority of its new group. - -You can also show the sum of the `Estimate` field for each priority group. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "number" aria-hidden="true" aria-label="number" %} Field sum**. -1. Select **Estimate**. - -When you grouped your items by priority and added a field sum in the previous steps, your project displayed an indicator to show that the view was modified. Save these changes so that your collaborators will also see the tasks grouped by priority. - -{% data reusables.projects.save-view %} - -You can share the URL with your team to keep everyone aligned on the project priorities. When a view is saved, anyone who opens the project will see the saved view. Here, you grouped by priority, but you can also add other modifiers such as sort, filter, or layout. - -Finally, to indicate the purpose of the view, give it a descriptive name. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Rename view**. -1. Type the new name for your view. -1. To save changes, press Return. - -Next, you will create new views with different layouts. - -For more information on customizing tables, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout). - -### Creating a weekly iteration board view - -To view the progress of your project's items in a kanban board, you can use the board layout. The board layout is based on the status field by default, so specify a status for each item in your project. - -First, create a new view. - -{% data reusables.projects.new-view %} - -Next, switch to the board layout. - -{% data reusables.projects.open-view-menu %} -1. Under "Layout," click **Board**. - -To indicate the purpose of the view, give it a descriptive name. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Rename view**. -1. Type the new name for your view. -1. To save changes, press Return. - -Add a filter for `iteration:@current` to only includes items from the current iteration. - -You can also show the sum of the `Estimate` field for each status column. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "number" aria-hidden="true" aria-label="number" %} Field sum**. -1. Select **Estimate**. - -When you added a filter and added a field sum in the previous steps, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future. - -{% data reusables.projects.save-view %} - -For more information on customizing boards, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout). - -### Creating a team roadmap - -To view your project items on a timeline, you can use the roadmap layout. Roadmaps use custom date and iteration fields to position your issues, pull requests, and draft items on a timeline, allowing you to track work over time and watch progress. - -First, create a new view. - -{% data reusables.projects.new-view %} - -Next, switch to the roadmap layout. - -{% data reusables.projects.open-view-menu %} -1. Under "Layout," click **Roadmap**. - -You can add vertical markers on a roadmap to show the milestones associated with items in your project. - -1. In the top right of your roadmap, click **{% octicon "location" aria-hidden="true" aria-label="location" %} Markers**. - - ![Screenshot showing the menu bar in a roadmap layout. The "Markers" button is highlighted with an orange outline.](/assets/images/help/projects-v2/markers.png) - -1. In the menu, select which markers you want to display on your roadmap. - -When you added markers, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future. - -{% data reusables.projects.save-view %} - -To indicate the purpose of the view, give it a descriptive name. - -{% data reusables.projects.open-view-menu %} -1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Rename view**. -1. Type the new name for your view. -1. To save changes, press Return. - -For more information on customizing roadmaps, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout). - -## Configuring built-in automation - -Next, configure the auto-add workflow to automatically add issues opened in a repository with a specific label to your project. - -{% data reusables.projects.access-workflows %} -1. In the "Default workflows" list, click **Auto-add to project**. -1. To start editing the workflow, in the top right, click **Edit**. - - ![Screenshot showing the workflow menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) - -1. Under "Filters," select the repository you want to add items from. -1. Next to the repository selection, type the filter criteria you want items to match before they are automatically added to your project. For example, to catch all issues and pull requests opened with the label "question," use `is:issue,pr label:question`. -1. To enable the new workflow, click **Save and turn on workflow**. - -Finally, add a built in workflow to set the status to **Todo** when an item is added to your project. - -1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu. - ![Screenshot showing a project's menu bar. The menu icon is highlighted with an orange outline.](/assets/images/help/projects-v2/open-menu.png) -1. In the menu, click **{% octicon "workflow" aria-hidden="true" aria-label="workflow" %} Workflows**. -1. Under **Default workflows**, click **Item added to project**. -1. Next to **When**, ensure that both `issues` and `pull requests` are selected. -1. Next to **Set**, select **Status:Todo**. -1. Click the **Disabled** toggle to enable the workflow. - -For more information on automating your project and other default workflows you can configure to keep your project items up to date, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project). - -## Viewing charts and insights - -You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts by choosing the grouping, layout, X-axis, and Y-axis configuration. - -{% data reusables.projects.access-insights %} -1. In the menu on the left, click **New chart**. -1. Optionally, to change the name of the new chart, click {% octicon "triangle-down" aria-label="The triangle icon" %}, type a new name, and press Return. -1. Above the chart, type filters to change the data used to build the chart. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). -1. To the right of the filter text box, click **Save changes**. - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects). - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project) -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields) diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md deleted file mode 100644 index efc556205ae5..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: Adding items to your {% data variables.projects.project_v2 %} -shortTitle: Adding items -intro: Learn how to add pull requests, issues, and draft issues to your projects individually or in bulk. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Manage project items and fields ---- - -> [!NOTE] -> A project can contain a maximum of{% ifversion projects-single-limit %} {% data variables.projects.item_limit %} items across both active views and the archive page{% else %} {% data variables.projects.legacy_item_limit %} items and {% data variables.projects.legacy_archived_item_limit %} archived items{% endif %}. To learn more about automatically archiving items when they meet specific criteria, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically). - -## Adding issues and pull requests to a project - -You have several options for adding issues and pull requests to your project. You can add them individually, automatically, or in bulk. Furthermore, you can include issues and pull requests from any organization, and you also have the ability to add draft issues that can be converted into regular issues later on. For more information, see [Creating draft issues](#creating-draft-issues). - -{% ifversion projects-v2-timeline-events %} - -When you add an issue or pull request to your project, an event will be added to the issue or pull request's timeline. Timeline events will also be added when you remove issues or pull requests and when changes are made to its `status` field for those items. Timeline events are only visible to people who have at least read permission for the project. If a change is made by a built-in workflow, the activity will be attributed to **@github-project-automation**. - -{% endif %} - -For more information about making bulk changes to your items after adding them, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project). - -### Automatically adding issues and pull requests - -You can configure a built-in workflow to automatically add issues and pull requests from a repository when they meet specific filter criteria. For more information about configuring a workflow, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically). - -### Pasting the URL of an issue or pull request - -You can copy the URL of an issue or pull request into your clipboard and paste that into your project. - -{% data reusables.projects.add-item-via-paste %} - -### Searching for an issue or pull request - -If you know the issue or pull request number or if you know part of the title, you can search for an issue or pull request directly from your project. - -{% data reusables.projects.add-item-bottom-row %} -1. To open the list of repositories, type #. -1. Select the repository where the pull request or issue is located. You can type part of the repository name to narrow down your options. -1. Select the issue or pull request. You can type part of the title to narrow down your options. - -### Bulk adding issues and pull requests - -You can add multiple issues and pull requests from your project and use filters, such as `label:bug`, to narrow down your search. - -1. In the bottom row of the project, click {% octicon "plus" aria-hidden="true" aria-label="plus" %}. - ![Screenshot showing the bottom row of a table view. The "+" button is highlighted with an orange outline.](/assets/images/help/projects-v2/omnibar-add.png) -1. Click **Add item from repository**. -{% data reusables.projects.bulk-add %} - -### Adding multiple issues or pull requests from a repository - -You can also add issues and pull requests to your project from a repository's issue and pull request lists. - -1. On {% data variables.product.prodname_dotcom %}, navigate to the repository that contains the issues or pull requests you want to add to your project. -{% data reusables.repositories.sidebar-issue-pr %} -1. Select the issues or pull requests you want to add to your project. - - * To select individual issues or pull requests, to the left of the title of each issue or pull request you want to add to your project, select the checkbox. - - ![Screenshot of the first two issues in the list of issues for a repository. To the left of each issue, a checkbox is outlined in dark orange.](/assets/images/help/issues/select-issue-checkbox.png) - * To select every issue or pull request on the page, at the top of the list of issues or pull requests, select all. - - ![Screenshot of the list of issues for a repository. In the header above the list, a checkbox to select all issues is outlined in dark orange.](/assets/images/help/issues/select-all-checkbox.png) -1. Above the list of issues or pull requests, click **Projects**. -1. Click the projects you want to add the selected issues or pull requests to. - -### Assigning a project from within an issue or pull request - -You can also add an issue or pull request to your project from within the issue or pull request itself. - -1. Navigate to the issue or pull request that you want to add to a project. -1. In the side bar, click **Projects**. - ![Screenshot showing an issue's sidebar. "Projects" is highlighted with an orange outline.](/assets/images/help/projects-v2/issue-sidebar-projects.png) -1. Select the project that you want to add the issue or pull request to. -1. Optionally, populate the custom fields. - -### Using the command palette to add an issue or pull request - -You can use the command palette when viewing your project to quickly add items. - -1. {% data reusables.projects.open-command-palette %} -1. Start typing "Add items" and press Return. -{% data reusables.projects.bulk-add %} - -## Creating issues - -{% data reusables.projects.about-issue-modal %} - -{% data reusables.projects.create-issue-modal %} - -## Creating draft issues - -Draft issues are useful to quickly capture ideas. Unlike issues and pull requests that are referenced from your repositories, draft issues exist only in your project. - -{% data reusables.projects.add-draft-issue %} - -Draft issues can have a title, text body, assignees, and any custom fields from your project. In order to populate the repository, labels, or milestones for a draft issue, you must first convert the draft issue to an issue. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues). - -> [!NOTE] -> Users will not receive notifications when they are assigned to or mentioned in a draft issue unless the draft issue is converted to an issue. diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project.md deleted file mode 100644 index 871649bbfcbe..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Archiving items from your {% data variables.projects.project_v2 %} -shortTitle: Archiving items -intro: You can archive items, keeping them available to restore, or permanently delete them. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Manage project items and fields ---- - -> [!NOTE] -> A project can contain a maximum of{% ifversion projects-single-limit %} {% data variables.projects.item_limit %} items across both active views and the archive page{% else %} {% data variables.projects.legacy_item_limit %} items and {% data variables.projects.legacy_archived_item_limit %} archived items{% endif %}. - -## Archiving items - -You can archive an item to keep the context about the item in the project but remove it from the project views. You can also configure your project's built-in workflows to automatically archive items that meet certain criteria. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/archiving-items-automatically). - -{% data reusables.projects.select-an-item %} -{% data reusables.projects.open-item-menu %} -1. Click **Archive**. -1. When prompted, confirm your choice by clicking **Archive**. - -## Restoring archived items - -1. Navigate to your project. -1. In the top-right, click {% octicon "kebab-horizontal" aria-label="More options" %}. - - ![Screenshot showing a project's menu bar. The menu icon is highlighted with an orange outline.](/assets/images/help/projects-v2/open-menu.png) - -1. In the menu, click **{% octicon "archive" aria-hidden="true" aria-label="archive" %} Archived items**. -1. Optionally, to filter the archived items displayed, type your filter into the text box above the list of items. For more information about the available filters, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). -1. To the left of each item title, select the items you would like to restore. - - ![Screenshot of a list of archived items. To the left of the first item, a checkbox is outlined in dark orange.](/assets/images/help/issues/select-archived-item.png) -1. To restore the selected items, above the list of items, click **Restore**. - -## Deleting items - -You can delete an item to remove it from the project entirely. - -{% data reusables.projects.select-an-item %} -{% data reusables.projects.open-item-menu %} -1. Click **Delete from project**. -1. When prompted, confirm your choice by clicking **Delete**. diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md deleted file mode 100644 index bd8601a8e079..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Converting draft issues to issues -shortTitle: Converting draft issues -intro: Learn how to convert draft issues into issues. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: tutorials -category: - - Manage project items and fields ---- - -## Converting draft issues in table layout - -1. Click the {% octicon "triangle-down" aria-label="Row actions" %} on the draft issue that you want to convert. - - ![Screenshot of items in the table layout. The item context button is highlighted with an orange outline.](/assets/images/help/projects-v2/item-context-menu-button-table.png) - -1. Select **Convert to issue**. -1. Select the repository that you want to add the issue to. - -## Converting draft issues in board layout - -1. Click the {% octicon "kebab-horizontal" aria-label="the item menu" %} on the draft issue that you want to convert. - - ![Screenshot showing a draft issue. The item menu is highlighted with an orange outline.](/assets/images/help/projects-v2/item-context-menu-button-board.png) - -1. Select **Convert to issue**. -1. Select the repository that you want to add the issue to. - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project#creating-draft-issues) diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md deleted file mode 100644 index e536f378728a..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Editing items in your {% data variables.projects.project_v2 %} -shortTitle: Editing items -intro: There are several methods you can use within your {% data variables.projects.project_v2 %} to quickly make changes to multiple items. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Manage project items and fields ---- - -## Copying and pasting cells in a table - -You can copy the contents of one cell and paste the contents into multiple other cells in the same field. - -1. Navigate to a project view that is using the table layout. -1. Select the cell that you would like to copy. - - ![Screenshot showing two columns on a table layout. One cell is selected and is highlighted with an orange outline.](/assets/images/help/projects-v2/bulk-select-a-cell.png) - -1. To copy the contents of the selected cell, press Command+C (Mac) or Ctrl+C (Windows.) -1. Select the destination cells for the copied content. - -{% indented_data_reference reusables.projects.select-a-cell spaces=4 %} - - ![Screenshot showing two columns on a table layout. Three cells are selected and are highlighted with an orange outline.](/assets/images/help/projects-v2/bulk-select-cells.png) - -1. To paste the previously copied content, press Command+V (Mac) or Ctrl+V (Windows.) - -## Dragging a cell's contents to set neighboring table cells - -You can quickly copy one cell's content over other cells in the same field by dragging up or down. - -1. Navigate to a project view that is using the table layout. -1. Select the cell that you would like to copy. -1. If it's possible to copy the cell's content, a blue handle will be shown on the lower right of the selected cell. - - ![Screenshot showing two columns on a table layout. The blue handle, on the lower right of the selected cell, is highlighted with an orange outline.](/assets/images/help/projects-v2/bulk-cell-handle.png) - -1. Drag the handle up or down over the cells where you would like to copy the contents. - - ![Screenshot showing two columns on a table layout. Three cells are selected. The blue handle, on the lower right of the cell, is outlined in orange.](/assets/images/help/projects-v2/bulk-cell-drag.png) - -1. When you finish dragging, the contents of the originally selected cell will be copied over the cells you selected while dragging. - - ![Screenshot showing two columns on a table layout. The content of the previously selected cell has been copied to the cells selected above.](/assets/images/help/projects-v2/bulk-cell-finished.png) - -## Clearing the content of multiple table cells - -You can quickly clear the same field for multiple items. - -1. Navigate to a project view using the table layout. -1. Select the cells you would like to clear. - -{% indented_data_reference reusables.projects.select-a-cell spaces=4 %} - - ![Screenshot showing a column on a table layout. Three cells are selected.](/assets/images/help/projects-v2/select-multiple-cells.png) - -1. Press Delete or Backspace on your keyboard. - -## Undoing bulk changes in a table - -When you make a bulk change in the table layout, {% data variables.product.github %} will display the option to undo that change. - -1. Make a bulk change to your table. -1. When the notice appears in the lower right of your table, click **Undo**. - - ![Screenshot showing the undo dialog on a table. The Undo button is highlighted with an orange outline.](/assets/images/help/projects-v2/undo-bulk-change.png) diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/index.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/index.md deleted file mode 100644 index 41679b8ed7c1..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'Managing items in your {% data variables.projects.project_v2 %}' -shortTitle: 'Managing items in your {% data variables.projects.project_v2 %}' -intro: 'Learn how to add and manage issues, pull requests, and draft issues.' -versions: - feature: projects-v2 -children: - - /adding-items-to-your-project - - /converting-draft-issues-to-issues - - /editing-items-in-your-project - - /archiving-items-from-your-project -allowTitleToDifferFromFilename: true ---- diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository.md deleted file mode 100644 index 9ed9bc72020c..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Adding your {% data variables.projects.project_v2 %} to a repository -shortTitle: Adding a {% data variables.projects.project_v2 %} to a repo -intro: You can add your {% data variables.projects.project_v2 %} to a repository to make it accessible from that repository. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - -## Linking a repository to your project - -You can list relevant projects in a repository. You can only list projects that are owned by the same user or organization that owns the repository. - -In order for repository members to see a project listed in a repository, they must have visibility for the project. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects). - -1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your repository. -1. Click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. - ![Screenshot showing a repository's tabs. The "Projects" tab is highlighted with an orange outline.](/assets/images/help/projects-v2/repo-tab.png) -1. Click **Link a project**. -1. In the search bar that appears, search for projects that are owned by the same user or organization that owns the repository. -1. Click on a project to list it in your repository. - -{% ifversion project-default-repositories %} - -## Setting a default repository for your project - -You can set a default repository for a project. When you set a default repository, new issues created from your project are automatically assigned to that repository. After you set a default repository, your project also appears in the repository’s **Projects** tab. - -To update the default repository for your project: - -1. In your repository, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -1. Under "Projects," find and click your project in the list. -1. In the top-right of the project page, click the {% octicon "kebab-horizontal" aria-label="repository settings" %} dropdown menu, then select **{% octicon "gear" aria-label="Settings" %} Settings** to go to the project settings page. - ![Screenshot showing the location of the "Settings" button in the project menu, highlighted with a red outline.](/assets/images/help/projects-v2/project-settings-navigation.png) -1. Under "Default repository," select a default repository for your project. -1. Click **Save changes** to confirm your changes.{% endif %} diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md deleted file mode 100644 index 67e764b6b8cd..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Adding your {% data variables.projects.project_v2 %} to a team -shortTitle: Adding a {% data variables.projects.project_v2 %} to a team -intro: You can add projects to teams to manage permissions and improve project discoverability. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -allowTitleToDifferFromFilename: true -permissions: Organization owners or people with the team maintainer role and admin permissions on a project can add a project to a team. -contentType: tutorials -category: - - Set up and manage projects ---- - -## About adding projects to teams - -You can add projects to your team to give the whole team collaborator access to their projects. When you add a project to a team, that project is listed on the team's projects page, making it easier for members to identify which projects a particular team uses. - -Teams are granted read permissions on any project they are added to. This permission is added to existing permissions for the project and for individual team members, ensuring that any higher permissions are retained. For more information about setting permissions for teams and individual contributors, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects). - -## Adding a project to a team - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.organizations.specific_team %} -1. Click **{% octicon "project" aria-hidden="true" aria-label="project" %} Projects**. - - ![Screenshot of the main page for a team. In the horizontal navigation bar, the "Projects" tab is outlined in dark orange.](/assets/images/help/organizations/team-project-board-button.png) - -1. Click **Link a project**. -1. In the search field, start typing the name of the project you want to add and then select the project in the list of matches. - - > [!NOTE] - > If this change will result in increased project permissions for the team's members, {% data variables.product.github %} will prompt you to confirm your choice. - -## Removing a project from a team - -{% data reusables.projects.project-settings %} -1. Click **Manage access**. -1. Next to the team that you want to remove from the project, click **Remove**. - -{% ifversion projects-v1 %} - -## Further reading - -* [Managing team access to an organization {% data variables.product.prodname_project_v1 %}](/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board) - -{% endif %} diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/closing-and-deleting-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/closing-and-deleting-your-projects.md deleted file mode 100644 index 5a6eb224795d..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/closing-and-deleting-your-projects.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Closing and deleting your {% data variables.projects.projects_v2 %} -shortTitle: Closing and deleting {% data variables.projects.projects_v2 %} -intro: Learn about closing, re-opening, and permanently deleting a {% data variables.projects.project_v2 %}. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/managing-projects -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - - -## Deleting a project - -You can delete a project to permanently remove it. - -{% data reusables.projects.project-settings %} -1. In the "Danger zone" section, next to "Delete project," click **Delete this project**. -1. Read the warnings, then type the name of your project into the text box. -1. Click **I understand the consequences, delete this project**. - -## Closing a project - -You can close a project to remove it from the list of projects but retain the contents and ability to re-open the project later. - -{% data reusables.projects.project-settings %} -1. In the "Danger zone" section, next to "Close project," click **Close this project**. - -## Re-opening an organization project - -You can reopen a previously closed project. - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.projects.projects-tab %} -1. In the left sidebar, click **Projects**. -{% data reusables.projects.reopen-a-project %} - -## Re-opening a user project - -You can reopen a previously closed project. - -{% data reusables.profile.access_profile %} -{% data reusables.projects.projects-tab %} -{% data reusables.projects.reopen-a-project %} diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/exporting-your-projects-data.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/exporting-your-projects-data.md deleted file mode 100644 index e0b41a3a05b8..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/exporting-your-projects-data.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Exporting your {% data variables.projects.project_v2 %} data -shortTitle: Exporting your {% data variables.projects.project_v2 %} data -intro: Learn about exporting your {% data variables.projects.project_v2 %} data. -permissions: People who can access a project can export a view. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects). -versions: - fpt: '*' - ghec: '*' - ghes: '*' -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - -You can download a view as a _.tsv_ (tab-separated) file. - -1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your repository. -1. Click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. - ![Screenshot showing a repository's tabs. The "Projects" tab is highlighted with an orange outline.](/assets/images/help/projects-v2/repo-tab.png) - -{% data reusables.projects.open-view-menu %} - -1. Click **Export view data**. diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/index.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/index.md deleted file mode 100644 index 7a6b9ce92674..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 'Managing your {% data variables.projects.project_v2 %}' -intro: Learn how to manage your projects and control visibility and access. -versions: - feature: projects-v2 -children: - - /managing-visibility-of-your-projects - - /managing-access-to-your-projects - - /managing-project-templates-in-your-organization - - /closing-and-deleting-your-projects - - /adding-your-project-to-a-repository - - /adding-your-project-to-a-team - - /exporting-your-projects-data -allowTitleToDifferFromFilename: true ---- diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md deleted file mode 100644 index c8044deaf9aa..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: Managing access to your {% data variables.projects.projects_v2 %} -shortTitle: Managing {% data variables.projects.project_v2 %} access -intro: Learn how to manage team and individual access to your {% data variables.projects.project_v2 %}. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/managing-access-to-projects -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - - -## About project access - -Admins of organization-level projects can manage access for the entire organization, for teams, for individual organization members, and for outside collaborators. - -Admins of user-level projects can invite individual collaborators and manage their access. - -Project admins can also control the visibility of their project for everyone on the internet. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects). - -## Managing access for organization-level projects - -You can control access to your project by setting permissions for particular individuals and teams or you can set a base permission that applies to everyone in your organization. - -### Managing access for everyone in your organization - -You can manage access for everyone in your organization to a particular project by changing the project's base permission. Changes to the base permission only affect organization members who are not organization owners and who are not granted individual access. - -You can also configure the default base permission at the organization-level for new projects and projects that haven't yet had a base permission configured. For more information about setting your organization's base permission for projects, see [AUTOTITLE](/organizations/managing-organization-settings/managing-base-permissions-for-projects). - -{% data reusables.projects.project-settings %} -1. Click **Manage access**. -1. Under **Base role**, select the default role. - - ![Screenshot showing the "Who has access" settings. The dropdown for setting the base role is highlighted with an orange outline.](/assets/images/help/projects-v2/base-role.png) - - * **No access:** Only organization owners and users granted individual access can see the project. Organization owners are also admins for the project. - * **Read:** Everyone in the organization can see the project. Organization owners are also admins for the project. - * **Write:** Everyone in the organization can see and edit the project. Organization owners are also admins for the project. - * **Admin:** Everyone in the organization is an admin for the project. - -### Managing access for teams and individual members of your organization - -You can also add teams, external collaborators, and individual organization members as collaborators for an organization-level project. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams). - -If you grant a team read permissions or greater for a project, the project is also displayed on the team's projects page. You can also add projects to a team on the team's projects page. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team). - -You can only invite an individual user to collaborate on your organization-level project if they are already a member of the organization or an outside collaborator on at least one repository in the organization. - -{% data reusables.projects.project-settings %} -1. Click **Manage access**. -1. Under **Invite collaborators**, search for the team or individual user that you want to invite. - - ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) - -1. Select the role for the collaborator. - * **Read:** The team or individual can view the project. - * **Write:** The team or individual can view and edit the project. - * **Admin:** The team or individual can view, edit, and add new collaborators to the project. -1. Click **Invite**. - -### Managing access of an existing collaborator on your project - -{% data reusables.projects.project-settings %} -1. Click **Manage access**. -1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. - - You can use the **Type** and **Role** drop-down menus to filter the access list. - - ![Screenshot of the "Manage access" section. The octocat is listed as a collaborator.](/assets/images/help/projects-v2/access-find-member.png) - -1. Edit the role for the collaborator(s). -1. Optionally, click **Remove** to remove the collaborator(s). - -## Managing access for user-level projects - -### Granting a collaborator access to your project - -> [!NOTE] -> This only affects collaborators for your project, not for repositories in your project. To view an item on the project, someone must have the required permissions for the repository that the item belongs to. Only people with access to a private repository will be able to view project items from that private repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility) and [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository). - -{% data reusables.projects.project-settings %} -1. Click **Manage access**. -1. Under **Invite collaborators**, search for the user that you want to invite. - - ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) - -1. Select the role for the collaborator. - * **Read:** The individual can view the project. - * **Write:** The individual can view and edit the project. - * **Admin:** The individual can view, edit, and add new collaborators to the project. -1. Click **Invite**. - -### Managing access of an existing collaborator on your project - -{% data reusables.projects.project-settings %} -1. Click **Manage access**. -1. Under **Manage access**, find the collaborator(s) whose permissions you want to modify. - - You can use the **Type** and **Role** drop-down menus to filter the access list. - - ![Screenshot of the "Manage access" section. The octocat is listed as a collaborator.](/assets/images/help/projects-v2/access-find-member.png) - -1. Edit the role for the collaborator(s). -1. Optionally, click **Remove** to remove the collaborator(s). diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md deleted file mode 100644 index fe9dfc483cfd..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Managing {% data variables.projects.project_v2 %} templates in your organization -shortTitle: Managing templates -intro: You can create templates or set projects as templates in your organization, allowing other people to select your template as the base for projects they create. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -permissions: People with admin permissions for a project in an organization can set the project as a template. People with admin or write permissions for a project in an organization can copy the project and set the copied project as a template. -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Set up and manage projects ---- - - - -## About templates - -You can create a template, or set a project as a template, to share a pre-configured project with other people in your organization which they can then use as the base for their projects. - -The projects you mark as templates are shown in the "Create a project" dialog when anyone creates a project in your organization. You can also configure up to six templates to recommend to your organization's members. - -When someone creates a project from a template, the {% data reusables.projects.what-gets-copied %} are copied from the template to the new project. You can find the template that a project used from the project's settings page, under the "Templates" section. - -## Creating a new template - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.projects.projects-tab %} -{% data reusables.projects.templates-tab %} -1. Click **New template**. - -## Setting a project as a template - -If you have admin permissions for a project in your organization, you can set the project as a template and make it available for others in your organization to use. - -{% data reusables.projects.project-settings %} -1. In the "Templates" section, next to "Make template", select the switch to toggle it to **On**. - -## Finding templates in your organization - -You can find all the templates in your organization on the "Templates" page. - -{% data reusables.profile.access_org %} -{% data reusables.user-settings.access_org %} -{% data reusables.projects.projects-tab %} -{% data reusables.projects.templates-tab %} - -You can also add templates to teams and repositories, to make them accessible and more visible from the team or repository's "Templates" page. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository). - -## Copying a project as a template - -If you have write or admin permissions for a project in your organization, you can choose to copy the project as a template. This will make a duplicate of the current project—copying the {% data reusables.projects.what-gets-copied %} —and set that copied project as a template for your organization. - -{% data reusables.projects.project-settings %} -1. In the "Templates" section, click **{% octicon "duplicate" aria-hidden="true" aria-label="duplicate" %} Copy as template**. - -## Configuring recommended templates - -If you are an organization owner, you can select up to six templates to recommend to your organization's members. These recommended templates are suggested first when an organization member creates a new project. - -### Choosing which templates to recommend - -You can add up to six templates to your organization's recommended templates. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Code, planning, and automation" section of the sidebar, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -1. Under "Recommended templates", click **Customize recommended templates**. -1. In the list of templates owned by your organization, select up to six templates that you want to recommend to your members. - - ![Screenshot of the recommended template selection modal.](/assets/images/help/projects-v2/rec-template-select.png) - -1. Click **Save**. - -### Arranging your recommended templates - -You can change the display order of your recommended templates in the "Create project" dialog. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Code planning, and automation" section of the sidebar, click **{% octicon "table" aria-hidden="true" aria-label="table" %} Projects**. -1. Under "Recommended templates", find the template you want to reposition, click on {% octicon "grabber" aria-label="Drag to reorder" %}, and drag the template to the new position. - - ![Screenshot of an organization's recommended templates settings. The 'Drag to reorder' handle is highlighted with an orange outline.](/assets/images/help/projects-v2/rec-template-handle.png) - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md deleted file mode 100644 index 73bacc82a493..000000000000 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Managing visibility of your {% data variables.projects.projects_v2 %} -shortTitle: Managing {% data variables.projects.project_v2 %} visibility -intro: Learn about setting your {% data variables.projects.project_v2 %} to private or public visibility. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/managing-the-visibility-of-your-projects -allowTitleToDifferFromFilename: true -permissions: Organization owners can manage the visibility of {% data variables.projects.projects_v2 %} in their organization. Organization owners can also allow collaborators with admin permissions to manage project visibility. Visibility of user projects can be managed by the owner of the project and collaborators with admin permissions. -contentType: tutorials -category: - - Set up and manage projects ---- - -## About project visibility - -Project visibility can be set to {% ifversion ghec %}private, internal when using an {% data variables.enterprise.prodname_emu_enterprise %}, or public if your enterprise does not use {% data variables.enterprise.prodname_managed_users %}{% else %}public or private{% endif %}. For public projects, everyone on the internet can view the project. For private projects, only users granted at least read access can see the project. {% ifversion ghec %} For internal projects, other members of your enterprise can see the project.{% endif %} - -Only the project visibility is affected; to view an item on the project, someone must have the required permissions for the repository that the item belongs to. Only people with access to a private repository will be able to view project items from that private repository. - -![Screenshot showing a project using a table layout. One of the items is marked with a padlock icon, indicating it's hidden, and outlined in orange.](/assets/images/help/projects-v2/hidden-items.png) - -Project admins and organization owners can control project visibility. Organization owners{% ifversion project-visibility-policy %} and enterprise owners{% endif %} can restrict the ability to change project visibility to just organization owners. - -In private{% ifversion ghec %} and internal{% endif %} organization-owned projects, the avatars of users who are current making updates to the project are displayed in the project UI. - -Project admins can also manage write and admin access to their project and control read access for individual users. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects). - -## Changing project visibility - -{% data reusables.projects.project-settings %} -1. Next to **Visibility** in the "Danger zone", {% ifversion ghec %}select the visibility. - * If using an {% data variables.enterprise.prodname_emu_enterprise %}, choose between **Private** and **Internal**. - * If your enterprise does not use {% data variables.enterprise.prodname_managed_users %}, choose between **Private** and **Public**.{% else %} select **Private** or **Public**.{% endif %} - -## Further reading - -* [Allowing project visibility changes in your organization](/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization) - diff --git a/content/issues/planning-and-tracking-with-projects/sharing-project-updates.md b/content/issues/planning-and-tracking-with-projects/sharing-project-updates.md deleted file mode 100644 index 8387733ec094..000000000000 --- a/content/issues/planning-and-tracking-with-projects/sharing-project-updates.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Sharing {% data variables.projects.project_v2 %} updates -intro: You can post updates to your {% data variables.projects.projects_v2 %} that share the current status, start date, and target date of the {% data variables.projects.project_v2 %} itself. -redirect_from: - - /issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -permissions: Anyone with write access for a project can add a status update. Anyone with read access for a project can view status updates and subscribe. -contentType: concepts -category: - - Set up and manage projects ---- - -## About status updates - -You can keep your team up to date and share high-level overviews, which people can use to determine the status of your project. You can set a status, such as "On track" or "At risk", to allow people to quickly determine the current state of the project. You can also set start dates and target dates. Your status update can also contain a message that supports formatting with Markdown. - -Status updates can be found on your project's side panel, below the description and README. You can read the most recent update at the top and the full history of updates beneath. Once you've added a status update, the current status is also shown in the project's header and in lists when you're browsing projects. - -## Adding new status updates - -You can add status updates to any project you have write access for. You can't add status updates to a project that is set as a template. When you start creating a new status update, the form will default to the previous update's status, start date, and target date. - -1. Navigate to your project. -1. In the top-right, click {% octicon "sidebar-expand" aria-label="Project details" %} to open the side panel. -1. Next to "Status updates", click **Add update**. -1. To change the status, click **Status**, and then select the status that best reflects the state of the project. -1. To change the dates shown in your status update, click either **Start date** or **Target date**, and select a new date. -1. Optionally, in the comment field, type a message to include in your status update. You can use Markdown to format your message. -1. Click **Save update**. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md deleted file mode 100644 index b445b2ab1c5a..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: About date fields -shortTitle: About date fields -intro: You can create custom date fields that can be set by typing a date or using a calendar. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/planning-and-tracking-with-projects/understanding-field-types/about-date-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -You can filter for date values using the `YYYY-MM-DD` format, for example: `date:2022-07-01`. You can also use operators, such as `>`, `>=`, `<`, `<=`, and `..`. For example, `date:>2022-07-01` and `date:2022-07-01..2022-07-31`. You can also provide `@today` to represent the current day in your filter. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -If your project makes use of date fields, you can use the roadmap layout to view items on a timeline. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout). - -> [!NOTE] -> Date fields do not currently support default values. - -## Adding a date field - -{% data reusables.projects.new-field %} -1. Select **Date** -1. Click **Save**. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md deleted file mode 100644 index d38e83a990ee..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: About issue fields in projects -shortTitle: About issue fields -intro: 'Learn how to use organization-level issue fields in your projects to track structured metadata like priority, effort, and dates.' -versions: - feature: issue-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -{% data reusables.issues.issue-fields-public-preview-note %} - -Issue fields are organization-level fields that provide consistent, typed metadata across all repositories. Unlike project custom fields, issue fields are defined once at the organization level and are available on every issue and in every project across the organization. For more information on creating and managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization). - -> [!NOTE] -> Issue fields are currently only supported in private projects. Issue fields are not available in public projects. - -## Adding an issue field to a project - -To display issue field values in a project: - -1. Open a project and select a view using the table layout. -1. Click {% octicon "plus" aria-label="Add field" %} in the table header. -1. Click **Add field**. -1. Select one or more issue fields from the list of available fields in the organization. -1. Click **Add**. - -The issue field appears as a column in the table view. - -## Removing an issue field from a project - -To remove an issue field from a project: - -1. Click {% octicon "kebab-horizontal" aria-label="open field options" %} in the top right corner of the project page. -1. Click **Settings**. -1. In the left sidebar, select the issue field you want to remove. -1. Click **Remove field**. - -Removing an issue field from a project does not delete the field or its values from the organization. The field can be re-added at any time. - -## Editing issue field values in a project - -You can edit issue field values directly in the project table view without opening the issue. Click on a cell in the issue field column to set or change the value. Changes are synced back to the issue automatically. - -## Grouping, filtering, and sorting - -You can group, filter, and sort project views by issue field values, just like any other project field. This works in both table and board layouts. - -You can also use issue fields to group by column on the board layout. - -## Charts and insights - -Issue fields are available as data sources in project charts. You can create charts that group or segment by issue field values to visualize trends across your organization. - -## Limits - -Projects support up to 50 fields in total. Issue fields and system fields count toward this limit. If a project is already at the field limit, you need to remove existing fields before issue fields can be added. - -> [!NOTE] -> Issue fields only apply to issues owned by the same organization. If a project contains pull requests, draft issues, or issues from another organization, issue field columns show empty cells for those items. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md deleted file mode 100644 index e94bc8eb1240..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: About iteration fields -shortTitle: About iteration fields -intro: You can create iterations to plan upcoming work and group items. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/managing-iterations - - /issues/planning-and-tracking-with-projects/understanding-field-types/about-iteration-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -You can create an iteration field to associate items with specific repeating blocks of time. Iterations can be set to any length of time, can include breaks, and can be individually edited to modify name and date range. With projects, you can group by iteration to visualize the balance of upcoming work, use filters to focus on a single iteration, and sort by iteration. - -You can filter for iterations by specifying the iteration name or `@current` for the current iteration, `@previous` for the previous iteration, or `@next` for the next iteration. You can also use operators such as `>`, `>=`, `<`, `<=`, and `..`. For example, `iteration:>"Iteration 4"` and `iteration:<@current`. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -When you first create an iteration field, three iterations are automatically created. You can add additional iterations and make other changes on your project's settings page. - -If your project makes use of iteration fields, you can use the roadmap layout to view items on a timeline. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout). - -## Adding an iteration field - -{% data reusables.projects.new-field %} -1. Under "Field type", select **Iteration**. -1. Optionally, if you don't want the iteration to start today, select the calendar dropdown next to "Starts on" and choose a new start date. -1. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. -1. Click **Save**. - -## Adding new iterations - -{% data reusables.projects.project-settings %} -1. Click the name of the iteration field you want to adjust. -1. To add a new iteration of the same duration, click **Add iteration**. - ![Screenshot showing iteration settings. The "Add iteration" button is highlighted with an orange outline.](/assets/images/help/projects-v2/add-iteration.png) -1. Optionally, to customize the duration of the new iteration and when it will start, click **{% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} More options**, select a starting date and duration, and click **Add**. - ![Screenshot showing iteration settings. The "More options" button is highlighted with an orange outline.](/assets/images/help/projects-v2/add-iteration-options.png) -1. Click **Save changes**. - -## Editing an iteration - -You can edit iterations in your project settings. You can also access the settings for an iteration field by clicking {% octicon "kebab-horizontal" aria-label="Cycle column options" %} in the table header for the field and clicking **Edit values**. - -{% data reusables.projects.project-settings %} -1. In the list on the left, click the name of the iteration field you want to adjust. -1. To change the name of an iteration, click on the name and start typing. - ![Screenshot of a single iteration's settings. The iteration name is highlighted with an orange outline.](/assets/images/help/projects-v2/iteration-rename.png) -1. To change the date or duration of an iteration, click on the date to open the calendar. Click on the start day, then click the end day, and then click **Apply**. - ![Screenshot of a single iteration's settings. The iteration date span is highlighted with an orange outline.](/assets/images/help/projects-v2/iteration-date.png) -1. Optionally, to delete an iteration, on the right of the iteration, click {% octicon "trash" aria-label="Remove item" %}. -1. Click **Save changes**. - -## Inserting a break - -You can insert breaks into your iterations to communicate when you are taking time away from scheduled work. The duration of a new break defaults to the length of the most recently created iteration. - -{% data reusables.projects.project-settings %} -1. Click the name of the iteration field you want to adjust. -1. Hover over the dividing line above an iteration, then click **Insert break**. - - ![Screenshot of the list of iterations for a project. On the line dividing two iterations, a button, labeled "Insert break," is outlined in orange.](/assets/images/help/issues/iteration-insert-break.png) -1. Optionally, to change the duration of the break, click on the date to open the calendar. Click on the start day, then click the end day, and then click **Apply**. -1. Click **Save changes**. - -## Moving items between iterations - -When a project view is grouped by an iteration field, you can bulk-move all items from one iteration to another. This is useful for rolling over unfinished work to the next sprint, rescheduling items during reprioritization, or clearing a backlog iteration. - -1. Navigate to your project. -1. In your project, group a view by an iteration field. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout#grouping-by-field-values). -1. Click {% octicon "kebab-horizontal" aria-label="iteration options" %} in the group header for the iteration you want to move items from. -1. Click **Move items to...**. -1. Select the target iteration you want to move the items to. -1. Confirm the move. All items in the group are updated to the target iteration. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-parent-issue-and-sub-issue-progress-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-parent-issue-and-sub-issue-progress-fields.md deleted file mode 100644 index 17954c31801a..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-parent-issue-and-sub-issue-progress-fields.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: About parent issue and sub-issue progress fields -shortTitle: About sub-issue fields -intro: You can show an issue's parent issue and view sub-issue progress in your projects. -versions: - feature: sub-issues -contentType: tutorials -category: - - Manage project items and fields ---- - -If your organization uses sub-issues, you can enable the "Parent issue" and "Sub-issue progress" fields on your projects to see the relationships between your issues and the progress made on those issues. - -The "Parent issue" field can be used to group items, allowing you to create views that break down your work using the sub-issue hierarchies you have created. For more about grouping views, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#grouping-by-field-values-in-table-layout). - -You can also filter by the "Parent issue" field to only display items that are sub-issues of a particular issue. You can start by typing "parent-issue" and then selecting an issue from the list. Or, if you know the repository and issue number, you can type the filter in full: - -```text -parent-issue:"/#" -``` - -To use the filter, replace `` with the repository owner, `` with the repository name, and `` with the issue number. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -## Enabling the Parent issue field - -You can enable the "Parent issue" field to see which parent issues the issues in your project belong to. - -1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - - ![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png) - -1. Under "Hidden fields", click **Parent issue**. - -## Enabling the Sub-issue progress field - -You can enable the "Sub-issue progress" field to see how many sub-issues have been completed. - -1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - - ![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png) - -1. Under "Hidden fields", click **Sub-issue progress**. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-pull-request-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-pull-request-fields.md deleted file mode 100644 index 52c71fbe0066..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-pull-request-fields.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: About pull request fields -shortTitle: About pull request fields -intro: You can show a linked pull request and the pull request reviewers in your projects. -versions: - fpt: '*' - ghec: '*' -contentType: tutorials -category: - - Manage project items and fields ---- - -You can enable the "Linked pull requests" and "Reviewers" fields on your projects to see information about a pull request, making a project the way to plan and track your issues, pull request, and code. - -## Enabling the Linked pull requests field - -You can enable the "Linked pull requests" field to see the pull request linked to an issue, allowing you to see the state of the pull request. - -1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - - ![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png) - -1. Under "Hidden fields", click **Linked pull requests**. - -## Enabling the Reviewers field - -You can enable the "Reviewers" field to see the reviewers on the pull request. - -1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - - ![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png) - -1. Under "Hidden fields", click **Reviewers**. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md deleted file mode 100644 index a536dbf264f8..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: About single select fields -shortTitle: About single select fields -intro: You can create single select fields with multiple options, each with a description and a color, that can be selected from a dropdown menu. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/planning-and-tracking-with-projects/understanding-field-types/about-single-select-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -You can filter by your single select fields by specifying the option, for example: `fieldname:option`. You can filter for multiple values by providing a comma-separated list of options, for example: `fieldname:option,option`. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -Single select fields can contain up to 50 options. - -## Adding a single select field - -{% data reusables.projects.new-field %} -1. Select **Single select** -1. Below "Options", type the first option. - * To add additional options, click **Add option**. -1. Click **Save**. - -## Setting a default value - -Choose an existing option as the default value for a single select field. New items added to the project are automatically pre-populated with that option. - -1. Access your project's settings. -1. Click the name of the single select field to configure. -1. In the list of options, select the option to use as the default. -1. Click **Save**. - -To remove a default value, deselect the currently selected default option, then click **Save**. Removing a default value does not affect existing items in the project. - -## Editing a single select field - -You can set descriptions and colors for each of your single select options. - -1. Access your project's settings. -1. To the right of the single select field you want to edit, click {% octicon "pencil" aria-label="The pencil icon" %}. - - ![Screenshot of the single select options. The pencil icon, by one of the options, is highlighted with an orange outline.](/assets/images/help/projects-v2/edit-single-select.png) - -1. In the modal that opens, under **Label text**, type the name of this option. -1. Optionally, under **Color**, select the color you want to use to represent this option. - - ![Screenshot of the modal for editing a single select option. The blue color option is highlighted with an orange outline.](/assets/images/help/projects-v2/edit-single-select-color.png) - -1. Optionally, under **Description**, type a description for this option. -1. Click **Save** to save your changes. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md deleted file mode 100644 index 759e71df17b0..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: About text and number fields -shortTitle: About text and number fields -intro: You can add custom text and number fields to your project. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/planning-and-tracking-with-projects/understanding-field-types/about-text-and-number-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -You can use text fields to include notes or any other freeform text in your project. - -Text fields can be used in filters, for example: `field:"exact text"`. Text fields and item titles will also be used if you filter for text without specifying a field. - -Number fields can also be used in filters. You can use `>`, `>=`, `<`, `<=`, and `..` range queries to filter by a number field. For example: `field:5..15` or `field:>=20`. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -## Adding a text field - -{% data reusables.projects.new-field %} -1. Select **Text**. -1. Click **Save**. - -## Adding a number field - -{% data reusables.projects.new-field %} -1. Select **Number**. -1. Click **Save**. - -## Setting a default value - -Set a default value for text or number fields. New items added to the project are automatically pre-populated with that value. - -{% data reusables.projects.project-settings %} -1. Click the name of the text or number field to configure. -1. In the **Default value** field, type the value to use as the default. -1. Click **Save**. - -To remove a default value, clear the **Default value** field, then click **Save**. Removing a default value does not affect existing items in the project. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md deleted file mode 100644 index 13f685e02880..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: About the issue type field -shortTitle: About the issue type field -intro: You can show the type of the issue in your projects. -versions: - feature: issue-types -contentType: tutorials -category: - - Manage project items and fields ---- - -If your organization uses issue types, you can enable the "Type" field on your projects to see the issue type and how the issue is classified in your organization, such as a bug, task, or feature. - -For more about issue types, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization). - -## Enabling the Type field - -You can enable the "Type" field to see the type of the issue. - -1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - - ![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png) - -1. Under "Hidden fields", click **Type**. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields.md deleted file mode 100644 index ce6da478dbb2..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/deleting-custom-fields.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Deleting custom fields -intro: Learn how to delete a custom field from your {% data variables.projects.project_v2 %}. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/planning-and-tracking-with-projects/understanding-field-types/deleting-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -{% data reusables.projects.project-settings %} -1. Click the name of the custom field you want to delete. -1. Click **Delete field**. - - ![Screenshot showing the settings for a note field. The "Delete field" button is highlighted with an orange outline.](/assets/images/help/projects-v2/delete-field.png) diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/index.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/index.md deleted file mode 100644 index a24839b4c1c3..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Understanding fields -shortTitle: Understanding fields -intro: 'Learn about the different fields and custom field types, how to add fields to your project, and how to manage custom fields.' -versions: - feature: projects-v2 -children: - - /about-text-and-number-fields - - /about-date-fields - - /about-single-select-fields - - /about-iteration-fields - - /about-issue-fields - - /about-parent-issue-and-sub-issue-progress-fields - - /about-pull-request-fields - - /about-the-issue-type-field - - /renaming-custom-fields - - /deleting-custom-fields -allowTitleToDifferFromFilename: true -redirect_from: - - /issues/planning-and-tracking-with-projects/understanding-field-types - - /issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields ---- diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/renaming-custom-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/renaming-custom-fields.md deleted file mode 100644 index bd778e65c229..000000000000 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/renaming-custom-fields.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Renaming custom fields -intro: Learn about renaming existing custom fields in your {% data variables.projects.project_v2 %}. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/planning-and-tracking-with-projects/understanding-field-types/renaming-fields -contentType: tutorials -category: - - Manage project items and fields ---- - -{% data reusables.projects.project-settings %} -1. Click the name of the custom field you want to rename. -1. Under "Field name", type the new name for the field. -1. To save changes, press Return. diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md deleted file mode 100644 index 6f3de1aca713..000000000000 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: About insights for {% data variables.product.prodname_projects_v2 %} -intro: You can view and customize charts that are built from your project's data. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -redirect_from: - - /issues/trying-out-the-new-projects-experience/using-insights-with-projects -allowTitleToDifferFromFilename: true -contentType: tutorials -category: - - Customize project views and insights ---- - -You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts. When you create a chart, you set the filters, chart type, the information displayed, and the chart is available to anyone that can view the project. You can generate two types of chart: current charts and historical charts. - -Insights does not track items you have archived or deleted. - -## About current charts - -You can create current charts to visualize your project items. For example, you can create charts to show how many items are assigned to each individual, or how many issues are assigned to each upcoming iteration. - -You can also use filters to manipulate the data used to build your chart. For example, you can create a chart showing how much upcoming work you have, but limit those results to particular labels or assignees. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -![Screenshot of a stacked column chart, with a column for each iteration. Each column is divided into "Bug", "Feedback", "Backend", and "UI" sections.](/assets/images/help/issues/column-chart-example.png) - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts). - -## About historical charts - -You can create historical charts to visualize your project items over time. Historical charts track changes to the state of your project items. You can see "Open" items with open issues and pull requests, "Completed" items with issues that were closed as completed or merged pull requests, "Closed pull requests", and "Not planned" items with issues that were closed as not planned. You can view the number of items or aggregation of items over time. - -The default "Burn up" chart allows you to visualize the progress of your issues over time, showing how much work is completed and how much is left to do. You can use this chart to view progress, spot trends, and identify bottlenecks to help move the project forward. - -![Screenshot of a "Burn up" chart, showing the issues over a two-week period split into the categories: "Open", "Completed", and "Not planned".](/assets/images/help/issues/burnup-example.png) - -To create a historical chart, set your chart's X-axis to "Time." You can also use filters to manipulate the data used to build your chart. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). - -For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts). - -## Further reading - -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md deleted file mode 100644 index f6deb183971f..000000000000 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Configuring charts -intro: Learn how to configure your charts and filter data from your project. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: tutorials -category: - - Customize project views and insights ---- - -{% data reusables.projects.access-insights %} -1. In the menu on the left, click on the chart you would like to configure. -1. On the right side of the page, click **Configure**. A panel will open on the right. -1. To change the type of chart, select the **Layout** dropdown and click on the chart type you want to use. -1. To change the field used for your chart's X-axis, select the **X-axis** dropdown and click the field you want to use. -1. Optionally, for current charts, to group the items on your X-axis by another field, select **Group by** and click on the field you want to use, or click "None" to disable grouping. -1. Optionally, if your project contains number fields and you want the Y-axis to display the sum, average, minimum, or maximum of one of those number fields, select **Y-axis** and click an option. Then, select the dropdown that appears beneath and click on the number field you want to use. -1. To save your chart, click **Save changes**. diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md deleted file mode 100644 index 74e21d0e5b64..000000000000 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Creating charts -intro: Learn how to create new charts to save your configurations. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -contentType: tutorials -category: - - Customize project views and insights ---- - -{% data reusables.projects.access-insights %} -1. In the menu on the left, click **New chart**. -1. Optionally, to change the name of the new chart, click {% octicon "triangle-down" aria-label="The triangle icon" %}, type a new name, and press Return. -1. Above the chart, type filters to change the data used to build the chart. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects). -1. To the right of the filter text box, click **Save changes**. diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/index.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/index.md deleted file mode 100644 index e1cb38ae35e9..000000000000 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: 'Viewing insights from your {% data variables.projects.project_v2 %}' -shortTitle: Viewing insights -intro: You can use insights to visualize your projects by creating and sharing charts built from your project's data. -versions: - feature: projects-v2-insights -children: - - /about-insights-for-projects - - /creating-charts - - /configuring-charts -allowTitleToDifferFromFilename: true ---- diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md b/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md deleted file mode 100644 index 9e8709e16f88..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Closing an issue -intro: 'You can close an issue when bugs are fixed, feedback is acted on, or to show that work is not planned.' -permissions: 'Anyone can close an issue they opened.

Repository owners, collaborators on repositories owned by a personal account, and people with triage permissions or greater on repositories owned by an organization can close issues opened by others. {% data reusables.enterprise-accounts.emu-permission-repo %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Close an issue -redirect_from: - - /issues/tracking-your-work-with-issues/closing-an-issue -category: - - Triage and organize issues ---- - -> [!NOTE] -> You can also close issues automatically with keywords in pull requests and commit messages. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword#linking-a-pull-request-to-an-issue-using-a-keyword). - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -1. In the list of issues, click the issue you'd like to close. -1. Optionally, to change your reason for closing the issue, next to "Close issue," select {% octicon "triangle-down" aria-label="Select close issue reason" %}, then click a reason. - - ![Screenshot of the buttons at the bottom of an issue. A button with a downward triangle icon, indicating a dropdown menu, is outlined in orange.](/assets/images/help/issues/close-issue-select-reason.png) -1. Click **Close issue**. diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/deleting-an-issue.md b/content/issues/tracking-your-work-with-issues/administering-issues/deleting-an-issue.md deleted file mode 100644 index 725c22da8421..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/deleting-an-issue.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Deleting an issue -intro: People with admin permissions in a repository can permanently delete an issue from a repository. -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/deleting-an-issue - - /articles/deleting-an-issue - - /github/managing-your-work-on-github/deleting-an-issue - - /issues/tracking-your-work-with-issues/creating-issues/deleting-an-issue - - /issues/tracking-your-work-with-issues/deleting-an-issue -versions: - fpt: '*' - ghes: '*' - ghec: '*' -category: - - Triage and organize issues ---- -The ability to delete issues depends on whether the repository is owned by a personal account or an organization: -* The only account that can delete issues in a repository owned by a personal account is that account. -* Only accounts with admin or owner permissions can delete issues in a repository owned by an organization. - - To delete an issue in a repository owned by an organization, an organization owner must enable deleting issues for the organization's repositories. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization) and [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). - -Collaborators do not receive a notification when issues are deleted. When visiting the URL of a deleted issue, collaborators will see a message stating that the web page can't be found (but they can use the API to determine that it was deleted). People with admin or owner permissions in the repository will additionally see the username of the person who deleted the issue and when it was deleted. - -1. Navigate to the issue you want to delete. -1. On the right side bar, under "Notifications", click **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete issue**. - - ![Screenshot of the issue sidebar. A trash can icon and "Delete issue" are outlined in dark orange.](/assets/images/help/issues/delete-issue.png) -1. To confirm deletion, click **Delete this issue**. - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/duplicating-an-issue.md b/content/issues/tracking-your-work-with-issues/administering-issues/duplicating-an-issue.md deleted file mode 100644 index 325d376a65c8..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/duplicating-an-issue.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Duplicating an issue -intro: 'To quickly create a similar issue, you can duplicate an existing open issue into the same repository or a different one.' -versions: - feature: duplicating-an-issue -shortTitle: Duplicate an issue -category: - - Create and work with issues ---- - -To duplicate an open issue, you must have triage access to the repository that contains the original issue and to the destination repository. The destination repository must allow blank issues. See [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). - -When you duplicate an issue, a new issue is created with the original issue’s title, description, assignees, type, labels, milestones, and projects prefilled, as long as those fields exist or are available in the destination repository. Labels and milestones are retained if they are present in the target repository, with labels matching by name and milestones matching by both name and due date. The original issue remains unchanged. - -People or teams mentioned in the original issue will not receive notifications about the duplication. The new issue will have its own URL and can be edited before being created. If you attempt to duplicate an issue to a repository where you do not have triage access, the option will not be available. - -## Duplicating an open issue - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} - -1. In the list of issues, click the issue you'd like to duplicate. -1. In the right sidebar, click **Duplicate issue**. -1. In the **Choose a repository** dropdown, select the destination repository. You can choose the same repository or a different one. -1. Edit the prefilled issue details as needed. -1. Click **Create issue**. - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues) diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/index.md b/content/issues/tracking-your-work-with-issues/administering-issues/index.md deleted file mode 100644 index f82667597610..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Administering issues -intro: 'Learn about performing administrative tasks on issues in your repositories.' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -children: - - /triaging-an-issue-with-ai - - /pinning-an-issue-to-your-repository - - /marking-issues-or-pull-requests-as-a-duplicate - - /transferring-an-issue-to-another-repository - - /closing-an-issue - - /deleting-an-issue - - /duplicating-an-issue ---- diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md b/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md deleted file mode 100644 index 111d1b286525..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/marking-issues-or-pull-requests-as-a-duplicate.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Marking issues or pull requests as a duplicate -intro: Mark an issue or pull request as a duplicate to track similar issues or pull requests together and remove unnecessary burden for both maintainers and collaborators. -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-duplicate-issues-and-pull-requests - - /articles/about-duplicate-issues-and-pull-requests - - /github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests - - /issues/tracking-your-work-with-issues/managing-issues/marking-issues-or-pull-requests-as-a-duplicate - - /issues/tracking-your-work-with-issues/marking-issues-or-pull-requests-as-a-duplicate -versions: - fpt: '*' - ghes: '*' - ghec: '*' -category: - - Triage and organize issues ---- -For a "marked as duplicate" timeline event to appear, the user who creates the duplicate reference comment must have write access to the repository where they create the comment. - -## Marking duplicates - -To mark an issue or pull request as a duplicate, type "Duplicate of" followed by an issue or pull request number in the body of a new comment. - -You can also use the {% data variables.product.company_short %}-provided saved replies, "Duplicate issue" or "Duplicate pull request." For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies). - -![Screenshot of an issue timeline, with a comment by octocat, "Duplicate of #97", and a timeline event "octocat marked this as a duplicate of #97."](/assets/images/help/issues/duplicate-issue-syntax.png) - -## Unmarking duplicates - -You can unmark duplicate issues and pull requests by clicking **Undo** in the timeline. This will add a new timeline event, indicating that the issue or pull request was unmarked. - -![Screenshot of an issue timeline. To the right of a timeline event where the issue was marked as a duplicate, an "Undo" button is outlined in orange.](/assets/images/help/issues/unmark-duplicate-issue-button.png) diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/pinning-an-issue-to-your-repository.md b/content/issues/tracking-your-work-with-issues/administering-issues/pinning-an-issue-to-your-repository.md deleted file mode 100644 index b0116634d2b0..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/pinning-an-issue-to-your-repository.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Pinning an issue to your repository -intro: You can pin up to three important issues above the issues list in your repository. -permissions: 'People with write access to a repository can pin issue in the repository. {% data reusables.enterprise-accounts.emu-permission-repo %}' -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/pinning-an-issue-to-your-repository - - /articles/pinning-an-issue-to-your-repository - - /github/managing-your-work-on-github/pinning-an-issue-to-your-repository - - /issues/tracking-your-work-with-issues/managing-issues/pinning-an-issue-to-your-repository - - /issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Pin an issue -category: - - Triage and organize issues ---- - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -1. In the list of issues, click the issue you'd like to pin. -1. In the right sidebar, click **Pin issue**. diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/transferring-an-issue-to-another-repository.md b/content/issues/tracking-your-work-with-issues/administering-issues/transferring-an-issue-to-another-repository.md deleted file mode 100644 index 914ef39307e8..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/transferring-an-issue-to-another-repository.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Transferring an issue to another repository -intro: 'To move an issue to a better fitting repository, you can transfer open issues to other repositories.' -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/transferring-an-issue-to-another-repository - - /articles/transferring-an-issue-to-another-repository - - /github/managing-your-work-on-github/transferring-an-issue-to-another-repository - - /issues/tracking-your-work-with-issues/managing-issues/transferring-an-issue-to-another-repository - - /issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Transfer an issue -category: - - Triage and organize issues ---- -To transfer an open issue to another repository, you must have write access to the repository the issue is in and the repository you're transferring the issue to. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). - -> [!NOTE] -> You can only transfer issues between repositories owned by the same user or organization account. A private repository issue cannot be transferred to a public repository. - -When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. {% ifversion projects-v1 %}This issue will stay on any user-owned or organization-wide {% data variables.projects.projects_v1_boards %} and be removed from any repository {% data variables.projects.projects_v1_boards %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).{% endif %} - -People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. - -## Transferring an open issue to another repository - -{% webui %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -1. In the list of issues, click the issue you'd like to transfer. -1. In the right sidebar, click **Transfer issue**. -1. Select the **Choose a repository** dropdown menu, and click the repository you want to transfer the issue to. -1. Click **Transfer issue**. - -{% endwebui %} - -{% cli %} - -{% data reusables.cli.cli-learn-more %} - -To transfer an issue, use the `gh issue transfer` subcommand. Replace the `issue` parameter with the number or URL of the issue. Replace the `{% ifversion ghes %}hostname/{% endif %}owner/repo` parameter with the {% ifversion ghes %}URL{% else %}name{% endif %} of the repository that you want to transfer the issue to, such as `{% ifversion ghes %}https://ghe.io/{% endif %}octocat/octo-repo`. - -```shell -gh issue transfer ISSUE {% ifversion ghes %}HOSTNAME/{% endif %}OWNER/REPO -``` - -{% endcli %} - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues) diff --git a/content/issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai.md b/content/issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai.md deleted file mode 100644 index 71905419a3da..000000000000 --- a/content/issues/tracking-your-work-with-issues/administering-issues/triaging-an-issue-with-ai.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Triaging an issue with AI -intro: 'Use AI to triage new issues and determine whether the issue is actionable or needs more information.' -permissions: 'Anyone on {% data variables.product.prodname_dotcom_the_website %} can configure AI triaging in any repository they have admin access to.' -versions: - fpt: '*' - ghec: '*' -shortTitle: Triage an issue -category: - - Triage and organize issues ---- - -## About the AI-powered issue intake tool - -The AI-powered issue intake tool helps you automate the triage process for new issues in your repository. Open source maintainers and project managers are often inundated with new issues, many of which may lack necessary information, or are not actionable. This tool leverages AI to analyze incoming issues and provide suggestions for triaging them, helping you manage your issue backlog more effectively. - -## Enabling the AI-powered issue intake tool - -The AI-powered issue intake tool is a {% data variables.product.github %} action that you can enable in your repository. For more information about {% data variables.product.github %} actions, see [AUTOTITLE](/actions/get-started/understand-github-actions). - -1. Visit the [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). -1. Search for and select "AI assessment comment labeler." -1. On the action's {% data variables.product.prodname_marketplace %} page, follow the setup instructions to install the action in your repository. -1. Optionally, customize the action's configuration file based on the guidance provided on the action's {% data variables.product.prodname_marketplace %} page. - -## Using the AI-powered issue intake tool - -If you are using the default configuration of the AI-powered issue intake tool, the action will be triggered when the `request ai review` label is applied to an issue. For information on creating a label, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label). Once triggered, the tool will analyze the issue and provide suggestions for triaging it. - -1. Navigate to the "Issues" tab in your repository. -1. Open a new or existing issue that you want to triage. -1. Add the AI labels that map to the analyses you want the tool to perform. -1. Apply the `request ai review` label to the issue. -1. Wait for the action to complete. You can monitor the progress in the "Actions" tab of your repository. -1. Once the action is complete, check the issue for comments or labels added by the AI-powered issue intake tool. The tool may suggest actions such as requesting more information, or marking it as actionable. -1. Review the suggestions provided by the tool and take appropriate action on the issue. diff --git a/content/issues/tracking-your-work-with-issues/index.md b/content/issues/tracking-your-work-with-issues/index.md deleted file mode 100644 index eb2c450b91e8..000000000000 --- a/content/issues/tracking-your-work-with-issues/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Tracking your work with issues -shortTitle: Issues -intro: 'Use {% data variables.product.prodname_github_issues %} to track ideas and work on {% data variables.product.prodname_dotcom %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -children: - - /learning-about-issues - - /using-issues - - /administering-issues -redirect_from: - - /issues/tracking-your-work-with-issues/creating-issues - - /issues/tracking-your-work-with-issues/managing-issues - - /issues/tracking-your-work-with-issues/configuring-issues ---- diff --git a/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md b/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md deleted file mode 100644 index a57dbfbcd9eb..000000000000 --- a/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: About issues -intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to track ideas, feedback, tasks, or bugs.' -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-issues - - /articles/creating-issues - - /articles/about-issues - - /github/managing-your-work-on-github/about-issues - - /issues/tracking-your-work-with-issues/creating-issues/about-issues - - /issues/tracking-your-work-with-issues/about-issues -versions: - fpt: '*' - ghes: '*' - ghec: '*' -category: - - Create and work with issues ---- - -You can create issues in your repository to plan, discuss, and track work. Issues are quick to create, flexible, and can be used in many ways. Issues can track bug reports, new features and ideas, and anything else you need to write down or discuss with your team, and you can use {% data variables.projects.projects_v2 %} to plan and track the work for your team. {% ifversion sub-issues %}You can also break your work down further by adding sub-issues and easily browse the full hierarchy of work to be done.{% endif %} - -Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion sub-issues %} while adding sub-issues,{% endif %} convert a comment in an issue or pull request, create an issue from a specific line of code, or via a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue). - -{% ifversion copilot %} - -> [!TIP] You can also use {% data variables.copilot.copilot_chat_short %} to generate ideas, outlines, or drafts for discussions or blog posts, based on your issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts). - -{% endif %} - -{% ifversion sub-issues %} - -## About sub-issues - -{% data reusables.issues.about-sub-issues %} See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues). - -{% endif %} - -## About issue dependencies - -You can define blocking relationships between issues using issue dependencies. Issue dependencies let you identify issues that are blocked by, or blocking, other work. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies). - -## Metadata on issues - -You can add metadata to your issues, including {% ifversion issue-types %}issue types, {% endif %}labels and milestones to organize your issues. - -See {% ifversion issue-types %}[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization), {% endif %}[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). - -## About integration with {% data variables.product.github %} - -Issues integrate with your work all across {% data variables.product.github %}. Mentioning an issue in another issue or pull request will create references between them and using keywords, like `fixes:`, in your pull requests will automatically close the associated issues. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue). - -## Using {% data variables.projects.projects_v2_caps %} to plan and track your work - -{% data variables.projects.projects_v2_caps %} is strongly integrated with issues to plan and track the work for your team. All your issue metadata is available in your projects, allowing you to create views and filters to represent your work. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). - -## Staying up to date - -To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments. To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications) and [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard). - -You can assign yourself and teammates to issues to make it clear who is working on an issue and also make it easier for you to locate your issues. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests). - -## Community management - -To help contributors open meaningful issues that provide the information that you need, you can use {% ifversion fpt or ghec %}issue forms and {% endif %}issue templates. See [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests). - -{% ifversion fpt or ghec %}To maintain a healthy community, you can report comments that violate {% data variables.product.github %}'s [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines). See [AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).{% endif %} - -## Efficient communication - -You can @mention collaborators who have access to your repository in an issue to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. To communicate responsibility, you can assign issues. If you find yourself frequently typing the same comment, you can use saved replies. -{% ifversion fpt or ghec %} See [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) and [AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users). -{% endif %} - -## Comparing issues and discussions - -Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see [AUTOTITLE](/get-started/using-github/communicating-on-github). - -When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion. - -## Next steps - -Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}: - -* To learn about getting started using issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/learning-about-issues/quickstart). -* To learn about the essentials for using GitHub's planning and tracking tools, see [AUTOTITLE](/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project). -* To learn more about how projects can help you with planning and tracking, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects). diff --git a/content/issues/tracking-your-work-with-issues/learning-about-issues/index.md b/content/issues/tracking-your-work-with-issues/learning-about-issues/index.md deleted file mode 100644 index 2d54d71b8ab1..000000000000 --- a/content/issues/tracking-your-work-with-issues/learning-about-issues/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Learning about issues -intro: 'Learn about issues and how to make the best of this powerful tool.' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -children: - - /about-issues - - /quickstart - - /planning-and-tracking-work-for-your-team-or-project ---- diff --git a/content/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project.md deleted file mode 100644 index 1bb79d8f2f3c..000000000000 --- a/content/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: Planning and tracking work for your team or project -intro: The essentials for using {% data variables.product.prodname_dotcom %}'s planning and tracking tools to manage work on a team or project. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -redirect_from: - - /issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project - - /issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project -contentType: concepts -category: - - Create and work with issues ---- -## Introduction - -You can use {% data variables.product.prodname_dotcom %} repositories, issues, projects, and other tools to plan and track your work, whether working on an individual project or cross-functional team. - -In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates and forms, open issues and break down work, and establish a {% data variables.projects.project_v2 %} for organizing and tracking issues. - -## Creating a repository - -When starting a new project, initiative, or feature, the first step is to create a repository. Repositories contain all of your project's files and give you a place to collaborate with others and manage your work. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository). - -You can set up repositories for different purposes based on your needs. The following are some common use cases: - -* **Product repositories:** Larger organizations that track their work and goals around specific products may have one or more repositories containing the code and other files. These repositories can also be used for documentation, reporting on product health or future plans for the product. -* **Project repositories:** You can create a repository for an individual project you are working on, or for a project you are collaborating on with others. For an organization that tracks work for short-lived initiatives or projects, such as a consulting firm, there is a need to report on the health of a project and move people between different projects based on skills and needs. Code for the project is often contained in a single repository. -* **Team repositories:** For an organization that groups people into teams, and brings projects to them, such as a dev tools team, code may be scattered across many repositories for the different work they need to track. In this case it may be helpful to have a team-specific repository as one place to track all the work the team is involved in. -* **Personal repositories:** You can create a personal repository to track all your work in one place, plan future tasks, or even add notes or information you want to save. You can also add collaborators if you want to share this information with others. - -You can create multiple, separate repositories if you want different access permissions for the source code and for tracking issues and discussions. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-an-issues-only-repository). - -For the following examples in this guide, we will be using an example repository called Project Octocat. - -## Communicating repository information - -You can create a README.md file for your repository to introduce your team or project and communicate important information about it. A README is often the first item a visitor to your repository will see, so you can also provide information on how users or contributors can get started with the project and how to contact the team. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes). - -You can also create a CONTRIBUTING.md file specifically to contain guidelines on how users or contributors can contribute and interact with the team or project, such as how to open a bug fix issue or request an improvement. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). - -### README example - -We can create a README.md to introduce our new project, Project Octocat. - -![Screenshot of the README.md file for the octo-org/project-octocat repository, with details about the project and how to contact the team.](/assets/images/help/issues/quickstart-creating-readme.png) - -## Creating issue templates - -You can use issues to track the different types of work that your cross-functional team or project covers, as well as gather information from those outside of your project. The following are a few common use cases for issues. - -* Release tracking: You can use an issue to track the progress for a release or the steps to complete the day of a launch. -* Large initiatives: You can use an issue to track progress on a large initiative or project, which is then linked to the smaller issues. -* Feature requests: Your team or users can create issues to request an improvement to your product or project. -* Bugs: Your team or users can create issues to report a bug. - -Depending on the type of repository and project you are working on, you may prioritize certain types of issues over others. Once you have identified the most common issue types for your team, you can create issue templates and forms for your repository. Issue templates and forms allow you to create a standardized list of templates that a contributor can choose from when they open an issue in your repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository). - -### Issue template example - -Below we are creating an issue template for reporting a bug in Project Octocat. - -![Screenshot of the form to create a new issue template. The fields are completed to create a template named "Bug report for Project Octocat."](/assets/images/help/issues/quickstart-creating-issue-template.png) - -Now that we created the bug report issue template, you are able to select it when creating a new issue in Project Octocat. - -![Screenshot of the "New issue" page for octo-org/project-octocat, with the option to use the "Bug report for Project Octocat" template.](/assets/images/help/issues/quickstart-issue-creation-menu-with-template.png) - -## Opening issues and breaking down work - -You can organize and track your work by creating issues. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue). - -### Issue example - -Here is an example of an issue created for a large initiative, front-end work, in Project Octocat. - -![Screenshot of an issue called "Front-end work for Project Octocat." The issue body includes a list of tasks to complete.](/assets/images/help/issues/quickstart-create-large-initiative-issue.png) - -{% ifversion sub-issues %} - -### Sub-issues example - -{% data reusables.issues.about-sub-issues %} See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues). - -{% ifversion issue-types %} - -You can use issue types to classify work in repositories across the organization, such as tasks, bugs, and features. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization). - -{% endif %} - - ![Screenshot of the sub-issues section below the issue description.](/assets/images/help/issues/sub-issue.png) - -{% endif %} - -### Task list example - -You can use task lists to break larger issues down into smaller tasks and to track issues as part of a larger goal. {% ifversion fpt or ghec %} Task lists have additional functionality when added to the body of an issue. You can see the number of tasks completed out of the total at the top of the issue, and if someone closes an issue linked in the task list, the checkbox will automatically be marked as complete.{% endif %} For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). - -Below we have added a task list to our Project Octocat issue, breaking it down into smaller issues. - -![Screenshot of an issue called "Front-end work for Project Octocat." The issue body contains a task list, with a checkbox preceding each issue link.](/assets/images/help/issues/quickstart-add-task-list-to-issue.png) - -### Label example - -Below is an example of a `front-end` label that we created and added to the issue. - -![Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.](/assets/images/help/issues/quickstart-add-label-to-issue.png) - -## Showing which issues are blocked by, or blocking, other work - -By creating issue dependencies, you can easily see and communicate which issues are blocked by, or blocking, other issues. This helps streamline coordination, prevent bottlenecks and increase transparency across the team. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies). - -{% ifversion copilot %} - -## Understanding new issues - -> [!NOTE] {% data reusables.copilot.copilot-requires-subscription %} - -When working on an unfamiliar or complex issue, {% data variables.product.prodname_copilot %} can help you quickly understand the context, history, and key information, so you can get started faster and with more confidence. - -### Reviewing the issue - -1. Navigate to an issue on {% data variables.product.github %}. - -{% data reusables.copilot.open-copilot %} - -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 main points of this issue` - * `What’s the goal of this issue?` - -{% data variables.product.prodname_copilot_short %}'s summary will help you capture the purpose and scope of the work. - -### Understanding the history and comments - -Issues often contain a history of discussions and decisions that can provide important context. You can use {% data variables.product.prodname_copilot_short %} to summarize these conversations to identify key points, such as proposed solutions or unanswered questions. For example, you might ask {% data variables.product.prodname_copilot_short %} to summarize recent comments or highlight decisions that have already been made. This helps you focus on what’s most relevant and ensures your contributions are aligned with the team’s priorities. - -### Clarifying technical terms - -Issues often mention technical terms, code, or files that might not be immediately clear. You can use {% data variables.product.prodname_copilot_short %} to get explanations or context for these references. For example, you can ask about the purpose of a file or function, or the meaning of a specific term mentioned in the issue. This helps you understand the details without spending extra time searching through documentation or code. - -### Getting suggestions for next steps - -Once you understand the context of an issue, {% data variables.product.prodname_copilot_short %} can help you figure out how to move forward. You can ask for suggestions on how to approach the work, like fixing a bug or implementing a new feature. For example, you might ask, “What’s the best way to resolve this issue?” or “How can I start addressing this problem?” {% data variables.product.prodname_copilot_short %}'s suggestions can provide useful starting points, helping you plan your work more effectively. - -{% endif %} - -## Making decisions as a team - -You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see [AUTOTITLE](/get-started/using-github/communicating-on-github#which-discussion-tool-should-i-use). - -As a team, you can also communicate updates on day-to-day tasks within issues so that everyone knows the status of work. For example, you can create an issue for a large feature that multiple people are working on, and each team member can add updates with their status or open questions in that issue. - -### Issue example with project collaborators - -Here is an example of project collaborators giving a status update on their work on the Project Octocat issue. - -![Screenshot of an issue called "Front-end work for Project Octocat." Comments from both @codercat and @octocat provide status updates on the work.](/assets/images/help/issues/quickstart-collaborating-on-issue.png) - -## Using labels to highlight project goals and status - -You can create labels for a repository to categorize issues, pull requests, and discussions. {% data variables.product.prodname_dotcom %} also provides default labels for every new repository that you can edit or delete. Labels are useful for keeping track of project goals, bugs, types of work, and the status of an issue. - -For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label). - -Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests). - -### Label example - -Below is an example of a `front-end` label that we created and added to the issue. - -![Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.](/assets/images/help/issues/quickstart-add-label-to-issue.png) - -## Adding issues to a {% data variables.projects.project_v2 %} - -You can use {% data variables.projects.projects_v2 %} on {% data variables.product.prodname_dotcom %} to plan and track the work for your team. A project is a customizable spreadsheet that integrates with your issues and pull requests on {% data variables.product.prodname_dotcom %}, automatically staying up-to-date with the information on {% data variables.product.prodname_dotcom %}. You can customize the layout by filtering, sorting, and grouping your issues and PRs. To get started with projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects). - -### Project example - -Here is the table layout of an example project, populated with the Project Octocat issues we have created. - -![Screenshot of the table view of a project, containing a list of issues, with columns for "Title," "Assignees," "Status," "Labels," and "Notes."](/assets/images/help/issues/quickstart-projects-table-view.png) - -We can also view the same project as a board. - -![Screenshot of the board view of a project, with issues organized into columns for "No Status," "Todo," "In Progress," and "Done."](/assets/images/help/issues/quickstart-projects-board-view.png) - -{% ifversion projects-v1 %} - -You can also use the existing {% data variables.product.prodname_projects_v1 %} on {% data variables.product.prodname_dotcom %} to plan and track your or your team's work. {% data variables.projects.projects_v1_boards_caps %} are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can create {% data variables.projects.projects_v1_boards %} for feature work, high-level roadmaps, or even release checklists. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). - -### {% data variables.projects.projects_v1_board_caps %} example - -Below is a {% data variables.projects.projects_v1_board %} for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it. - -![Screenshot of a {% data variables.projects.projects_v1_board %} called "Project Octocat Board," with issues organized into columns for "To do," "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png) - -{% endif %} - -## Next steps - -You have now learned about the tools {% data variables.product.prodname_dotcom %} offers for planning and tracking your work, and made a start in setting up your cross-functional team or project repository! Here are some helpful resources for further customizing your repository and organizing your work. - -* [AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories) for learning more about creating repositories -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects) for learning more about projects -* [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) for learning how to customize views for projects -* [AUTOTITLE](/issues/tracking-your-work-with-issues) for learning more about different ways to create and manage issues -* [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) for learning more about issue templates{% ifversion issue-types %} -* [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization) for managing issue types{% endif %} -* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) for learning how to create, edit and delete labels{% ifversion sub-issues %} -* [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues) for learning about adding sub-issues{% endif %} -* [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) for learning more about task lists -{% ifversion projects-v1 %}- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) for learning how to manage {% data variables.projects.projects_v1_boards %}{% endif %} diff --git a/content/issues/tracking-your-work-with-issues/learning-about-issues/quickstart.md b/content/issues/tracking-your-work-with-issues/learning-about-issues/quickstart.md deleted file mode 100644 index 0cf6d957d8cc..000000000000 --- a/content/issues/tracking-your-work-with-issues/learning-about-issues/quickstart.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: Quickstart for GitHub Issues -intro: Follow this brief interactive guide to learn about {% data variables.product.prodname_github_issues %}. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghec: '*' -redirect_from: - - /issues/tracking-your-work-with-issues/quickstart - - /issues/tracking-your-work-with-issues/configuring-issues/quickstart -contentType: get-started -category: - - Create and work with issues ---- - -## Introduction - -This guide demonstrates how to use {% data variables.product.prodname_github_issues %} to plan and track a piece of work. In this guide, you will create a new issue{% ifversion sub-issues %} and break it down into sub-issues{% endif %}. You'll also learn how to add labels{% ifversion issue-types %}, issue types{% endif %}, milestones, assignees, and projects to communicate metadata about your issue. - -## Prerequisites - -To create an issue, you need a repository. You can use an existing repository that you have write access to, or you can create a new repository. {% data reusables.enterprise-accounts.emu-permission-repo %} The repository must have issues enabled. For more information about creating a repository, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository). For more information about enabling issues if they are disabled in your repository, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues). - -## Opening a blank issue - -First, create an issue. There are multiple ways to create an issue; you can choose the most convenient method for your workflow. This example will use the {% data variables.product.prodname_dotcom %} UI. For more information about other ways to create an issue, see [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue). - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -{% data reusables.repositories.new_issue %} -1. In this example, we will start with a blank issue. Your repository may use issue templates{% ifversion fpt or ghec %} and issue forms{% endif %} to encourage contributors to provide specific information. If your repository uses issue templates, click **Open a blank issue**. - -## Filling in information - -Give your issue a descriptive title. The title should convey at a glance what the issue is about. - -Add a description that explains the purpose of the issue, including any details that might help resolve the issue. For example, if this is a bug report, describe the steps to reproduce the bug, the expected result, and the actual result. - -You can use markdown to add formatting, links, emojis, and more. For more information, see [AUTOTITLE](/get-started/writing-on-github). - -![Screenshot of the new issue form, with a title and body filled in.](/assets/images/help/issues/issue-title-body.png) - -{% ifversion sub-issues %} - -## Adding a task list - -You can also use plain text to track tasks that don't have a corresponding issue and convert them to issues later. For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). - -![Screenshot of the new issue form, with the title and body filled in. The body includes the Markdown for a task list.](/assets/images/help/issues/issue-task-list-raw.png) - -## Assigning the issue - -To communicate responsibility, you can assign the issue to a member of your organization. See [AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users). - -![Screenshot of the new issue form. In the right sidebar, the "Assignees" section is outlined in a dark orange.](/assets/images/help/issues/issue-assignees.png) - -## Adding labels - -Add a label to categorize your issue. For example, you might use a `question` label and a `good first issue` label to indicate that an issue is a question that a first-time contributor could pick up. Users can filter issues by label to find all issues that have a specific label. - -You can use the default labels, or you can create a new label. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels). - -![Screenshot of the new issue form. In the right sidebar, the "Labels" section is outlined in dark orange.](/assets/images/help/issues/issue-with-label.png) - -{% ifversion issue-types %} - -## Adding issue types - -You can add an issue type to classify work across the organization. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization). - -![Screenshot of the new issue form. In the right sidebar, the "Type" section is outlined in dark orange.](/assets/images/help/issues/issue-type.png) - -{% endif %} - -## Adding the issue to a project - -You can add the issue to an existing project and populate metadata for the project. For more information about projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). - -![Screenshot of the new issue form. In the right sidebar, the "Projects" section is outlined in dark orange.](/assets/images/help/issues/issue-project.png) - -## Adding milestones - -You can add a milestone to track the issue as part of a date based target. A milestone shows the progress of the issues as the target date approaches. See [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). - -![Screenshot of the new issue form. In the right sidebar, the "Milestone" section is outlined in dark orange.](/assets/images/help/issues/issue-milestone.png) - -## Submitting your issue - -Click **Submit new issue** to create your issue. You can edit any of the above fields after creating the issue. Your issue has a unique URL that you can share with team members, or reference in other issues or pull requests. - -## Adding sub-issues - -{% data reusables.issues.about-sub-issues %} See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues) and [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues). - - ![Screenshot of the sub-issues section below the issue description. The "View more sub-issue options" button is highlighted with an orange rectangle.](/assets/images/help/issues/sub-issue-drop-down.png) - -{% endif %} - -## Adding issue dependencies - -You can define blocking relationships between issues using issue dependencies. Issue dependencies let you identify issues that are blocked by, or blocking, other work. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies). - -## Communicating - -After your issue is created, continue the conversation by adding comments to the issue. You can @mention collaborators or teams to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. For more information, see [AUTOTITLE](/get-started/writing-on-github). - -![Screenshot of an issue comment. The header says "octocat commented now" and the body says "@hubot Do we also need to update the rocket logic?"](/assets/images/help/issues/issue-comment.png) - -## Next steps - -You can use issues for a wide range of purposes. For example: - -* Tracking ideas -* Collecting feedback -* Planning tasks -* Reporting bugs - -{% ifversion sub-issues %} - -To break your issue down into more manageable tasks, you can add multiple levels of sub-issues. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues). - -{% endif %} - -Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}: - -* To learn more about issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues). -* To learn about the essentials for using {% data variables.product.github %}'s planning and tracking tools, see [AUTOTITLE](/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project). -* To learn more about how projects can help you with planning and tracking, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects). -* To learn more about using issue templates{% ifversion fpt or ghec %} and issue forms{% endif %} to encourage contributors to provide specific information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests). diff --git a/content/issues/tracking-your-work-with-issues/using-issues/about-slash-commands.md b/content/issues/tracking-your-work-with-issues/using-issues/about-slash-commands.md deleted file mode 100644 index 7adad6473672..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/about-slash-commands.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: About slash commands -intro: 'Slash commands can save you time by reducing the typing required to create complex Markdown.' -versions: - feature: slash-commands -redirect_from: - - /early-access/issues/about-slash-commands - - /issues/tracking-your-work-with-issues/about-slash-commands -category: - - Create and work with issues ---- - -> [!NOTE] -> Slash commands are currently in {% data variables.release-phases.public_preview %} and subject to change. - -## About slash commands - -Slash commands make it easier to type more complex Markdown, such as tables, tasklists, and code blocks. - -You can use slash commands in any description or comment field in issues, pull requests, or discussions where that slash command is supported. - -## Using slash commands - -You can use slash commands by typing the command in a comment field, then following the prompts. To insert complex Markdown into your comment, type one of the following commands. - -| Command | Description | -| ------- | ----------- | -| `/code` | Inserts a Markdown code block. You choose the language. -| `/details` | Inserts a collapsible detail area. You choose the title and content. -| `/saved-replies` | Inserts a saved reply. You choose from the saved replies for your user account. If you add `%cursor%` to your saved reply, the slash command will place the cursor in that location. -| `/table` | Inserts a Markdown table. You choose the number of columns and rows. -| `/template` | Shows all of the templates in the repository. You choose the template to insert. This slash command will work for issue templates and a pull request template. diff --git a/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md b/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md deleted file mode 100644 index bf8c4fae83c0..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: Adding and managing issue fields -intro: 'You can set, edit, and clear issue field values on individual issues to capture structured metadata for your team.' -versions: - feature: issue-fields -contentType: how-tos -shortTitle: 'Using issue fields' -permissions: 'People with triage access or greater to a repository can set and edit issue field values.' -category: - - Create and work with issues ---- - -{% data reusables.issues.issue-fields-public-preview-note %} - -Issue fields appear in the right-hand sidebar of issues, alongside system fields like assignees, labels, and type. You can set values when creating or editing an issue. When you select an issue type while creating an issue, any fields pinned to that type automatically appear in the sidebar. - -## Setting a field value - -1. Navigate to the issue you want to update. -1. In the right sidebar, if the field you want is not already visible, click **Add field**. -1. From the dropdown, select the field you want to add. -1. Set the value: - * For **single-select** fields, choose an option from the dropdown. - * For **text** fields, type your value. URLs are automatically detected and displayed as links. - * For **number** fields, enter a numeric value. - * For **date** fields, use the date picker to select a date, or type the date directly. -1. Changes are saved automatically. - -## Editing a field value - -1. Navigate to the issue. -1. In the right sidebar, click on the field value you want to change. -1. Select a new value or type a new entry. -1. Changes are saved automatically. - -## Clearing a field value - -1. Navigate to the issue. -1. In the right sidebar, click on the field value. -1. Clear the value: - * For **single-select** fields, click the currently selected option to deselect it. - * For **text** and **number** fields, delete all text in the input. - * For **date** fields, click the clear button in the date picker. -1. After clearing, the field is removed from the sidebar. It can be re-added using the **Add field** button. - -## Pinned fields - -If your organization administrator has pinned fields to specific issue types, those fields automatically appear in the sidebar and the issue creation modal when you create or view an issue of that type. You do not need to manually add pinned fields. - -## Viewing field changes in the timeline - -When a field value is changed, the update is recorded in the issue timeline. The timeline entry shows: -* Which field was changed -* The new value that was set -* Who made the change -* When the change was made - -Timeline events for fields set to "Organization only" visibility are hidden from users who are not organization members or collaborators. - -## Field visibility - -Organization administrators can set each field's visibility to "Organization only" or "Public". This affects what you see: - -* If a field is set to **Organization only**, it is only visible to organization members and repository collaborators with at least read access. If you are not a member or collaborator, the field does not appear in the issue sidebar, timeline, or search suggestions. -* If a field is set to **Public**, it is visible to anyone viewing the issue. - -For more information about configuring visibility, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization#setting-field-visibility). - -## Using issue fields in projects - -Issue fields can be added as columns in project views, where you can edit values, group, filter, sort, and build charts. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields). - -## Searching by field values - -You can filter and search for issues based on field values on both the issues dashboard and your repository's issues page. In the search bar, type `field.` followed by the field name and value. For example: - -* `field.priority:high` to find issues with priority set to "high" -* `field."target date":>=2026-03-01` to find issues with a target date on or after March 1, 2026 -* `field.priority:high,medium` to find issues with priority set to "high" or "medium" - -For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests). - -## Using issue fields with the API - -Issue fields have full REST and GraphQL API support. You can automate field management, set values programmatically, and integrate with external tools. - -* **Managing fields**: Create, update, and delete organization-level fields. See the [Organization issue fields REST API](/rest/orgs/issue-fields). -* **Using fields**: Get, set, and clear field values on individual issues. See the [Issue field values REST API](/rest/issues/issue-field-values). -* **GraphQL**: Issue field types and mutations are also available via GraphQL. See the [`IssueFields` union](/graphql/reference/unions#issuefields), [issue field objects](/graphql/reference/objects#issuefieldtext) (such as `IssueFieldText`, `IssueFieldSingleSelect`, `IssueFieldNumber`, and `IssueFieldDate`), and [mutations](/graphql/reference/mutations#createissuefield) (such as `createIssueField`, `updateIssueField`, and `setIssueFieldValue`). diff --git a/content/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues.md b/content/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues.md deleted file mode 100644 index 57be64949fde..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Adding sub-issues -intro: Learn about using sub-issues to break down your work into tasks. -versions: - feature: sub-issues -permissions: People with at least triage permissions for a repository can add sub-issues. -redirect_from: - - /early-access/issues/about-tasklists - - /issues/tracking-your-work-with-issues/about-tasklists - - /issues/managing-your-tasks-with-tasklists/about-tasklists - - /issues/managing-your-tasks-with-tasklists/creating-a-tasklist - - /issues/managing-your-tasks-with-tasklists - - /issues/managing-your-tasks-with-tasklists/managing-tasks-in-a-tasklist - - /issues/managing-your-tasks-with-tasklists/quickstart-for-tasklists - - /issues/managing-your-tasks-with-tasklists/using-projects-and-tasklists -contentType: concepts -category: - - Create and work with issues ---- - -You can add sub-issues to an issue to break down larger pieces of work into tasks. Your sub-issues show their relationship to the parent issue allowing you to track your work across {% data variables.product.github %}. Parent issues and sub-issue progress is also available in your {% data variables.projects.projects_v2 %}, allowing you to build views, filter, and group by parent issue. - -Your sub-issues can themselves contain sub-issues, allowing you to create full hierarchies of issues that visualize entire projects or pieces of work and show the relationships between your issues. - -You can add up to {% data variables.projects.sub-issue_limit %} sub-issues per parent issue and create up to eight levels of nested sub-issues. - -## Creating a sub-issue - -1. Navigate to the issue that you want to add a sub-issue to. -1. At the bottom of the issue description, click **Create sub-issue**. -1. In the dialog, type the title for your sub-issue. -1. Optionally, type the description for your issue, and set {% ifversion issue-types %}the issue type and{% endif %} any assignees, labels, projects, and milestones. -1. Optionally, if you want to continue create sub-issues for this parent issue, select **Create more sub-issues**. -1. Click **Create**. - -## Adding an existing issue as a sub-issue - -1. Navigate to the issue that you want to add a sub-issue to. -1. At the bottom of the issue description, next to "Create sub-issue", click {% octicon "triangle-down" aria-label="View more sub-issue options" %}. - - ![Screenshot of the sub-issues section below the issue description. The "View more sub-issue options" button is highlighted with an orange rectangle.](/assets/images/help/issues/sub-issue-drop-down.png) - -1. In the drop-down menu, click **Add existing issue**. -1. Select the issue that you want to add as a sub-issue. - * Select an issue from one of the suggestions. - * In the "Search issues" field, type an issue title or issue number, then click on the results. - * To add issues from other repositories, click {% octicon "arrow-left" aria-label="Back to repository selection" %} next to the repository name and select a different repository. diff --git a/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md b/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md deleted file mode 100644 index 7d22dcafb2ee..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Assigning issues and pull requests to other GitHub users -intro: Assignees clarify who is working on specific issues and pull requests. -permissions: 'Anyone with write access to a repository can assign issues and pull requests. {% data reusables.enterprise-accounts.emu-permission-repo %}' -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/assigning-issues-and-pull-requests-to-other-github-users - - /articles/assigning-issues-and-pull-requests-to-other-github-users - - /github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users - - /issues/tracking-your-work-with-issues/managing-issues/assigning-issues-and-pull-requests-to-other-github-users - - /issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Assign issues & PRs -category: - - Create and work with issues ---- - -## About issue and pull request assignees - -You can assign multiple people to each issue or pull request, including: yourself, anyone who has commented on the issue or pull request, anyone with write permissions to the repository, and organization members with read permissions to the repository. For more information, see [AUTOTITLE](/get-started/learning-about-github/access-permissions-on-github). - -{% ifversion copilot %} - -You may also be able to assign {% data variables.product.prodname_copilot_short %} to an issue, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). - -{% endif %} - -Both issues and pull requests support up to 10 assignees. - -## Assigning an individual issue or pull request - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Open the issue or pull request that you want to assign to someone. -1. In the right side menu, click **Assignees**. - - ![Screenshot of the right sidebar of an issue. A header, labeled "Assignees", is outlined in dark orange.](/assets/images/help/issues/assignee-menu.png) -1. To assign the issue or pull request to a user, start typing their username, then click their name when it appears. You can select and add up to ten assignees to an issue or pull request. - -## Assigning multiple issues or pull requests - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Select the items you want to assign to someone. - - ![Screenshot of the first two items in a list of issues. To the left of each issue, a checkbox is checked and outlined in dark orange.](/assets/images/help/issues/issues-assign-checkbox.png) -1. In the upper-right corner, click **Assign**. -1. To assign the items to a user, start typing their username, then click their name when it appears. You can select and add up to ten assignees to an issue or pull request. - -{% ifversion copilot %} - -## Assigning an issue to {% data variables.product.prodname_copilot_short %} - -If you assign an issue to {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_copilot_short %} will work autonomously on the issue, creating a pull request and, when it has finished, requesting that you review the pull request. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). - -{% endif %} - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues.md b/content/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues.md deleted file mode 100644 index 287f32124482..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Browsing sub-issues -intro: Learn how to navigate issue hierarchy in your repositories. -versions: - feature: sub-issues -contentType: concepts -category: - - Create and work with issues ---- - -{% data reusables.issues.about-sub-issues %} - -## Navigating issue hierarchy - -You can browse through all levels of sub-issues from the parent issue. - -1. Navigate to the parent issue. -1. To view the sub-issues under another sub-issue, click the expand toggle ({% octicon "triangle-right" aria-hidden="true" aria-label="triangle-right" %}). - - ![Screenshot of a sub-issues section. The expand toggle is highlighted with an orange rectangle.](/assets/images/help/issues/sub-issue-expand.png) - -## Finding a sub-issue's parent issue - -When you view a sub-issue, you can always find a link back to the parent issue in the header below the issue title. - -![Screenshot of a sub-issue's header. The link to the parent issue, "Parent: create a scoreboard", is highlighted with an orange rectangle.](/assets/images/help/issues/sub-issue-parent.png) - -## Using sub-issues in your projects - -You can add sub-issues to your projects and make use of the hierarchy data for building views, grouping items, and filtering your views. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-parent-issue-and-sub-issue-progress-fields). diff --git a/content/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue.md deleted file mode 100644 index 82e6a1be5e85..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Creating a branch to work on an issue -intro: You can create a branch to work on an issue directly from the issue page and get started right away. -versions: - fpt: '*' - ghes: '*' - ghec: '*' -allowTitleToDifferFromFilename: true -shortTitle: Create branch for issue -redirect_from: - - /issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue -category: - - Create and work with issues ---- - -> [!NOTE] -> The ability to create a branch for an issue is currently in {% data variables.release-phases.public_preview %} and subject to change. - -## About branches connected to an issue - -Branches connected to an issue are shown under the "Development" section in the sidebar of an issue. When you create a pull request for one of these branches, it is automatically linked to the issue. The connection with that branch is removed and only the pull request is shown in the "Development" section. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - -## Creating a branch for an issue - -Anyone with write permission to a repository can create a branch for an issue. You can link multiple branches for an issue. - -By default, the new branch is created in the current repository, and from the default branch. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -1. In the list of issues, click the issue that you would like to create a branch for. -1. In the right sidebar under "Development", click **Create a branch**. If the issue already has a linked branch or pull request, select {% octicon "gear" aria-label="Development" %} and click **Create a branch**. - - ![Screenshot of the issue sidebar. In the "Development" section, a link, labeled "Create a branch", is outlined in dark orange.](/assets/images/help/issues/create-a-branch.png) -1. Optionally, in the "Branch name" field, type a branch name. -1. Optionally, select the **Repository destination** dropdown menu, then choose a repository. -1. Under "What's next", select whether you want to work on the branch locally or to open the branch in {% data variables.product.prodname_desktop %}. -1. Click **Create branch**. diff --git a/content/issues/tracking-your-work-with-issues/using-issues/creating-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/creating-an-issue.md deleted file mode 100644 index 435a0c6b780d..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/creating-an-issue.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: Creating an issue -intro: Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. -permissions: People with read access can create an issue in a repository where issues are enabled. {% data reusables.enterprise-accounts.emu-permission-repo %} -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/creating-an-issue - - /articles/creating-an-issue - - /github/managing-your-work-on-github/creating-an-issue - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/opening-an-issue-from-a-comment - - /github/managing-your-work-on-github/opening-an-issue-from-a-comment - - /issues/tracking-your-work-with-issues/creating-issues/opening-an-issue-from-a-comment - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/opening-an-issue-from-code - - /articles/opening-an-issue-from-code - - /github/managing-your-work-on-github/opening-an-issue-from-code - - /issues/tracking-your-work-with-issues/creating-issues/opening-an-issue-from-code - - /issues/tracking-your-work-with-issues/creating-issues/about-automation-for-issues-and-pull-requests-with-query-parameters - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-automation-for-issues-and-pull-requests-with-query-parameters - - /articles/about-automation-for-issues-and-pull-requests-with-query-parameters - - /github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters - - /issues/tracking-your-work-with-issues/creating-issues/creating-an-issue - - /issues/tracking-your-work-with-issues/creating-an-issue -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Create an issue -contentType: how-tos -category: - - Create and work with issues ---- - -Issues can be used to keep track of bugs, enhancements, or other requests. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues). - -{% data reusables.repositories.administrators-can-disable-issues %} - -## Creating an issue from a repository - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -{% data reusables.repositories.new_issue %} -1. If your repository uses issue templates, next to the type of issue you'd like to open, click **Get started**. - - If the type of issue you'd like to open isn't included in the available options, click **Open a blank issue**. - - ![Screenshot of the template chooser for an issue. Below the template choices, a link, labeled "Open a blank issue," is outlined in dark orange.](/assets/images/help/issues/blank-issue-link.png) -{% data reusables.repositories.type-issue-title-and-description %} - To cross-reference a related discussion, paste the discussion's URL into the issue description. -{% data reusables.repositories.assign-an-issue-as-project-maintainer %} -{% data reusables.repositories.submit-new-issue %} - -## Creating an issue with {% data variables.product.prodname_cli %} - -{% data reusables.cli.about-cli %} To learn more about {% data variables.product.prodname_cli %}, see [AUTOTITLE](/github-cli/github-cli/about-github-cli). - -To create an issue, use the `gh issue create` subcommand. To skip the interactive prompts, include the `--body` and the `--title` flags. - -```shell -gh issue create --title "My new issue" --body "Here are more details." -``` - -You can also specify assignees, labels, milestones, and projects. - -```shell -gh issue create --title "My new issue" --body "Here are more details." --assignee @me,monalisa --label "bug,help wanted" --project onboarding --milestone "learning codebase" -``` - -## Creating an issue from a comment - -You can open a new issue from a comment in an issue or pull request. When you open an issue from a comment, the issue contains a snippet showing where the comment was originally posted. - -1. Navigate to the comment that you would like to open an issue from. -1. In that comment, click {% octicon "kebab-horizontal" aria-label="Show options" %}. - - ![Screenshot of a comment on a pull request. The kebab button is outlined in dark orange.](/assets/images/help/pull_requests/kebab-in-pull-request-review-comment.png) - -1. Click **Reference in new issue**. -1. Use the "Repository" dropdown menu, and select the repository you want to open the issue in. -1. Type a descriptive title and body for the issue. -1. Click **Create issue**. -{% data reusables.repositories.assign-an-issue-as-project-maintainer %} -{% data reusables.repositories.submit-new-issue %} - -## Creating an issue from code - -You can open a new issue from a specific line or lines of code in a file or pull request. When you open an issue from code, the issue contains a snippet showing the line or range of code you chose. You can only open an issue in the same repository where the code is stored. - -{% data reusables.repositories.navigate-to-repo %} -1. Locate the code you want to reference in an issue: - * To open an issue about code in a file, navigate to the file. - * To open an issue about code in a pull request, navigate to the pull request and click **{% octicon "diff" aria-hidden="true" aria-label="diff" %} Files changed**. Then, browse to the file that contains the code you want included in your comment, and click **View**. -{% data reusables.repositories.choose-line-or-range %} -1. To the left of the code range, click {% octicon "kebab-horizontal" aria-label="Code line X options" %}. In the dropdown menu, click **Reference in new issue**. - - ![Screenshot of a file, with 8 lines selected. To the left of the first selected line, a button labeled with a kebab icon is outlined in dark orange.](/assets/images/help/repository/open-new-issue-specific-line.png) -{% data reusables.repositories.type-issue-title-and-description %} -{% data reusables.repositories.assign-an-issue-as-project-maintainer %} -{% data reusables.repositories.submit-new-issue %} - -## Creating an issue from discussion - -People with triage permission to a repository can create an issue from a discussion. - -When you create an issue from a discussion, the contents of the discussion post will be automatically included in the issue body, and any labels will be retained. Creating an issue from a discussion does not convert the discussion to an issue or delete the existing discussion. For more information about {% data variables.product.prodname_discussions %}, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions). - -{% data reusables.discussions.discussions-tab %} -{% data reusables.discussions.click-discussion-in-list %} -1. In the right sidebar, click **{% octicon "issue-opened" aria-hidden="true" aria-label="issue-opened" %} Create issue from discussion**. - - ![Screenshot of the sidebar in a discussion. The "Create issue from discussion" option is outlined in dark orange.](/assets/images/help/discussions/create-issue-from-discussion.png) - -{% data reusables.repositories.type-issue-title-and-description %} -{% data reusables.repositories.assign-an-issue-as-project-maintainer %} -{% data reusables.repositories.submit-new-issue %} - -## Creating an issue from a project - -{% data reusables.projects.about-issue-modal %} For more information about Projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). - -1. Navigate to your project. -{% data reusables.projects.create-issue-modal %} - -{% ifversion projects-v1 %} - -## Creating an issue from a {% data variables.projects.projects_v1_board %} note - -If you're using a {% data variables.projects.projects_v1_board %} to track and prioritize your work, you can convert notes to issues. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) and [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board#converting-a-note-to-an-issue). - -{% endif %} - -{% ifversion fpt or ghec %} - -## Creating an issue from a task list item - -Within an issue, you can use task lists to break work into smaller tasks and track the full set of work to completion. If a task requires further tracking or discussion, you can convert the task to an issue by hovering over the task and clicking {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). - -{% endif %} - -## Creating an issue from a URL query - -You can use query parameters to open issues. Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results or an issue template on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair. - -> [!TIP] -> You can also create issue templates that open with default labels, assignees, and an issue title. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests). - -You must have the proper permissions for any action to use the equivalent query parameter. For example, you must have permission to add a label to an issue to use the `labels` query parameter. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). - -If you create an invalid URL using query parameters, or if you don't have the proper permissions, the URL will return a `404 Not Found` error page. If you create a URL that exceeds the server limit, the URL will return a `414 URI Too Long` error page. - -Query parameter | Example ---- | --- -`title` | `https://github.com/octo-org/octo-repo/issues/new?labels=bug&title=New+bug+report` creates an issue with the label "bug" and title "New bug report." -`body` | `https://github.com/octo-org/octo-repo/issues/new?title=New+bug+report&body=Describe+the+problem.` creates an issue with the title "New bug report" and the comment "Describe the problem" in the issue body. -`labels` | `https://github.com/octo-org/octo-repo/issues/new?labels=help+wanted,bug` creates an issue with the labels "help wanted" and "bug". -`milestone` | `https://github.com/octo-org/octo-repo/issues/new?milestone=testing+milestones` creates an issue with the milestone "testing milestones." -`assignees` | `https://github.com/octo-org/octo-repo/issues/new?assignees=octocat` creates an issue and assigns it to @octocat. -`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project 1. -`template` | `https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md` creates an issue with a template in the issue body. The `template` query parameter works with templates stored in an `ISSUE_TEMPLATE` subdirectory within the root, `docs/` or `.github/` directory in a repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests). - -{% ifversion fpt or ghec %} -You can also use URL query parameters to fill custom text fields that you have defined in issue form templates. Query parameters for issue form fields can also be passed to the issue template chooser. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys). -{% endif %} - -{% ifversion copilot %} - -## Creating an issue with {% data variables.copilot.copilot_chat_short %} on {% data variables.product.github %} - -> [!NOTE] -> This feature is in {% data variables.release-phases.public_preview %} and subject to change. - -Creating issues manually can be repetitive and time-consuming. With {% data variables.product.prodname_copilot_short %}, you can create issues faster by prompting in natural language, or even by uploading a screenshot. {% data variables.product.prodname_copilot_short %} fills out the title, body, labels, assignees, and more, using your repository’s templates and structure. See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-to-create-issues). - -## Creating an issue from {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %} - -You can also create an issue directly from {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}, using the Model Context Protocol (MCP). See [AUTOTITLE](/copilot/customizing-copilot/extending-copilot-chat-with-mcp). - -{% endif %} - -## Further reading - -* [AUTOTITLE](/get-started/writing-on-github) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies.md b/content/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies.md deleted file mode 100644 index 186c3a08336b..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Creating issue dependencies -intro: Learn how to create issue dependencies so that you can see which issues are blocked by, or blocking, other work. -versions: - fpt: '*' - ghec: '*' -permissions: People with at least triage permissions for a repository can create issue dependencies. -product: Issue dependencies are available for users on {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %} plans. -contentType: concepts -category: - - Create and work with issues ---- - -Issue dependencies let you define issues that are blocked by, or blocking, other work. - -## Marking an issue as blocked by, or blocking, another issue - -1. Navigate to the issue that you want to create a dependency for. -1. In the right sidebar, click **Relationships**. -1. From the dropdown, select a dependency option: - * To indicate that your issue depends on another issue being completed, select **Mark as blocked by**. - * To indicate that your issue is preventing another issue from being completed, select **Mark as blocking**. -1. In the dialog box that opens, search for and select all the issues that are blocked by, or blocking, your issue. - -Blocked issues are marked with a "Blocked" icon on your project boards or repository's Issues page, so you can easily identify bottlenecks. - -## Removing a blocking relationship between two issues - -1. Navigate to the issue that you want to remove a dependency from. -1. In the right sidebar, click **Relationships**. -1. From the dropdown, select a dependency option: - * To indicate that your issue no longer depends on another issue being completed, select **Change blocked by**. - * To indicate that your issue is no longer preventing another issue from being completed, select **Change blocking**. -1. In the dialog box that opens, deselect the issues that are no longer blocked by, or blocking, your issue. diff --git a/content/issues/tracking-your-work-with-issues/using-issues/editing-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/editing-an-issue.md deleted file mode 100644 index 44699b18f15a..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/editing-an-issue.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Editing an issue -intro: Learn how to make changes to an existing issue. -permissions: Issue authors, people with write access or higher in repositories owned by an organization, and collaborators in repositories owned by a personal account can make changes to issues. {% data reusables.enterprise-accounts.emu-permission-repo %} -versions: - fpt: '*' - ghes: '*' - ghec: '*' -contentType: how-tos -category: - - Create and work with issues ---- - -## Editing an issue title - -You can edit an issue's title. The change to the title is added to the issue's timeline. - -1. Navigate to the issue you want to edit. -1. To the right of the issue title, click **Edit**. - - ![Screenshot of an issue header, the "Edit" button is highlighted with an orange outline.](/assets/images/help/issues/issue-edit-title.png) - -1. Type your new title. -1. Click **Save**. - -## Editing an issue description - -You can also make changes to the issue description. The edit history is available unless the author or a person with write access removes it. See [AUTOTITLE](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment). - -1. Navigate to the issue you want to edit. -1. At the top right of the issue description, click {% octicon "kebab-horizontal" aria-label="Issue body actions" %}. - - ![Screenshot of an issue description. The "Issue body actions" button is highlighted with an orange outline.](/assets/images/help/issues/issue-edit-description.png) - -1. In the menu, click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Edit**. -1. Type your changes to the issue description. -1. Click **Save**. - -{% ifversion issue-types %} - -## Adding or changing the issue type - -You can add an issue type or make changes to an existing issue type. - -1. Navigate to the issue you want to edit. -1. To the right of the issue, in the sidebar, click **Type**. - - ![Screenshot of an issue sidebar. The "Add issue type" button is highlighted with an orange outline.](/assets/images/help/issues/issue-add-type.png) - -1. In the list, select a new issue type. -1. Click **Save**. - -{% endif %} - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/administering-issues/closing-an-issue) -* [AUTOTITLE](/issues/tracking-your-work-with-issues/administering-issues/deleting-an-issue) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md deleted file mode 100644 index ce0e59c35982..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -title: Filtering and searching issues and pull requests -intro: To find detailed information about a repository on {% data variables.product.github %}, you can filter, sort, and search issues and pull requests that are relevant to the repository. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees - - /articles/filtering-issues-and-pull-requests-by-assignees - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels - - /articles/filtering-issues-and-pull-requests-by-labels - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests - - /articles/filtering-issues-and-pull-requests - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-pull-requests-by-review-status - - /articles/filtering-pull-requests-by-review-status - - /github/managing-your-work-on-github/filtering-pull-requests-by-review-status - - /github/managing-your-work-on-github/finding-information-in-a-repository - - /articles/finding-information-in-a-repository - - /github/managing-your-work-on-github/finding-information-in-a-repository/sharing-filters - - /articles/sharing-filters - - /github/managing-your-work-on-github/sharing-filters - - /github/managing-your-work-on-github/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests - - /articles/using-search-to-filter-issues-and-pull-requests - - /github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests - - /github/managing-your-work-on-github/finding-information-in-a-repository/sorting-issues-and-pull-requests - - /articles/sorting-issues-and-pull-requests - - /github/managing-your-work-on-github/sorting-issues-and-pull-requests - - /github/administering-a-repository/finding-information-in-a-repository - - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests - - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees - - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels - - /github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status - - /github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests - - /github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests - - /github/administering-a-repository/finding-information-in-a-repository/sharing-filters - - /issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Filter and search -contentType: how-tos -category: - - Create and work with issues ---- - -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -## Filtering issues and pull requests - -Issues and pull requests come with a set of default filters you can apply to organize your listings. - -You can filter issues and pull requests to find: -* All open issues and pull requests -* Issues and pull requests that you've created -* Issues and pull requests that are assigned to you -* Issues and pull requests where you're [**@mentioned**](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams) - -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Above the list, select the **Filters** dropdown menu, then click the type of filter you're interested in. - - ![Screenshot of the list of issues for a repository. Above the list, a dropdown menu, labeled "Filters", is outlined in dark orange.](/assets/images/help/issues/issues-filter-dropdown.png) - -{% ifversion issues-advanced-search %} - -{% webui %} - -## Building advanced filters for issues - -You can build advanced filters using boolean and nested queries on your repository's issues page{% ifversion issues-dashboard %} and the issues dashboard{% endif %}. As you type your filter, {% data variables.product.github %} will show available qualifiers, suggest values, and warn when there is a problem with your filter. - -### Using boolean operators - -You can use `AND` and `OR` operators to refine your filters. - -Use `AND` when you need results where both statements are true. In the example filter below, the results will be comprised of issues with the "question" label that are assigned to the @octocat user. - -```text -label:"question" AND assignee:octocat -``` - -To return results where either statement is true, use `OR`. In the example below, the results will contain issues assigned to either @octocat or @hubot. - -```text -assignee:octocat OR assignee:hubot -``` - -If you choose not to use `AND` and `OR` operators, {% data variables.product.github %} will treat a space between statements as an `AND` operator{% ifversion ghes < 3.18 %} unless you are using an `org`, `repo`, or `user` field to filter by ownership, in which case any spaces will be treated as an `OR` operator{% endif %}. - -### Using parentheses for more complicated filters - -You can also use parentheses to nest filters and group qualifiers. In the example below, the results will contain issues that are either assigned to @octocat with the "bug" issue type or assigned to @hubot with the "Feature" issue type. - -```text -(type:"Bug" AND assignee:octocat) OR (type:"Feature" AND assignee:hubot) -``` - -You can nest filters using parentheses up to five levels deep.{% ifversion ghes < 3.18 %} It's not currently possible to include the `repo`, `org`, or `user` qualifiers within parentheses.{% endif %} - -{% endwebui %} - -{% endif %} - -## Filtering issues and pull requests by assignees - -Once you've [assigned an issue or pull request to someone](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users), you can find items based on who's working on them. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Above the list of issues or pull requests, select the **Assignee** dropdown menu. - - ![Screenshot of a list of issues. In the header above the list, a dropdown menu, labeled "Assignees", is outlined in dark orange.](/assets/images/help/issues/issues-assignee-dropdown.png) -1. The Assignee drop-down menu lists everyone who has write access to your repository. Click the name of the person whose assigned items you want to see, or click **Assigned to nobody** to see which issues are unassigned. - -> [!TIP] -> To clear your filter selection, click **Clear current search query, filters, and sorts**. - -## Filtering issues and pull requests by labels - -Once you've [applied labels to an issue or pull request](/issues/using-labels-and-milestones-to-track-work/managing-labels), you can find items based on their labels. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.labels %} -1. In the list of labels, click a label. - -> [!TIP] -> To clear your filter selection, click **Clear current search query, filters, and sorts**. - -{% ifversion issue-types %} - -## Filtering by issue type - -If your organization uses issue types, you can filter issues for a particular type. You can also type the `type:` qualifier directly into your filter. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -1. Above the list of issues, select the **Types** dropdown menu. - - ![Screenshot of a list of issues. In the list header, the "Types" filter is outlined in orange and expanded.](/assets/images/help/issues/issue-type-dropdown.png) - -1. In the list of type, click an issue type. - -{% endif %} - -{% ifversion issue-fields %} - -## Filtering by issue fields - -If your organization uses issue fields, you can filter issues by field values. Type `field.` followed by the field name and value in your filter. Field names with spaces should be enclosed in quotes. - -Examples: -* `field.priority:high` -- find issues with priority set to "high" -* `field."target date":>=2026-03-01` -- find issues with a target date on or after March 1, 2026 -* `field.story-points:>5` -- find issues with a number field value greater than 5 -* `field.priority:high,medium` -- find issues with priority set to "high" or "medium" - -For more information about managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization). - -{% endif %} - -## Filtering pull requests by review status - -You can use filters to list pull requests by review status and to find pull requests that you've reviewed or other people have asked you to review. - -You can filter a repository's list of pull requests to find: -* Pull requests that haven't been [reviewed](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) yet -* Pull requests that [require a review](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged -* Pull requests that a reviewer has approved -* Pull requests in which a reviewer has asked for changes -* Pull requests that you have reviewed -* Pull requests that someone has asked you directly to review -* Pull requests that [someone has asked you, or a team you're a member of, to review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-pr %} -1. In the upper-right corner, select the **Reviews** dropdown menu. - - ![Screenshot of the filter menu above the list of pull requests. The "Reviews" dropdown is outlined in dark orange.](/assets/images/help/pull_requests/reviews-filter-dropdown.png) - -1. Choose a filter to find all of the pull requests with that filter's status. - -## Using search to filter issues and pull requests - -You can use filters to search for issues and pull requests that meet specific criteria. - -### Searching for issues and pull requests - -{% webui %} - -The issues and pull requests search bar allows you to define your own custom filters and sort by a wide variety of criteria. You can find the search bar on each repository's **Issues** and **Pull requests** tabs and on your [Issues and Pull requests dashboards](/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests). - -![Screenshot of the list of issues for a repository. Above the list, a search field, containing the query "is:issue is:open", is outlined in orange.](/assets/images/help/issues/issues-search-bar.png) - -> [!TIP] -> {% data reusables.search.search_issues_and_pull_requests_shortcut %} - -{% endwebui %} - -{% cli %} - -{% data reusables.cli.cli-learn-more %} - -You can use the {% data variables.product.prodname_cli %} to search for issues or pull requests. Use the `gh issue list` or `gh pr list` subcommand along with the `--search` argument and a search query. - -For example, you can list, in order of date created, all issues that have no assignee and that have the label `help wanted` or `bug`. - -```shell -gh issue list --search 'no:assignee label:"help wanted",bug sort:created-asc' -``` - -You can also list all pull requests that mention the `octo-org/octo-team` team. - -```shell -gh pr list --search "team:octo-org/octo-team" -``` - -{% endcli %} - -### About search terms - -With issue and pull request search terms, you can: - -* Filter issues and pull requests by author: `state:open is:issue author:octocat` -* Filter issues and pull requests that involve, but don't necessarily [**@mention**](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams), certain people: `state:open is:issue involves:octocat` -* Filter issues and pull requests by assignee: `state:open is:issue assignee:octocat` -* Filter issues and pull requests by label: `state:open is:issue label:"bug"` -* Filter out search terms by using `-` before the term: `state:open is:issue -author:octocat` - -> [!TIP] -> * You can filter issues by label using logical OR or using logical AND. -> * To filter issues using logical OR, use the comma syntax: `label:"bug","wip"`. -> * To filter issues using logical AND, use separate label filters: `label:"bug" label:"wip"`. -> * You can use `@copilot` with qualifiers like `assignee:` and `author:` to search for issues and pull requests assigned to or authored by {% data variables.product.prodname_copilot_short %}. For example, `assignee:@copilot` or `author:@copilot`. - -For issues, you can also use search to: - -* Filter for issues that are linked to a pull request by a closing reference: `linked:pr` -* Filter issues by the reason they were closed: `is:closed reason:completed` or `is:closed reason:"not planned"` -{% ifversion issue-types %}* Filter for issues with a particular type: `is:open type:"Bug"`{% endif %}{% ifversion issue-fields %} -* Filter for issues by field value: `is:open field.priority:high`{% endif %}{% ifversion issues-advanced-search %} -* Filter for issues that have metadata: `has:label` -* Filter for issues that are missing metadata: `no:project` -* Filter for issues from repositories [**owned**](/search-github/searching-on-github/searching-issues-and-pull-requests#search-within-a-users-or-organizations-repositories) by a certain user or organization, limited to up to 16 `user` and `org` qualifiers with no limit on `repo` qualifiers: `state:open is:issue org:github OR user:octocat`{% endif %} - -For pull requests, you can also use search to: - -* Filter [draft](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests) pull requests: `is:draft` -* Filter pull requests that haven't been [reviewed](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) yet: `state:open is:pr review:none` -* Filter pull requests that [require a review](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged: `state:open is:pr review:required` -* Filter pull requests that a reviewer has approved: `state:open is:pr review:approved` -* Filter pull requests in which a reviewer has asked for changes: `state:open is:pr review:changes_requested` -* Filter pull requests by [reviewer](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews): `state:open is:pr reviewed-by:octocat` -* Filter pull requests by the specific user [requested for review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review): `state:open is:pr review-requested:octocat` -* Filter pull requests that someone has asked you directly to review: `state:open is:pr user-review-requested:@me` -* Filter pull requests by the team requested for review: `state:open is:pr team-review-requested:github/docs` -* Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue` -* Filter pull requests where all statuses are successful: `status:success` -* Filter pull requests with at least one error or failure status: `status:failure` -* Filter pull requests with no statuses or at least one status in the pending state: `status:pending` -* Filter pull requests by state of [merging](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges): `is:merged` or `is:unmerged` - -## Sorting issues and pull requests - -Filters can be sorted to provide better information during a specific time period. - -You can sort any filtered view by: - -* The newest created issues or pull requests -* The oldest created issues or pull requests -* The most commented issues or pull requests -* The least commented issues or pull requests -* The newest updated issues or pull requests -* The oldest updated issues or pull requests -* The most added reaction on issues or pull requests - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Above the list of issues or pull requests, select the **Sort** dropdown menu, then click a sort method. - - ![Screenshot of the list of issues for a repository. Above the list, a dropdown menu, labeled "Sort," is outlined in dark orange.](/assets/images/help/issues/issues-sort-dropdown.png) - -To clear your sort selection, click **Sort** > **Newest**. - -## Sharing filters - -When you filter or sort issues and pull requests, your browser's URL is automatically updated to match the new view. - -You can send the URL that issues generates to any user, and they'll be able to see the same filter view that you see. - -For example, if you filter on issues assigned to Hubot, and sort on the oldest open issues, your URL would update to something like the following: - -```text -/issues?q=state:open+is:issue+assignee:hubot+sort:created-asc -``` - -## Further reading - -* [AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/index.md b/content/issues/tracking-your-work-with-issues/using-issues/index.md deleted file mode 100644 index a5f690ae3523..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Using issues -intro: 'Learn about using issues in your repositories.' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -children: - - /creating-an-issue - - /adding-sub-issues - - /creating-issue-dependencies - - /assigning-issues-and-pull-requests-to-other-github-users - - /editing-an-issue - - /viewing-all-of-your-issues-and-pull-requests - - /browsing-sub-issues - - /filtering-and-searching-issues-and-pull-requests - - /creating-a-branch-for-an-issue - - /linking-a-pull-request-to-an-issue - - /about-slash-commands - - /managing-issue-types-in-an-organization - - /managing-issue-fields-in-your-organization - - /adding-and-managing-issue-fields ---- diff --git a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md deleted file mode 100644 index 48f0333b521b..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Linking a pull request to an issue -intro: 'You can link a pull request or branch to an issue to show that a fix is in progress and to automatically close the issue when the pull request or branch is merged.' -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/linking-a-pull-request-to-an-issue - - /articles/closing-issues-via-commit-message - - /articles/closing-issues-via-commit-messages - - /articles/closing-issues-using-keywords - - /github/managing-your-work-on-github/closing-issues-using-keywords - - /github/managing-your-work-on-github/linking-a-pull-request-to-an-issue - - /issues/tracking-your-work-with-issues/creating-issues/linking-a-pull-request-to-an-issue - - /issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Link PR to issue -category: - - Create and work with issues ---- - -## About linked issues and pull requests - -You can link an issue to a pull request manually or using a supported keyword in the pull request description, that is, the summary text added by the author when they created the pull request. - -When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. - -When you merge a linked pull request into the **default branch** of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). - -> [!NOTE] -> The special keywords in a pull request description are interpreted only when the pull request targets the repository's _default_ branch. If the pull request targets _any other branch_, then these keywords are ignored, no links are created, and merging the PR has no effect on the issues. - -## Linking a pull request to an issue using a keyword - -You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request **must be** on the default branch. - -* `close` -* `closes` -* `closed` -* `fix` -* `fixes` -* `fixed` -* `resolve` -* `resolves` -* `resolved` - -If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request. - -The syntax for closing keywords depends on whether the issue is in the same repository as the pull request. - -Linked issue | Syntax | Example ---------------- | ------ | ------ -Issue in the same repository | KEYWORD #ISSUE-NUMBER | `Closes #10` -Issue in a different repository | KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER | `Fixes octo-org/octo-repo#100` -Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` - -The keywords can be followed by colons or in uppercase. For example: `Closes: #10`, `CLOSES #10`, or `CLOSES: #10`. - -Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword. - -You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request. - -## Manually linking a pull request to an issue using the pull request sidebar - -Anyone with write permissions to a repository can manually link a pull request to an issue from the pull request sidebar. - -You can manually link up to ten issues to each pull request. The issue and pull request must be in the same repository. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-pr %} -1. In the list of pull requests, click the pull request that you'd like to link to an issue. -{% data reusables.pull_requests.click-development-in-pull-request %} -1. Click the issue you want to link to the pull request. - -## Manually linking a pull request or branch to an issue using the issue sidebar - -Anyone with write permissions to a repository can manually link a pull request or branch to an issue from the issue sidebar. - -You can manually link up to ten issues to each pull request. The issue can be in a different repository than the linked pull request or branch. Your last selected repository will be remembered. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issues %} -1. In the list of issues, click the issue that you'd like to link a pull request or branch to. -{% data reusables.pull_requests.click-development-in-issue %} -1. Click the repository containing the pull request or branch you want to link to the issue. -1. Click the pull request or branch you want to link to the issue. -1. Click **Apply**. - -## Further reading - -* [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md b/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md deleted file mode 100644 index a88c04b63e0f..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: Managing issue fields in your organization -intro: 'You can create and manage custom issue fields to collect structured metadata across all issues in your organization.' -redirect_from: - - /issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization -versions: - feature: issue-fields -contentType: concepts -shortTitle: 'Managing issue fields' -permissions: 'Organization owners can create and manage issue fields.' -category: - - Triage and organize issues ---- - -{% data reusables.issues.issue-fields-public-preview-note %} - -Issue fields let you add structured metadata to issues across your organization. Instead of relying on labels or free-text workarounds, you can create fields like priority, effort, impact, or any custom category your team needs. Fields are defined at the organization level and apply across all repositories in your organization. - -## About issue field types - -You can create up to 25 issue fields per organization. The following field types are available: - -* **Single-select**: choose one option from a predefined list. Options can have names, descriptions, and colors. -* **Text**: capture free-form text. URLs are automatically detected and displayed as clickable links. -* **Number**: accept numeric input, including decimals. -* **Date**: provide a date picker for selecting dates. - -## Default fields - -When issue fields are enabled for your organization, four default fields are created automatically: - -* **Priority** (single-select): Urgent, High, Medium, Low -* **Effort** (single-select): High, Medium, Low -* **Start date** (date) -* **Target date** (date) - -These default fields are fully customizable. You can edit their names, descriptions, and options, or delete them if they don't fit your workflow. - -## Creating an issue field - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Planning" section of the sidebar, click **Issue fields**. -1. Click **New field**. -1. Under "Field name", type the name of your new field. -1. Optionally, under "Description", type a description to help others understand the purpose of the field. -1. Under "Field type", select the type of field you want to create. -1. If you selected **Single-select**, add options for the field: - * Click **Add option** and type the option name. - * Optionally, to set a color for an option, click {% octicon "kebab-horizontal" aria-label="open option menu" %} next to the option, click **Edit option**, choose a color, and click **Save**. - * Repeat to add more options. -1. Under "Field Visibility", choose one of the following: - * **Permissions**: choose who can see the field and its value. Options are **Organization only** (default) or **Public**. This setting only applies to issues in public repositories. - * **Pin to types**: click {% octicon "pencil" aria-label="edit pinning" %} to choose which issue types show this field in the issue viewer and creator. Select one or more issue types, or "Issues without a type". Fields that are not pinned and have no value will stay hidden in the issue viewer and creator. -1. Click **Create**. - -## Editing an issue field - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Planning" section of the sidebar, click **Issue fields**. -1. To the right of the field you want to edit, click {% octicon "kebab-horizontal" aria-label="open field options" %}. -1. Click **Edit** and make your changes. -1. Click **Save field**. - -## Deleting an issue field - -When you delete an issue field, all values set on issues for that field are permanently removed. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Planning" section of the sidebar, click **Issue fields**. -1. To the right of the field you want to delete, click {% octicon "kebab-horizontal" aria-label="open field options" %}. -1. Click **Delete** and confirm the deletion. - -## Reordering issue fields - -The order of pinned fields is managed per issue type. The field order determines how fields appear in the issue sidebar and the issue creation modal. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Planning" section of the sidebar, click **Issue types**. -1. Click the issue type you want to reorder fields for. -1. Under "Pinned issue fields", drag fields to reorder them. -1. Click **Save**. - -## Pinning fields to issue types - -You can associate issue fields with specific issue types so that only the most relevant fields appear when creating or viewing issues of that type. For example, you can pin "Severity" to bugs and "Impact" to features. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Planning" section of the sidebar, click **Issue fields**. -1. Click the field you want to pin. -1. Under "Pin to types", click {% octicon "pencil" aria-label="edit pinning" %} and select the issue types this field should appear on. -1. Click **Save field**. - -Pinned fields automatically appear in the issue sidebar based on the selected issue type. To pin fields to issues that have no type, select the "Issues without a type" option. - -> [!NOTE] -> Fields must be pinned to at least one issue type, or to "Issues without a type", to appear in the issue sidebar. Fields that are not pinned to any type are only accessible via the **Add field** button or in projects. - -## Setting field visibility - -For organizations with public repositories, you can control whether each issue field is visible to everyone or only to organization members and collaborators. - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Planning" section of the sidebar, click **Issue fields**. -1. To the right of the field, click {% octicon "kebab-horizontal" aria-label="open field options" %}. -1. Click **Edit**. -1. Under "Field Visibility", choose one of the following: - * **Organization only**: the field is visible only to organization members and repository collaborators with at least read access. - * **Public**: the field is visible to anyone viewing the issue. -1. Click **Save**. - -By default, all new and existing fields are set to "Organization only". Visibility settings are enforced across the web UI, API, issue timeline events, and search suggestions. - -## Issue fields and projects - -Issue fields are available in any project across your organization. For details on adding, removing, and editing issue fields in projects, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields#using-issue-fields-in-projects). - -### Field limits in projects - -Projects support up to 50 fields in total, and issue fields and system fields count toward this limit. If a project is already at the field limit, you need to remove existing fields before issue fields can be added. - -## Limits - -| Resource | Limit | -|----------|-------| -| Issue fields per organization | 25 | -| Options per single-select field | 50 | -| Pinned fields per issue type | 10 | -| Total fields in a project (including issue fields and system fields) | 50 | diff --git a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md b/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md deleted file mode 100644 index 2c7341334cdc..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Managing issue types in an organization -intro: Learn about issue types and how to manage them in your organization. -redirect_from: - - /issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization -versions: - feature: issue-types -shortTitle: Managing issue types -permissions: Organization owners can modify issue types. -contentType: concepts -category: - - Triage and organize issues ---- - -You can use issue types to classify and manage different types of issues across your organization. You can create up to {% data variables.projects.issue_type_limit %} issue types that your organization members can apply to issues, making it easier for you and your members to find issues and plan work. - -Default issue types are included in every organization, but these can edited, disabled, or deleted. The default types are task, bug, and feature. - -When you add an issue type to an issue, the type will be shown on any lists of issues and in the issues themselves. You can filter and search by issue type and use issue types when creating filters and views in your projects. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#filtering-by-issue-type) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects#filtering-by-issue-type). - -## Adding an issue type - -{% data reusables.issues.access-issue-types-settings %} -1. On the right side of the page, click **Create new type**. -1. Under "Type name", type the name of your new issue type. -1. Under "Description", to help other people understand the purpose of your new issue type, type a description. -1. Under "Color", click on the color you would like for the new issue type. -1. Click **Create**. - -## Making changes to issue types - -You can change the name, description, and color of your issue types. - -You can also choose to disable or delete an issue type. If you disable an issue type, it will not be shown and it won't be possible to set an issue to that type, but if you later decide to enable the issue type, it will be displayed again on any issues previously set to the issue type. If you delete an issue type, it is permanently removed. - -{% data reusables.issues.access-issue-types-settings %} -1. To the right of the issue type you want to make changes to, click {% octicon "kebab-horizontal" aria-label="open type options" %}. - - ![Screenshot of the issue types settings page for an organization. The "open type options" button is highlighted with an orange rectangle.](/assets/images/help/issues/issue-type-edit.png) - -1. In the menu, click **Edit** and make your changes. - * To make changes to the type name, description, or color, click **Save**. - * To disable or delete the issue type, in the "Danger zone", click **Disable** or **Delete** and follow the prompts. diff --git a/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md deleted file mode 100644 index 05603edbfb1a..000000000000 --- a/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Viewing all issues and pull requests -intro: The Issues and Pull Request dashboards list the open issues and pull requests you've created{% ifversion issues-saved-views %}, as well as your saved views{% endif %}. You can use them to update items that have gone stale, close them, or keep track of where you've been mentioned across all repositories—including those you're not subscribed to. -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/viewing-all-of-your-issues-and-pull-requests - - /articles/viewing-all-of-your-issues-and-pull-requests - - /github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests - - /issues/tracking-your-work-with-issues/managing-issues/viewing-all-of-your-issues-and-pull-requests - - /issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: View all issues & PRs -contentType: how-tos -category: - - Create and work with issues ---- - -## Viewing your issues and pull requests - -Your issue and pull request dashboards are available at the top of any page. On each dashboard, you can filter the list to find issues or pull requests you created, that are assigned to you, or in which you're mentioned. You can also find pull requests that you've been asked to review. - -1. At the top of any page, click **{% octicon "issue-opened" aria-label="Issues" %}** to see your issues or **{% octicon "git-pull-request" aria-label="Pull requests" %}** to see your pull requests. - - ![Screenshot of the header of any page on {% data variables.product.github %}. The "Pull requests" and "Issues" icons are outlined in dark orange.](/assets/images/help/navigation/issues-and-prs-new-navigation.png) - -1. Optionally, choose a filter or use the search bar to filter for more specific results. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests). - -{% ifversion issues-saved-views %} - -## Tracking issues and pull requests with saved views - -To help you better monitor and find issues and pull requests across multiple repositories, you can create saved views on the issues dashboard. - -You can create up to 25 saved views. - -### Create a saved view - -1. At the top of any page, click {% octicon "issue-opened" aria-label="Issues" %} to see your issues. -1. On the left sidebar, to the right of "Views", click **{% octicon "plus" aria-label="Create view" %}**. -1. Add a title, description, and custom icon for your view. -1. Under "Query", build your search query using the advanced filters. For help using filters, see [AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests). - > [!TIP] Use the `is:pr` filter to include pull requests in the saved view. -1. Click **Save view**. - -### Edit, duplicate or delete a saved view - -1. At the top of any page, click {% octicon "issue-opened" aria-label="Issues" %} to see your issues. -1. On the left sidebar, under "Views", click the saved view you want to edit, duplicate or delete. -1. To the right of the name of the saved view, click **{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.**. -1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Edit** to modify the view, **{% octicon "duplicate" aria-hidden="true" aria-label="duplicate" %} Duplicate** to create a copy of the view, or **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete** to remove the view. - -{% endif %} - -## Further reading - -* [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions#reviewing-repositories-that-youre-watching) diff --git a/content/issues/using-labels-and-milestones-to-track-work/about-milestones.md b/content/issues/using-labels-and-milestones-to-track-work/about-milestones.md deleted file mode 100644 index 6653f6a8ce3f..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/about-milestones.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: About milestones -intro: You can use milestones to track progress on groups of issues or pull requests in a repository. -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/about-milestones - - /articles/about-milestones - - /github/managing-your-work-on-github/about-milestones -versions: - fpt: '*' - ghes: '*' - ghec: '*' -category: - - Triage and organize issues ---- -When you [create a milestone](/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests), you can [associate it with issues and pull requests](/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests). - -To better manage your project, you can [view details about your milestone](/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress). From the milestone page, you can see: - -* A user-provided description of the milestone, which can include information like a project overview, relevant teams, and projected due dates -* The milestone's due date -* The milestone's completion percentage -* The number of open and closed issues and pull requests associated with the milestone -* A list of the open and closed issues and pull requests associated with the milestone - -Additionally, you can edit the milestone from the milestone page and create new issues that are, by default, associated with the milestone. - -## Prioritizing issues and pull requests in milestones - -You can prioritize open issues and pull requests in a milestone by clicking to the left of an issue or pull request's checkbox, dragging it to a new location, and dropping it. - -> [!NOTE] -> If there are more than 500 open issues in a milestone, you won't be able to prioritize issues. diff --git a/content/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests.md b/content/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests.md deleted file mode 100644 index b5f85bebfa48..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Associating milestones with issues and pull requests -intro: You can associate similar issues and pull requests with a milestone to better track their progress. -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/associating-milestones-with-issues-and-pull-requests - - /articles/associating-milestones-with-issues-and-pull-requests - - /github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Add to milestones -category: - - Triage and organize issues ---- -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Select the checkbox next to the items you want associated with a milestone. - - ![Screenshot of the first two items in a list of issues. To the left of each issue, a checkbox is checked and outlined in dark orange.](/assets/images/help/issues/issues-assign-checkbox.png) -1. Above the list of issues or pull requests, select the **Milestone** dropdown menu. - - ![Screenshot of the list of issues for a repository. In the header above the list, a dropdown menu, labeled "Milestones," is outlined in dark orange.](/assets/images/help/issues/issues-assigning-milestone-dropdown.png) -1. In the "Filter milestones" field, start typing the name of an existing milestone, then click the milestone's name to associate it with the item. - -> [!TIP] -> As you're working on issues and pull requests, you can [track the progress of your milestone](/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress). - -## Further reading - -* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone) diff --git a/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md b/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md deleted file mode 100644 index 3ef6bf7fd062..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Creating and editing milestones for issues and pull requests -intro: You can create a milestone to track progress on groups of issues or pull requests in a repository. -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/creating-and-editing-milestones-for-issues-and-pull-requests - - /articles/creating-milestones-for-issues-and-pull-requests - - /articles/creating-and-editing-milestones-for-issues-and-pull-requests - - /github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Create & edit milestones -contentType: how-tos -category: - - Triage and organize issues ---- -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.milestones %} -1. Choose one of these options: - * To create a new milestone, click **New Milestone**. - * To edit a milestone, next to the milestone you want to edit, click **Edit**. - - ![Screenshot of the list of milestones. Within the entry for the "beta release" milestone, a link, labeled "Edit," is outlined in dark orange.](/assets/images/help/repository/edit-milestone.png) -1. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). - -## Deleting milestones - -When you delete milestones, issues and pull requests are not affected. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.milestones %} -1. Next to the milestone you want to delete, click **Delete**. - -![Screenshot of the list of milestones for a repository. Within the entry for the "beta release" milestone, a red "Delete" link is outlined in orange.](/assets/images/help/repository/delete-milestone.png) diff --git a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md deleted file mode 100644 index 65743effd3d8..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Filtering issues and pull requests by milestone -intro: 'Issues and pull requests can be filtered based on the milestone they''re associated with. Once you''ve [associated an issue or pull request with a milestone](/articles/associating-milestones-with-issues-and-pull-requests), you can find items based on their milestones. Within a milestone, you can prioritize issues and pull requests.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/filtering-issues-and-pull-requests-by-milestone - - /articles/filtering-issues-and-pull-requests-by-milestone - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: Filter by milestone -category: - - Triage and organize issues ---- - -> [!TIP] -> * If you'd rather filter issues and pull requests using the Search bar, you can use the milestone search syntax. For a milestone called My Milestone, the search syntax would be: `milestone:"My Milestone"`. -> * To clear your filter selection, click **Clear current search query, filters, and sorts**. -> * You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see [`gh issue list`](https://cli.github.com/manual/gh_issue_list) or [`gh pr list`](https://cli.github.com/manual/gh_pr_list) in the {% data variables.product.prodname_cli %} documentation. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. Select **Milestones** to see a list of all available milestones for the repository. - - ![Screenshot of the list of issues for a repository. Above the list, a "Milestones" button with a signpost icon and "Milestones," is outlined in orange.](/assets/images/help/issues/issues-milestone-button.png) -1. Select the milestone you're interested in from the list. You can view relevant information for the milestone, including all issues and pull requests associated with it, from the milestone page. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests){% ifversion projects-v1 %} -* [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board){% endif %} diff --git a/content/issues/using-labels-and-milestones-to-track-work/index.md b/content/issues/using-labels-and-milestones-to-track-work/index.md deleted file mode 100644 index eae8ef72dc2a..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Using labels and milestones to track work -shortTitle: Labels and milestones -intro: 'Use labels and milestones to categorize and track work on {% data variables.product.prodname_dotcom %}.' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -children: - - /managing-labels - - /about-milestones - - /creating-and-editing-milestones-for-issues-and-pull-requests - - /associating-milestones-with-issues-and-pull-requests - - /filtering-issues-and-pull-requests-by-milestone - - /viewing-your-milestones-progress -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones ---- - diff --git a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md deleted file mode 100644 index 334d1fee855b..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: Managing labels -intro: You can classify {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %} by creating, editing, applying, and deleting labels. -permissions: '{% data reusables.enterprise-accounts.emu-permission-repo %}' -redirect_from: - - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/managing-labels - - /articles/managing-Labels - - /articles/labeling-issues-and-pull-requests - - /github/managing-your-work-on-github/labeling-issues-and-pull-requests - - /articles/about-labels - - /github/managing-your-work-on-github/about-labels - - /articles/creating-and-editing-labels-for-issues-and-pull-requests - - /articles/creating-a-label - - /github/managing-your-work-on-github/creating-a-label - - /articles/customizing-issue-labels - - /articles/applying-labels-to-issues-and-pull-requests - - /github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests - - /articles/editing-a-label - - /github/managing-your-work-on-github/editing-a-label - - /articles/deleting-a-label - - /github/managing-your-work-on-github/deleting-a-label - - /github/managing-your-work-on-github/managing-labels -versions: - fpt: '*' - ghes: '*' - ghec: '*' -contentType: how-tos -category: - - Triage and organize issues ---- -## About labels - -You can manage your work on {% data variables.product.github %} by creating labels to categorize {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %}. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} within that repository. Addition, modification, or deletion of labels in one repository has no effect on labels belonging to other repositories. - -## About default labels - -{% data variables.product.github %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository. - -Label | Description ---- | --- -`bug` | Indicates an unexpected problem or unintended behavior -`documentation` | Indicates a need for improvements or additions to documentation -`duplicate` | Indicates similar {% ifversion fpt or ghec %}issues, pull requests, or discussions{% else %}issues or pull requests{% endif %} -`enhancement` | Indicates new feature requests -`good first issue` | Indicates a good issue for first-time contributors -`help wanted` | Indicates that a maintainer wants help on an issue or pull request -`invalid` | Indicates that an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} is no longer relevant -`question` | Indicates that an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} needs more information -`wontfix` | Indicates that work won't continue on an {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} - -Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. - -Issues with the `good first issue` label are used to populate the repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). - -Organization owners can customize the default labels for repositories in their organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization). - -## Creating a label - -Anyone with write access to a repository can create a label. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.labels %} -1. To the right of the search field, click **New label**. -{% data reusables.project-management.name-label %} -{% data reusables.project-management.label-description %} -{% data reusables.project-management.label-color-randomizer %} -{% data reusables.project-management.create-label %} - -## Applying a label - -Anyone with triage access to a repository can apply and dismiss labels. - -1. Navigate to the {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %}. -1. In the right sidebar, click **Labels**, then click a label. - -## Editing a label - -Anyone with write access to a repository can edit existing labels. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.labels %} -{% data reusables.project-management.edit-label %} -{% data reusables.project-management.name-label %} -{% data reusables.project-management.label-description %} -{% data reusables.project-management.label-color-randomizer %} -{% data reusables.project-management.save-label %} - -## Deleting a label - -Anyone with write access to a repository can delete existing labels. - -Deleting a label will remove the label from issues and pull requests. - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.labels %} -{% data reusables.project-management.delete-label %} - -## Further reading - -* [AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests) -* [AUTOTITLE](/organizations/managing-organization-settings/managing-default-labels-for-repositories-in-your-organization){% ifversion fpt or ghec %} -* [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels){% endif %} -* [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#using-emoji) diff --git a/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md b/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md deleted file mode 100644 index e74a57d7371b..000000000000 --- a/content/issues/using-labels-and-milestones-to-track-work/viewing-your-milestones-progress.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Viewing your milestone's progress -intro: 'In order to track your milestones, you''ll want to get a better understanding of how many open issues and pull requests are remaining.' -redirect_from: - - /github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones/viewing-your-milestones-progress - - /articles/viewing-your-milestone-s-progress - - /articles/viewing-your-milestones-progress - - /github/managing-your-work-on-github/viewing-your-milestones-progress -versions: - fpt: '*' - ghes: '*' - ghec: '*' -shortTitle: View progress to milestone -category: - - Triage and organize issues ---- -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. In the upper-right corner, click **Milestones**. - - ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in orange.](/assets/images/help/issues/issues-milestone-button.png) -1. Click the milestone you wish to see more information about. - -To better manage your project, you can prioritize issues or pull requests within a milestone. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones#prioritizing-issues-and-pull-requests-in-milestones). - -## Further reading - -* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests) -* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone)