Skip to content

Commit 2510bc6

Browse files
authored
fix ul style markdown rule (github#39329)
1 parent 4f182d0 commit 2510bc6

File tree

12 files changed

+58
-58
lines changed

12 files changed

+58
-58
lines changed

content/actions/using-github-hosted-runners/about-larger-runners.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners
4545

4646
Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.actions.hosted_runner %}s have the following additional features:
4747

48-
* For Ubuntu runners, hardware acceleration for the Android SDK tools is enabled. This makes running Android tests much faster and consumes fewer minutes. For more information on Android hardware acceleration, see [Configure hardware acceleration for the Android Emulator](https://developer.android.com/studio/run/emulator-acceleration) in the Android Developers documentation.
49-
* {% data variables.actions.hosted_runner_caps %}s can be assigned static IP addresses from a specific range, which enables you to use this range to configure a firewall allowlist. For more information, see "[Networking for {% data variables.actions.hosted_runner %}s](#networking-for-larger-runners)."
50-
* {% data variables.actions.hosted_runner_caps %}s can automatically scale up to a maximum limit set by you, so your workflows can run concurrently. For more information, see "[Autoscaling {% data variables.actions.hosted_runner %}s](#autoscaling-larger-runners)."
51-
* Runner groups allow you to control access to {% data variables.actions.hosted_runner %}s for your organizations, repositories, and workflows. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)."
48+
- For Ubuntu runners, hardware acceleration for the Android SDK tools is enabled. This makes running Android tests much faster and consumes fewer minutes. For more information on Android hardware acceleration, see [Configure hardware acceleration for the Android Emulator](https://developer.android.com/studio/run/emulator-acceleration) in the Android Developers documentation.
49+
- {% data variables.actions.hosted_runner_caps %}s can be assigned static IP addresses from a specific range, which enables you to use this range to configure a firewall allowlist. For more information, see "[Networking for {% data variables.actions.hosted_runner %}s](#networking-for-larger-runners)."
50+
- {% data variables.actions.hosted_runner_caps %}s can automatically scale up to a maximum limit set by you, so your workflows can run concurrently. For more information, see "[Autoscaling {% data variables.actions.hosted_runner %}s](#autoscaling-larger-runners)."
51+
- Runner groups allow you to control access to {% data variables.actions.hosted_runner %}s for your organizations, repositories, and workflows. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)."
5252

5353
For a full list of included tools for each runner operating system, see the [{% data variables.product.prodname_actions %} Runner Images](https://github.com/actions/runner-images) repository.
5454

content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -460,8 +460,8 @@ You'll learn about authenticating as an installation in the next section, "[Auth
460460

461461
Authenticating as a {% data variables.product.prodname_github_app %} lets you do a couple of things:
462462

463-
* You can retrieve high-level management information about your {% data variables.product.prodname_github_app %}.
464-
* You can request access tokens for an installation of the app.
463+
- You can retrieve high-level management information about your {% data variables.product.prodname_github_app %}.
464+
- You can request access tokens for an installation of the app.
465465

466466
For example, you would authenticate as a {% data variables.product.prodname_github_app %} to retrieve a list of the accounts (organization and personal) that have installed your app. But this authentication method doesn't allow you to do much with the API. To access a repository's data and perform operations on behalf of the installation, you need to authenticate as an installation. To do that, you'll need to authenticate as a {% data variables.product.prodname_github_app %} first to request an installation access token. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)."
467467

@@ -515,8 +515,8 @@ The `create_app_installation_access_token` Octokit method creates an installatio
515515

516516
This method accepts two arguments:
517517

518-
* Installation (integer): The ID of a {% data variables.product.prodname_github_app %} installation
519-
* Options (hash, defaults to `{}`): A customizable set of options
518+
- Installation (integer): The ID of a {% data variables.product.prodname_github_app %} installation
519+
- Options (hash, defaults to `{}`): A customizable set of options
520520

521521
Any time a {% data variables.product.prodname_github_app %} receives a webhook, it includes an `installation` object with an `id`. Using the client authenticated as a {% data variables.product.prodname_github_app %}, you pass this ID to the `create_app_installation_access_token` method to generate an access token for each installation. Since you're not passing any options to the method, the options default to an empty hash. The response for `create_app_installation_access_token` includes two fields: `token` and `expired_at`. The template code selects the token in the response and initializes an installation client.
522522

@@ -772,9 +772,9 @@ RuboCop is a Ruby code linter and formatter. It checks Ruby code to ensure that
772772
773773
RuboCop has three primary functions:
774774
775-
* Linting to check code style
776-
* Code formatting
777-
* Replaces the native Ruby linting capabilities using `ruby -w`
775+
- Linting to check code style
776+
- Code formatting
777+
- Replaces the native Ruby linting capabilities using `ruby -w`
778778
779779
Your app will run RuboCop on the CI server, and create check runs (CI tests in this case) that report the results that RuboCop reports to {% data variables.product.prodname_dotcom %}.
780780

content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr
4141

4242
- If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace.
4343

44-
* If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace.
44+
- If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace.
4545

4646
The first time you open a codespace this way you must give permission to open the application.
4747

content/codespaces/managing-codespaces-for-your-organization/restricting-the-number-of-organization-billed-codespaces-a-user-can-create.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Policies with the "Maximum codespaces per user" constraint are applied to every
3939

4040
1. Click **Save**.
4141
1. If you want to add another constraint to the policy, click **Add constraint** and choose another constraint. For information about other constraints, see:
42-
* "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)"
43-
* "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces)"
44-
* "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)"
45-
* "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)"
46-
* "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)"
42+
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)"
43+
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces)"
44+
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)"
45+
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)"
46+
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)"
4747

