Skip to content

Commit 733aa4a

Browse files
[Improvement]: Remove duplicate sections on issues docs and misc improvements (#57278)
1 parent 48825da commit 733aa4a

File tree

6 files changed

+16
-21
lines changed

6 files changed

+16
-21
lines changed

content/issues/guides.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ includeGuides:
1717
- /issues/planning-and-tracking-with-projects/creating-projects/creating-a-project
1818
- /issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization
1919
- /issues/tracking-your-work-with-issues/using-issues/adding-sub-issues
20+
- /issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies
2021
- /issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests
2122
- /issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests
2223
- /issues/using-labels-and-milestones-to-track-work/managing-labels

content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@ Issues and pull requests include built-in features to let you easily communicate
2525

2626
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.
2727

28-
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).
29-
30-
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).
31-
3228
{% ifversion sub-issues %}
3329

3430
{% 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).
@@ -41,6 +37,10 @@ You can also use issue types to classify work in repositories across the organiz
4137

4238
{% endif %}
4339

40+
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).
41+
42+
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).
43+
4444
## Make use of the description, README, and status updates to share information about a project
4545

4646
Use your project's description and README to share information about the project.

content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ Issues can be created in a variety of ways, so you can choose the most convenien
4040

4141
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).
4242

43+
## Metadata on issues
44+
45+
You can add metadata to your issues, including {% ifversion issue-types %}issue types, {% endif %}labels and milestones to organize your issues.
46+
47+
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).
48+
4349
## About integration with {% data variables.product.github %}
4450

4551
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).
@@ -66,20 +72,6 @@ You can @mention collaborators who have access to your repository in an issue to
6672
{% 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).
6773
{% endif %}
6874

69-
## Metadata on issues
70-
71-
You can add metadata to your issues, including {% ifversion issue-types %}issue types, {% endif %}labels and milestones to organize your issues.
72-
73-
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).
74-
75-
{% ifversion sub-issues %}
76-
77-
## About sub-issues
78-
79-
{% 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).
80-
81-
{% endif %}
82-
8375
## Comparing issues and discussions
8476

8577
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).

content/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Below is an example of a `front-end` label that we created and added to the issu
113113

114114
![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)
115115

116-
### Showing which issues are blocked by, or blocking, other work
116+
## Showing which issues are blocked by, or blocking, other work
117117

118118
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).
119119

content/issues/tracking-your-work-with-issues/learning-about-issues/quickstart.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ Click **Submit new issue** to create your issue. You can edit any of the above f
9898

9999
{% endif %}
100100

101+
## Adding issue dependencies
102+
103+
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).
104+
101105
## Communicating
102106

103107
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).

content/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ permissions: 'People with at least triage permissions for a repository can creat
1111
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.'
1212
---
1313

14-
{% data reusables.issues.issue-dependencies-preview-note %}
15-
1614
Issue dependencies let you define issues that are blocked by, or blocking, other work.
1715

1816
## Marking an issue as blocked by, or blocking, another issue

0 commit comments

Comments
 (0)