From 42a172bd014b2a8dced8f8355781b2a0f0d8abae Mon Sep 17 00:00:00 2001 From: Laura Coursen Date: Tue, 31 Jan 2023 09:49:44 -0600 Subject: [PATCH] Fix articles that don't start with an H2 (#34278) --- .../viewing-workflow-run-history.md | 4 +-- ...lign-on-your-rollout-strategy-and-goals.md | 26 +++++++------- ...phase-5-rollout-and-scale-code-scanning.md | 6 ++-- ...ase-6-rollout-and-scale-secret-scanning.md | 34 +++++++++---------- ...ng-from-the-codeql-runner-to-codeql-cli.md | 2 -- ...-setting-up-github-copilot-for-business.md | 6 ++-- .../get-started/quickstart/github-glossary.md | 4 +-- .../filtering-projects.md | 28 +++++++-------- .../adding-items-to-your-project.md | 28 +++++++-------- .../about-tracks-and-tracked-by-fields.md | 19 +++++------ .../about-insights-for-projects.md | 14 ++++---- .../about-packaging-and-actions.md | 8 ++--- 12 files changed, 88 insertions(+), 91 deletions(-) diff --git a/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md b/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md index b6b21681fe35..2b0ffbf05485 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md @@ -29,7 +29,7 @@ versions: {% data reusables.cli.cli-learn-more %} -### Viewing recent workflow runs +## Viewing recent workflow runs To list the recent workflow runs, use the `run list` subcommand. @@ -49,7 +49,7 @@ To only return runs for the specified workflow, you can use the `-w` or `--workf gh run list --workflow WORKFLOW ``` -### Viewing details for a specific workflow run +## Viewing details for a specific workflow run To display details for a specific workflow run, use the `run view` subcommand. Replace `run-id` with the ID of the run that you want to view. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run. diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md index 39723e911eee..7bc0c36a59a3 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md @@ -17,7 +17,7 @@ This article is part of a series on adopting {% data variables.product.prodname_ {% endnote %} -### Set clear goals for your company’s rollout +## Set clear goals for your company’s rollout To build a foundation for the direction of your company's rollout, outline goals for GHAS within your company, and communicate those goals to your team. Your goals can be simple or complex, as long as your team is aligned. If you need assistance with your goals, {% data variables.product.prodname_professional_services %} can provide recommendations based on our experience with your company and other customers. @@ -25,42 +25,42 @@ Here are some high-level examples of what your goals for rolling out GHAS might - **Reducing the number of vulnerabilities**: This may be in general, or because your company was recently impacted by a significant vulnerability that you believe could have been prevented by a tool like GHAS. - **Identifying high-risk repositories**: Some companies simply want to target repositories that contain the most risk, enabling them to reduce risk by remediating vulnerabilities. - - **Increasing remediation rates**: To prevent the accumulation of security debt, you may wish to drive developer adoption of findings and ensure these vulnerabilities are remediated in a timely manner. + - **Increasing remediation rates**: To prevent the accumulation of security debt, you may wish to drive developer adoption of findings and ensure these vulnerabilities are remediated in a timely manner. - **Meeting compliance requirements**: For example, many healthcare companies use GHAS to prevent the exposure of PHI (Personal Health Information). - **Preventing secrets leakage**: Many companies want to prevent critical information from being leaked, such as software keys or financial data. -### Lead your rollout with both your security and development groups +## Lead your rollout with both your security and development groups -Companies that involve both their security and development teams in their GHAS rollouts tend to be more successful than companies who only involve their security group, waiting to include development teams once the pilot has concluded. +Companies that involve both their security and development teams in their GHAS rollouts tend to be more successful than companies who only involve their security group, waiting to include development teams once the pilot has concluded. GHAS takes a developer-centered approach to software security by integrating seamlessly into the developer workflow. Having key representation from your development group early in the process decreases the risk of your rollout and encourages organizational buy-in. -Involving development groups earlier, ideally from the time of purchase, helps companies utilize GHAS to address security concerns earlier in the development process. When both groups work together, they achieve alignment early in the process, remove silos, build and strengthen their working relationships, and take more responsibility for the rollout. +Involving development groups earlier, ideally from the time of purchase, helps companies utilize GHAS to address security concerns earlier in the development process. When both groups work together, they achieve alignment early in the process, remove silos, build and strengthen their working relationships, and take more responsibility for the rollout. -### Learn about GHAS +## Learn about GHAS To set realistic expectations for the rollout, ensure that all stakeholders understand the following key facts about how GHAS works. -#### 1. GHAS is a suite of security tools that require action to protect your code +### 1. GHAS is a suite of security tools that require action to protect your code -GHAS is a suite of tools that increases with value when configured, maintained, used in daily workflows, and in combination with other tools. +GHAS is a suite of tools that increases with value when configured, maintained, used in daily workflows, and in combination with other tools. -#### 2. GHAS will require adjustment out of the box +### 2. GHAS will require adjustment out of the box After GHAS is set up on your repositories, you'll need to configure GHAS to meet your company’s needs. Code scanning in particular requires further customization, such as evaluating initial results and making adjustments for future scans. Many customers find that initial scans return limited or irrelevant results until code scanning is adjusted based on the application's threat model. -#### 3. GHAS tools are most effective when used together and integrated into your application security program +### 3. GHAS tools are most effective when used together and integrated into your application security program GHAS is most effective when all of the tools are used together. The effectiveness of your application security program is further improved by integrating GHAS with other tools and activities, such as penetration testing and dynamic scans. We recommend always utilizing multiple layers of protection. -#### 4. Custom {% data variables.product.prodname_codeql %} queries are used by some companies to customize and target scan results +### 4. Custom {% data variables.product.prodname_codeql %} queries are used by some companies to customize and target scan results Code scanning is powered by {% data variables.product.prodname_codeql %}, the world’s most powerful code analysis engine. For many of our customers, the base query set and additional queries available in the community are more than sufficient. However, other companies may require custom {% data variables.product.prodname_codeql %} queries to target different results or reduce false positives. -If your company is interested in custom {% data variables.product.prodname_codeql %} queries, we recommend completing your rollout and implementation of GHAS first. Then, when your company is ready, {% data variables.product.prodname_professional_services %} can help you navigate your requirements and ensure your company needs custom queries. +If your company is interested in custom {% data variables.product.prodname_codeql %} queries, we recommend completing your rollout and implementation of GHAS first. Then, when your company is ready, {% data variables.product.prodname_professional_services %} can help you navigate your requirements and ensure your company needs custom queries. -#### 5. {% data variables.product.prodname_codeql %} scans the whole codebase, not just the changes made in a pull request +### 5. {% data variables.product.prodname_codeql %} scans the whole codebase, not just the changes made in a pull request When code scanning is run from a pull request, the scan will include the full codebase and not just the changes made in the pull request. Scanning the entire codebase is an important step to ensure the change has been reviewed against all interactions in the codebase. diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md index dc00c69fa4b2..877a5a7de175 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md @@ -17,7 +17,7 @@ This article is part of a series on adopting {% data variables.product.prodname_ {% endnote %} -### Enabling code scanning +## Enabling code scanning Using the data you collated in [Phase 2](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale), you can begin to enable GHAS and then {% data variables.product.prodname_code_scanning %} on your repositories, one language at a time. The step-by-step process for enabling GHAS should look like this: @@ -33,11 +33,11 @@ There is a publicly available tool that completes the first two steps called the {% endnote %} -It is important to not just push the `codeql-analysis.yml` file the repository's default branch. Using a pull request puts ownership on the development team to review and merge, allowing the development team to learn about {% data variables.product.prodname_code_scanning %} and involving the team in the process. +It is important to not just push the `codeql-analysis.yml` file the repository's default branch. Using a pull request puts ownership on the development team to review and merge, allowing the development team to learn about {% data variables.product.prodname_code_scanning %} and involving the team in the process. You should capture the pull request URLs created by automation, and check each week for any activity and see which ones are closed. After a few weeks, it may be worth creating another issue or sending internal emails if the pull request remains unmerged. -### Creating subject matter experts +## Creating subject matter experts You can then proceed to the next stage of enablement, which is creating internal subject matter experts (or SMEs) and arranging company meetings. Opening pull requests and issues in repositories will likely tackle a large percentage of your adoption, but this doesn’t tackle one-off use cases where a specific build process, framework, or library needs specific feature flags to be enabled. A more personalized and hands-on approach is required to push high adoption, especially for Java, C, and C++. diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index 7cf84a8886a8..9a9326a20ebb 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -19,9 +19,9 @@ This article is part of a series on adopting {% data variables.product.prodname_ You can enable secret scanning for individual repositories or for all repositories in an organization. For more information, see "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." -This article explains a high-level process focusing on enabling {% data variables.product.prodname_secret_scanning %} for all repositories in an organization. The principles described in this article can still be applied even if you take a more staggered approach of enabling {% data variables.product.prodname_secret_scanning %} for individual repositories. +This article explains a high-level process focusing on enabling {% data variables.product.prodname_secret_scanning %} for all repositories in an organization. The principles described in this article can still be applied even if you take a more staggered approach of enabling {% data variables.product.prodname_secret_scanning %} for individual repositories. -### 1. Focus on newly committed secrets +## 1. Focus on newly committed secrets When you enable {% data variables.product.prodname_secret_scanning %}, you should focus on remediating any newly committed credentials detected by secret scanning. If you focus on cleaning up committed credentials, developers could continue to accidentally push new credentials, which means your total secret count will stay around the same level, not decrease as intended. This is why it is essential to stop new credentials being leaked before focusing on revoking any current secrets. @@ -31,10 +31,10 @@ There are a few approaches for tackling newly committed credentials, but one exa 2. **Follow Up**: Create a high-level remediation process that works for all secret types. For example, you could contact the developer who committed the secret and their technical lead on that project, highlighting the dangers of committing secrets to GitHub, and asking the them to revoke, and update the detected secret. {% note %} - + **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. - - {% endnote %} + + {% endnote %} 3. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. Repeat the last two steps for any new secrets leaked. This process encourages developers to take responsibility for managing the secrets used in their code securely, and allows you to measure the reduction in newly committed secrets. @@ -45,7 +45,7 @@ Repeat the last two steps for any new secrets leaked. This process encourages de {% endnote %} -### 2. Remediate previously committed secrets, starting with the most critical +## 2. Remediate previously committed secrets, starting with the most critical After you have established a process to monitor, notify and remediate newly published secrets, you can start work on secrets committed before {% data variables.product.prodname_GH_advanced_security %} was introduced. @@ -54,38 +54,38 @@ How you define your most critical secrets will depend on your organization's pro Once you have decided on the secret types, you can do the following: 1. Define a process for remediating each type of secret. The actual procedure for each secret type is often drastically different. Write down the process for each type of secret in a document or internal knowledge base. - + {% note %} - + **Note:** When you create the process for revoking secrets, try and give the responsibility for revoking secrets to the team maintaining the repository instead of a central team. One of the principles of GHAS is developers taking ownership of security and having the responsibility of fixing security issues, especially if they have created them. {% endnote %} 2. When you have created the process that teams will follow for revoking credentials, you can collate information about the types of secrets and other metadata associated with the leaked secrets so you can discern who to communicate the new process to. - + {% ifversion not ghae %} - + You can use the security overview to collect this information. For more information about using the security overview, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)." - + {% endif %} - + Some information you may want to collect includes: - + - Organization - Repository - Secret type - Secret value - Maintainers on repository to contact - + {% note %} - + **Note:** Use the UI if you have few secrets leaked of that type. If you have hundreds of leaked secrets, use the API to collect information. For more information, see "[Secret scanning REST API](/rest/reference/secret-scanning)." - + {% endnote %} 3. After you collect information about leaked secrets, create a targeted communication plan for the users who maintain the repositories affected by each secret type. You could use email, messaging, or even create GitHub issues in the affected repositories. If you can use APIs provided by these tools to send out the communications in an automated manner, this will make it easier for you to scale across multiple secret types. -### 3. Expand the program to include more secret types and custom patterns +## 3. Expand the program to include more secret types and custom patterns You can now expand beyond the five most critical secret types into a more comprehensive list, with an additional focus on education. You can repeat the previous step, remediating previously committed secrets, for the different secret types you have targeted. diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md index a2d8162af9ea..3adc4d4277b6 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli.md @@ -14,8 +14,6 @@ topics: - CodeQL --- -# Migrating from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %} - The {% data variables.code-scanning.codeql_runner %} is being deprecated. You can use the {% data variables.product.prodname_codeql_cli %} version 2.6.2 and greater instead. This document describes how to migrate common workflows from the {% data variables.code-scanning.codeql_runner %} to the {% data variables.product.prodname_codeql_cli %}. diff --git a/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md b/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md index c0a3affc46db..2dd1f427fe51 100644 --- a/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md +++ b/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md @@ -12,7 +12,7 @@ shortTitle: Enabling GitHub Copilot for Business {% data reusables.copilot.enabling-github-copilot-for-business %} -### Enabling {% data variables.product.prodname_copilot_for_business %} for your enterprise +## Enabling {% data variables.product.prodname_copilot_for_business %} for your enterprise {% note %} @@ -26,11 +26,11 @@ Your enterprise owner can enable {% data variables.product.prodname_copilot_for_ {% data variables.product.prodname_copilot %} includes a filter which detects code suggestions matching public code on {% data variables.product.prodname_dotcom %}. Your enterprise owner can choose whether to enable or disable the filter at the enterprise-level, or allow organization administrators to decide at the organization-level. For more information, see "[Enforcing a policy to manage the use of {% data variables.product.prodname_copilot %} suggestions that match public code in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-suggestions-that-match-public-code-in-your-enterprise)." -### Configuring {% data variables.product.prodname_copilot %} settings in your organization +## Configuring {% data variables.product.prodname_copilot %} settings in your organization Once an enterprise owner has enabled {% data variables.product.prodname_copilot_for_business %} for an organization, organization administrators and members with admin permissions can configure {% data variables.product.prodname_copilot %} access for their organization. Depending on the policy settings configured at the enterprise-level, an organization administrator may also be able to determine whether to allow or block {% data variables.product.prodname_copilot %} suggestions that match public code. For more information, see "[Configuring {% data variables.product.prodname_copilot %} settings in your organization](/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)." -### Assigning {% data variables.product.prodname_copilot %} seats +## Assigning {% data variables.product.prodname_copilot %} seats To give people or teams within your organization access to {% data variables.product.prodname_copilot %}, you need to assign them a {% data variables.product.prodname_copilot %} seat. Once a {% data variables.product.prodname_ghe_cloud %} admin enables a {% data variables.product.prodname_copilot_business_short %} subscription in your organization, you can assign {% data variables.product.prodname_copilot %} seats to individuals and teams in your organization. To enable access for all current and future users in your organization, or specific users in your organization, follow the steps in "[Configuring access to {% data variables.product.prodname_copilot %} in your organization](/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-access-to-github-copilot-in-your-organization)." diff --git a/content/get-started/quickstart/github-glossary.md b/content/get-started/quickstart/github-glossary.md index 18a85238e5a7..54849e7c0b98 100644 --- a/content/get-started/quickstart/github-glossary.md +++ b/content/get-started/quickstart/github-glossary.md @@ -12,9 +12,9 @@ versions: ghec: '*' --- {% for glossary in glossaries %} - ### {{ glossary.term }} + ## {{ glossary.term }} {{ glossary.description }} - --- + {% endfor %} --- 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 index a35c7bf0d92a..d22dab5a5af3 100644 --- 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 @@ -28,7 +28,7 @@ When you filter a view and then add an item, the filtered metadata will be appli 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 +## Filtering for fields | Qualifier | Example | ---------- | ------------- @@ -38,7 +38,7 @@ You can use filters to produce views for very specific purposes. For example, yo | reviewers:USERNAME | **reviewers:octocat** will show items that have been reviewed by @octocat. | milestone:"MILESTONE" | **milestone:"Beta release"** will show items assigned to the "Beta release" milestone. -### Combining filters +## Combining filters You can create filters for multiple fields. Your view will show items that match all filters. @@ -64,7 +64,7 @@ You can also combine filters that match some and match all items. | ---------- | ------------- |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 +## Negating a filter You can invert any filter, including combinations, by prefixing with a hyphen. @@ -74,7 +74,7 @@ You can invert any filter, including combinations, by prefixing with a hyphen. |-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 are missing a value +## Filtering for items that are missing a value You can use `no:` to filter for items that are missing a value @@ -91,7 +91,7 @@ You can also prefix a hyphen to negate this behavior and only return items that |-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 +## Filtering by item location Use the `repo` qualifier to filter for items in a particular repository. @@ -99,7 +99,7 @@ Use the `repo` qualifier to filter for items in a particular repository. | ---------- | ------------- |repo:OWNER/REPO | **repo:octocat/game** will items in the "octocat/game" repository. -### Filtering for item state or item type +## 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. @@ -113,7 +113,7 @@ You can use the `is` qualifier to filter for particular types of item or items i | | **is:draft** will show draft issues and draft pull requests. | | **is:issue is:open** will show open issues. -### Filtering by close reason +## Filtering by close reason You can filter closed items by their close reason. @@ -125,7 +125,7 @@ You can filter closed items by their close reason. {% ifversion projects-v2-tasklists %} -### Filtering by the tracked-by field +## Filtering by the tracked-by field You can filter for issues that being tracked by another issue in a Tasklist. For more information, see "[About Tasklists](/issues/tracking-your-work-with-issues/about-tasklists)." @@ -135,7 +135,7 @@ You can filter for issues that being tracked by another issue in a Tasklist. For {% endif %} -### Filtering for when an item was last updated +## Filtering for when an item was last updated You can use the `{number}days` syntax to filter for when items were last updated. @@ -145,7 +145,7 @@ You can use the `{number}days` syntax to filter for when items were last updated | | **last-updated:7days** will show items last updated seven or more days ago. | | **-last-updated:10days** will show items that have been updated in the last ten days. -### Filtering number, date, and iteration fields +## 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. @@ -165,7 +165,7 @@ You can also use `..` to filter for an inclusive range. When working with a rang | | **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 +## Filtering assignees and reviewers using keywords You can use the `@me` keyword to represent yourself in a filter. @@ -174,9 +174,9 @@ You can use the `@me` keyword to represent yourself in a filter. | 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 +## 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. +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 | ---------- | ------------- @@ -193,7 +193,7 @@ You can also use `>`, `>=`, `<`, `<=`, `+`, `-`, and `..` ranges with keywords. | 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 +## 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. 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 index 7ba8986db073..a45380e37fa2 100644 --- 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 @@ -11,7 +11,7 @@ topics: allowTitleToDifferFromFilename: true --- -Your project can track draft issues, issues, and pull requests. +Your project can track draft issues, issues, and pull requests. {% note %} @@ -19,13 +19,13 @@ Your project can track draft issues, issues, and pull requests. {% endnote %} -### Adding issues and pull requests to a project +## Adding issues and pull requests to a project You can add issues and pull requests to your project individually{% ifversion projects-v2-auto-add %}, automatically, {% endif %} or in bulk. You can also add draft issues which can later be transformed into issues. For more information, see "[Creating draft issues](#creating-draft-issues)." {% ifversion projects-v2-timeline-events %} -{% note %} +{% note %} **Note:** Timeline events for Projects is currently in beta and subject to change. @@ -37,19 +37,19 @@ When you add an issue or pull request to your project, an event will be added to {% ifversion projects-v2-auto-add %} -#### Automatically adding issues and pull requests +### 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 "[Adding items automatically](/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically)." {% endif %} -#### Pasting the URL of an issue or pull request +### 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 +### 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. @@ -60,7 +60,7 @@ If you know the issue or pull request number or if you know part of the title, y 4. Select the issue or pull request. You can type part of the title to narrow down your options. ![Screenshot showing pasting an issue URL to add it to the project](/assets/images/help/projects-v2/add-item-select-issue.png) -#### Bulk adding issues and pull requests +### 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. @@ -70,7 +70,7 @@ You can add multiple issues and pull requests from your project and use filters, {% ifversion projects-v2-create-issue-modal %}![Screenshot showing "add item from repository" menu item](/assets/images/help/projects-v2/add-bulk-menu-item.png){% else %}![Screenshot showing "add item from repository" menu item](/assets/images/help/projects-v2/add-bulk-menu-item-draft-option.png){% endif %} {% data reusables.projects.bulk-add %} -#### Adding multiple issues or pull requests from a repository +### 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. @@ -78,14 +78,14 @@ You can also add issues and pull requests to your project from a repository's is {% data reusables.repositories.sidebar-issue-pr %} 1. To the left of each issue title, select the issues that you want to add to your project. ![Screenshot showing checkbox to select issue or pull request](/assets/images/help/issues/select-issue-checkbox.png) -1. Optionally, to select every issue or pull request on the page, at the top of the list of issues or pull requests, select all. +1. Optionally, to select every issue or pull request on the page, at the top of the list of issues or pull requests, select all. ![Screenshot showing checkbox to select all on screen](/assets/images/help/issues/select-all-checkbox.png) -1. Above the list of issues or pull requests, click **Projects**. +1. Above the list of issues or pull requests, click **Projects**. ![Screenshot showing projects option](/assets/images/help/projects-v2/issue-index-project-menu.png) 1. Click the projects you want to add the selected issues or pull requests to. ![Screenshot showing checkbox to select all on screen](/assets/images/help/projects-v2/issue-index-select-project.png) -#### Assigning a project from within an issue or pull request +### 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. @@ -97,7 +97,7 @@ You can also add an issue or pull request to your project from within the issue 4. Optionally, populate the custom fields. ![Project sidebar](/assets/images/help/projects-v2/issue-edit-project-sidebar.png) -#### Using the command palette to add an issue or pull request +### 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. @@ -107,7 +107,7 @@ You can use the command palette when viewing your project to quickly add items. {% ifversion projects-v2-create-issue-modal %} -### Creating issues +## Creating issues {% data reusables.projects.about-issue-modal %} @@ -115,7 +115,7 @@ You can use the command palette when viewing your project to quickly add items. {% endif %} -### Creating draft issues +## 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. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields.md index b1b9db48f4fb..b6fa0111bc95 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields.md @@ -24,28 +24,27 @@ tracked-by:"/#" To use the filter, replace `` with the repository owner, `` with the repository name, and `` with the issue number. For more information, see "[Filtering projects](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects)." -### Enabling the Tracked by field +## Enabling the Tracked by field You can enable the Tracked by field to see which issues are tracking an item in your project. 1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - + ![Screenshot showing new field button](/assets/images/help/projects-v2/new-field-button.png) - + 1. Under "Hidden fields", click **Tracked by**. - + ![Screenshot showing the field menu](/assets/images/help/projects-v2/select-tracked-by-field.png) - -### Enabling the Tracks field + +## Enabling the Tracks field You can enable the Tracks field to see what other issues an item in your project is tracking. 1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}. - + ![Screenshot showing new field button](/assets/images/help/projects-v2/new-field-button.png) - + 1. Under "Hidden fields", click **Tracks**. - + ![Screenshot showing the field menu](/assets/images/help/projects-v2/select-tracks-field.png) - 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 index 25b7b74113b5..34e501971fa0 100644 --- 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 @@ -16,11 +16,11 @@ allowTitleToDifferFromFilename: true {% data reusables.projects.insights-release-note %} - 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. +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 track items you have archived or deleted. - ### About current charts +## 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. @@ -30,15 +30,15 @@ You can also use filters to manipulate the data used to build your chart. For ex For more information, see "[Creating charts](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts)." - ### About historical charts +## About historical charts - Historical charts are time-based charts that allow you to view your project's trends and progress. You can view the number of items, grouped by status and other fields, over time. - - The default "Burn up" chart shows item status over time, allowing you to visualize progress and spot patterns over time. +Historical charts are time-based charts that allow you to view your project's trends and progress. You can view the number of items, grouped by status and other fields, over time. + +The default "Burn up" chart shows item status over time, allowing you to visualize progress and spot patterns over time. ![Screenshot showing an example of the default burn up chart for the current iteration](/assets/images/help/issues/burnup-example.png) - To create a historical chart, set your chart's X-axis to "Time." For more information, see "[Creating charts](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts)" and "[Configuring charts](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts)." +To create a historical chart, set your chart's X-axis to "Time." For more information, see "[Creating charts](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts)" and "[Configuring charts](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/configuring-charts)." ## Further reading diff --git a/data/reusables/package_registry/about-packaging-and-actions.md b/data/reusables/package_registry/about-packaging-and-actions.md index 4146d32e6bb9..2b096a556f01 100644 --- a/data/reusables/package_registry/about-packaging-and-actions.md +++ b/data/reusables/package_registry/about-packaging-and-actions.md @@ -1,4 +1,4 @@ -### Packaging in continuous integration workflows +## Packaging in continuous integration workflows A packaging step is a common part of a continuous integration or continuous delivery workflow. Creating a package at the end of a continuous integration workflow can help during code reviews on a pull request. @@ -12,16 +12,16 @@ Now, when reviewing a pull request, you'll be able to look at the workflow run a This will let you run the code in the pull request on your machine, which can help with debugging or testing the pull request. -### Workflows for publishing packages +## Workflows for publishing packages In addition to uploading packaging artifacts for testing in a continuous integration workflow, you can create workflows that build your project and publish packages to a package registry. -* **Publish packages to {% data variables.product.prodname_registry %}** +* **Publish packages to {% data variables.product.prodname_registry %}** {% data variables.product.prodname_registry %} can act as a package hosting service for many types of packages. You can choose to share your packages with all of {% data variables.product.prodname_dotcom %}, or private packages to share with collaborators or an organization. For more information, see "[Introduction to GitHub Packages](/packages/learn-github-packages/introduction-to-github-packages)." You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build from the default branch easily, by installing it from {% data variables.product.prodname_registry %}. -* **Publish packages to a package registry** +* **Publish packages to a package registry** For many projects, publishing to a package registry is performed whenever a new version of a project is released. For example, a project that produces a JAR file may upload new releases to the Maven Central repository. Or, a .NET project may produce a nuget package and upload it to the NuGet Gallery. You can automate this by creating a workflow that publishes packages to a package registry on every release creation. For more information, see "[Creating releases](/github/administering-a-repository/creating-releases)."