Skip to content

Commit

Permalink
fix ul style markdown rule (#39329)
Browse files Browse the repository at this point in the history
  • Loading branch information
rachmari authored Jul 20, 2023
1 parent 4f182d0 commit 2510bc6
Show file tree
Hide file tree
Showing 12 changed files with 58 additions and 58 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners

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

* 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.
* {% 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)."
* {% 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)."
* 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)."
- 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.
- {% 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)."
- {% 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)."
- 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)."

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -460,8 +460,8 @@ You'll learn about authenticating as an installation in the next section, "[Auth

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

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

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

Expand Down Expand Up @@ -515,8 +515,8 @@ The `create_app_installation_access_token` Octokit method creates an installatio

This method accepts two arguments:

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

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.

Expand Down Expand Up @@ -772,9 +772,9 @@ RuboCop is a Ruby code linter and formatter. It checks Ruby code to ensure that
RuboCop has three primary functions:
* Linting to check code style
* Code formatting
* Replaces the native Ruby linting capabilities using `ruby -w`
- Linting to check code style
- Code formatting
- Replaces the native Ruby linting capabilities using `ruby -w`
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 %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ Policies with the "Maximum codespaces per user" constraint are applied to every

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

{% note %}

Expand Down
22 changes: 11 additions & 11 deletions content/contributing/writing-for-github-docs/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,9 @@ Avoid using footnotes where possible. Consider instead whether you could use a [

If you must use footnotes:

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

## Headers

Expand Down Expand Up @@ -485,8 +485,8 @@ Capitalize the first letter in each line of a list. Use periods at the end of li
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:
* `foo`: Something that provides bar.
* `bar`: Something provided by foo.
- `foo`: Something that provides bar.
- `bar`: Something provided by foo.
Formatting unordered lists:
- If the order of items in the list is not important, alphabetize the list items.
Expand Down Expand Up @@ -616,8 +616,8 @@ For more information, see "[Using SHAs](/actions/learn-github-actions/finding-an
### {% data variables.product.prodname_codespaces %}

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

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

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

For tables that use symbols:

* Populate all cells. For example in a permissions table, do not mark only the cells for things that require a permission.
* Use [octicons](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#octicons) or SVG. Do not use emoji.
* 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").
* Use `aria-label` to describe the meaning of the symbol, not its visual characteristics. For example, "Required", not "Check mark icon".
- Populate all cells. For example in a permissions table, do not mark only the cells for things that require a permission.
- Use [octicons](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#octicons) or SVG. Do not use emoji.
- 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").
- Use `aria-label` to describe the meaning of the symbol, not its visual characteristics. For example, "Required", not "Check mark icon".

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".

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ topics:

**Notes:**

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

{% endnote %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ You can also use the **Add tasklist** button while editing your issue to insert

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

* A draft task. Draft tasks are text that can later be converted into issues.
* 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`.
* If an issue or pull request is in the same repository
- A draft task. Draft tasks are text that can later be converted into issues.
- 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`.
- If an issue or pull request is in the same repository

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

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

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ You can add issues and pull requests from any repository you have access to. Peo

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

* To add a draft task, just type your task and press <kbd>Enter</kbd>.
* 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>.
* 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>.
* To add an issue directly using its URL, paste the URL of an issue and press <kbd>Enter</kbd>.
- To add a draft task, just type your task and press <kbd>Enter</kbd>.
- 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>.
- 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>.
- To add an issue directly using its URL, paste the URL of an issue and press <kbd>Enter</kbd>.

## Converting draft tasks to issues in a tasklist

Expand All @@ -45,18 +45,18 @@ You can convert draft tasks into issues. Issues are created in the same reposito
![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)

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

## Dragging tasks to change position and move between tasklists

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

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

## Removing tasks from a tasklist

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ When the issues added to your project are either tracked by tasklists or contain

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

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

* 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.
- 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.

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

Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ topics:

**Notes:**

* The ability to archive an organization is currently in public beta and subject to change.
* 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)."
- The ability to archive an organization is currently in public beta and subject to change.
- 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)."

{% endnote %}

Expand Down
Loading

0 comments on commit 2510bc6

Please sign in to comment.