4848
{% note %}
4949

content/contributing/writing-for-github-docs/style-guide.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,9 @@ Avoid using footnotes where possible. Consider instead whether you could use a [
169169

170170
If you must use footnotes:
171171

172-
* Use numbers. Do not use typographical symbols or special characters.
173-
* Place footnote markers in square brackets: `[1]`.
174-
* Do not use superscript.
172+
- Use numbers. Do not use typographical symbols or special characters.
173+
- Place footnote markers in square brackets: `[1]`.
174+
- Do not use superscript.
175175

176176
## Headers
177177

@@ -485,8 +485,8 @@ Capitalize the first letter in each line of a list. Use periods at the end of li
485485
486486
When writing a list of items that consist of primary and secondary text, such as a `term` and its definition, use a colon delimiter. The secondary text should be capitalized as if it was the beginning of the line. For example:
487487
488-
* `foo`: Something that provides bar.
489-
* `bar`: Something provided by foo.
488+
- `foo`: Something that provides bar.
489+
- `bar`: Something provided by foo.
490490
491491
Formatting unordered lists:
492492
- If the order of items in the list is not important, alphabetize the list items.
@@ -616,8 +616,8 @@ For more information, see "[Using SHAs](/actions/learn-github-actions/finding-an
616616
### {% data variables.product.prodname_codespaces %}
617617

618618
When referring to the product {% data variables.product.prodname_codespaces %}, always include "{% data variables.product.company_short %}", except in these circumstances:
619-
* In the `shortTitle` front matter (i.e. the abbreviated version of the article title).
620-
* In subheadings within an article, if "{% data variables.product.prodname_codespaces %}" has already been used anywhere in the article prior to the subheading.
619+
- In the `shortTitle` front matter (i.e. the abbreviated version of the article title).
620+
- In subheadings within an article, if "{% data variables.product.prodname_codespaces %}" has already been used anywhere in the article prior to the subheading.
621621

622622
Variables: `{% raw %}{% data variables.product.prodname_github_codespaces %}{% endraw %}` ("GitHub Codespaces") and `{% raw %}{% data variables.product.prodname_codespaces %}{% endraw %}` ("Codespaces").
623623

@@ -977,10 +977,10 @@ If there is no data, use "None" or "Not applicable". Do not use "NA" or "N/A".
977977

978978
For tables that use symbols:
979979

980-
* Populate all cells. For example in a permissions table, do not mark only the cells for things that require a permission.
981-
* Use [octicons](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#octicons) or SVG. Do not use emoji.
982-
* Use a [check mark](https://primer.style/octicons/check-16) for affirmative values ("Yes", "Required", "Supported") and a [cross](https://primer.style/octicons/x-16) for negative values ("No", "Optional", "Unsupported").
983-
* Use `aria-label` to describe the meaning of the symbol, not its visual characteristics. For example, "Required", not "Check mark icon".
980+
- Populate all cells. For example in a permissions table, do not mark only the cells for things that require a permission.
981+
- Use [octicons](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#octicons) or SVG. Do not use emoji.
982+
- Use a [check mark](https://primer.style/octicons/check-16) for affirmative values ("Yes", "Required", "Supported") and a [cross](https://primer.style/octicons/x-16) for negative values ("No", "Optional", "Unsupported").
983+
- Use `aria-label` to describe the meaning of the symbol, not its visual characteristics. For example, "Required", not "Check mark icon".
984984

985985
Where table data is not truly binary (every value is either "Yes" or "No", for example), text values may be needed in addition to, or instead of, symbols. For example on the page "[AUTOTITLE](/support/learning-about-github-support/about-github-support)", some features are marked as "Available to purchase".
986986

content/issues/managing-your-tasks-with-tasklists/about-tasklists.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ topics:
1313

1414
**Notes:**
1515

16-
* Tasklists are currently in private beta and subject to change. If you are interested in trying tasklists, you can join the [waitlist](https://aka.ms/tasklist-roadmap-signup). Tasklists build upon the previous iteration of [task lists](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists).
17-
* For the best experience, we recommend adding no more than 50 tasks to a tasklist and no more than 5 tasklists per issue. There is a hard limit of 250 tasks per tasklist and 10 tasklists per issue.
16+
- Tasklists are currently in private beta and subject to change. If you are interested in trying tasklists, you can join the [waitlist](https://aka.ms/tasklist-roadmap-signup). Tasklists build upon the previous iteration of [task lists](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists).
17+
- For the best experience, we recommend adding no more than 50 tasks to a tasklist and no more than 5 tasklists per issue. There is a hard limit of 250 tasks per tasklist and 10 tasklists per issue.
1818

1919
{% endnote %}
2020

content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ You can also use the **Add tasklist** button while editing your issue to insert
4545

4646
Once you have started editing your tasklist Markdown, you can add new tasks by preceding each new task with `- [ ] ` and then adding either:
4747

48-
* A draft task. Draft tasks are text that can later be converted into issues.
49-
* The full link to an issue or pull request or, if the issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `https://github.com/octo-org/octo-repo/issues/45` or `#45`.
50-
* If an issue or pull request is in the same repository
48+
- A draft task. Draft tasks are text that can later be converted into issues.
49+
- The full link to an issue or pull request or, if the issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `https://github.com/octo-org/octo-repo/issues/45` or `#45`.
50+
- If an issue or pull request is in the same repository
5151

5252
If you add a draft task, it must meet these requirements:
5353

54-
* Draft tasks can be formatted using Markdown.
55-
* Draft tasks must not exceed 512 characters in length.
54+
- Draft tasks can be formatted using Markdown.
55+
- Draft tasks must not exceed 512 characters in length.
5656

5757
Your tasklist will be rendered by {% data variables.product.product_name %} when you preview your changes and when you save the issue. You can then make changes and add issues and draft tasks using the {% data variables.product.product_name %} UI. If you edit the issue description, you will be able to modify the Markdown directly or copy the Markdown to duplicate the tasklist in other issues.
5858

content/issues/managing-your-tasks-with-tasklists/managing-tasks-in-a-tasklist.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ You can add issues and pull requests from any repository you have access to. Peo
2323

2424
1. Add your draft task, issue, or pull request.
2525

26-
* To add a draft task, just type your task and press <kbd>Enter</kbd>.
27-
* To add a recently updated issue, click an issue from the list, or use your arrow keys to select it and then press <kbd>Enter</kbd>.
28-
* To search for an issue in the current repository, start typing the title of an issue or the issue's number and click on the result, or use your arrow keys to select it and press <kbd>Enter</kbd>.
29-
* To add an issue directly using its URL, paste the URL of an issue and press <kbd>Enter</kbd>.
26+
- To add a draft task, just type your task and press <kbd>Enter</kbd>.
27+
- To add a recently updated issue, click an issue from the list, or use your arrow keys to select it and then press <kbd>Enter</kbd>.
28+
- To search for an issue in the current repository, start typing the title of an issue or the issue's number and click on the result, or use your arrow keys to select it and press <kbd>Enter</kbd>.
29+
- To add an issue directly using its URL, paste the URL of an issue and press <kbd>Enter</kbd>.
3030

3131
## Converting draft tasks to issues in a tasklist
3232

@@ -45,18 +45,18 @@ You can convert draft tasks into issues. Issues are created in the same reposito
4545
![Screenshot of a tasklist. To the right of a task, the tracking block item menu, which is labeled with a horizontal kebab icon, is outlined in dark orange.](/assets/images/help/projects-v2/tasklists-item-context-menu.png)
4646

4747
1. Using the context menu, make your changes.
48-
* To set labels, select **Set labels**, and then select one or more labels from the menu.
49-
* To set assignees, select **Set assignees**, and then select one or more people from the menu.
50-
* To add the issue or pull request to a project, select **Set project**, and then select a project from the menu.
48+
- To set labels, select **Set labels**, and then select one or more labels from the menu.
49+
- To set assignees, select **Set assignees**, and then select one or more people from the menu.
50+
- To add the issue or pull request to a project, select **Set project**, and then select a project from the menu.
5151

5252
## Dragging tasks to change position and move between tasklists
5353

5454
You can move tasks within a tasklist and move tasks to other tasklists in the same issue.
5555

5656
1. Hover your cursor to the left of the task you want to move until a {% octicon "grabber" aria-hidden="true" %} drag handle appears.
5757
1. Click on the {% octicon "grabber" aria-hidden="true" %} drag handle and drag the task to the new destination.
58-
* Drag the task to another position in the same tasklist.
59-
* Drag the task to another tasklist in the same issue.
58+
- Drag the task to another position in the same tasklist.
59+
- Drag the task to another tasklist in the same issue.
6060

6161
## Removing tasks from a tasklist
6262

content/issues/managing-your-tasks-with-tasklists/using-projects-and-tasklists.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ When the issues added to your project are either tracked by tasklists or contain
4747

4848
1. In your project, click on an issue that either contains a tasklist or is tracked by a tasklist in another issue.
4949
1. In the issue that opens in the side-bar, you can navigate through the associated issues.
50-
* To navigate down the issue hierarchy, and view the tasks that comprise the current issue, click on issues in the tasklist.
50+
- To navigate down the issue hierarchy, and view the tasks that comprise the current issue, click on issues in the tasklist.
5151

5252
![Screenshot of the header of an issue comment. In the right corner, a horizontal kebab icon is outlined in dark orange.](/assets/images/help/projects-v2/side-panel-tasklist.png)
5353

54-
* To navigate up the issue hierarchy, and view the issues that include the current issue as a task, click on an issue number in the breadcrumb menu.
54+
- To navigate up the issue hierarchy, and view the issues that include the current issue as a task, click on an issue number in the breadcrumb menu.
5555

5656
![Screenshot of the header of an issue comment. In the right corner, a horizontal kebab icon is outlined in dark orange.](/assets/images/help/projects-v2/breadcrumb-menu.png)
5757

content/organizations/managing-organization-settings/archiving-an-organization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ topics:
1313

1414
**Notes:**
1515

16-
* The ability to archive an organization is currently in public beta and subject to change.
17-
* You can only archive an organization if it's using {% data variables.product.prodname_free_team %} or if the organization is part of an enterprise. If you want to archive an individually-billed organization, you must downgrade your organization to {% data variables.product.prodname_free_team %} first. For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription)."
16+
- The ability to archive an organization is currently in public beta and subject to change.
17+
- You can only archive an organization if it's using {% data variables.product.prodname_free_team %} or if the organization is part of an enterprise. If you want to archive an individually-billed organization, you must downgrade your organization to {% data variables.product.prodname_free_team %} first. For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription)."
1818

1919
{% endnote %}
2020

0 commit comments

Comments
 (0)