Fix inconsistent alerts by using the markdown notation - part 2 (#35221)
Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
This commit is contained in:
Artur Kordowski
@@ -25,20 +25,16 @@ If you create a wiki in a public repository, the wiki is available to {% ifversi
|
||||
You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.location.product_location %} to contribute to a wiki in a public repository. For more information, see "[AUTOTITLE](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% note %}
|
||||
|
||||
**Note:** Search engines will only index wikis with 500 or more stars that you configure to prevent public editing. For more information, see "[AUTOTITLE](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)."
|
||||
> [!NOTE]
|
||||
> Search engines will only index wikis with 500 or more stars that you configure to prevent public editing. For more information, see "[AUTOTITLE](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)."
|
||||
>
|
||||
> If you need search engines to index your content, you can use {% data variables.product.prodname_pages %} in a public repository. For more information, see "[{% data variables.product.prodname_pages %}](/pages)."
|
||||
|
||||
If you need search engines to index your content, you can use {% data variables.product.prodname_pages %} in a public repository. For more information, see "[{% data variables.product.prodname_pages %}](/pages)."
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** For performance reasons, wikis have a soft limit of 5,000 total files, regardless of file type. If you exceed this limit, some pages may be inaccessible to users. If you need a larger wiki, we recommend using {% data variables.product.prodname_pages %}. For more information, see "[{% data variables.product.prodname_pages %}](/pages)."
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> For performance reasons, wikis have a soft limit of 5,000 total files, regardless of file type. If you exceed this limit, some pages may be inaccessible to users. If you need a larger wiki, we recommend using {% data variables.product.prodname_pages %}. For more information, see "[{% data variables.product.prodname_pages %}](/pages)."
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -16,11 +16,8 @@ You can block non-members from within your organization's settings or from a spe
|
||||
|
||||
{% data reusables.organizations.blocking-a-user %}
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
At the time that you block a user from your organization:
|
||||
* The user stops watching your organization's repositories
|
||||
|
||||
@@ -16,11 +16,8 @@ shortTitle: Block from your account
|
||||
|
||||
You can block a user in your account settings or from the user's profile. {% data variables.product.prodname_dotcom %} will not notify the user when you block them. If you want to avoid contributing to the same project as someone you've blocked, you can choose to display a warning on any repositories with prior contributions from a blocked user. For more information, see "[Blocking a user in your account settings](#blocking-a-user-in-your-account-settings)." You may still see the activity of blocked users in shared spaces and blocked users can delete their existing content.
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> If you're blocking a user because of a heated conversation, consider locking the conversation so only collaborators can comment. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/locking-conversations)."
|
||||
|
||||
When you block a user:
|
||||
* The user stops following you
|
||||
|
||||
@@ -80,14 +80,9 @@ If reported content is enabled for a public repository, you can also report cont
|
||||
1. In the lower-right corner of the template chooser, click **Report abuse**.
|
||||
1. Complete the contact form to tell {% data variables.contact.github_support %} about the contact link's behavior, then click **Send request**.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Notes:**
|
||||
|
||||
* In order to get accurate information about the abuse, the abuse report form will direct you to use the in-product abuse report links. If an in-product link is not available, contact {% data variables.contact.contact_support %} to report abuse or report content.
|
||||
* Users in India can contact {% data variables.product.prodname_dotcom %}'s Grievance Officer for India through [support.github.com/contact/india-grievance-officer](https://support.github.com/contact/india-grievance-officer).
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> * In order to get accurate information about the abuse, the abuse report form will direct you to use the in-product abuse report links. If an in-product link is not available, contact {% data variables.contact.contact_support %} to report abuse or report content.
|
||||
> * Users in India can contact {% data variables.product.prodname_dotcom %}'s Grievance Officer for India through [support.github.com/contact/india-grievance-officer](https://support.github.com/contact/india-grievance-officer).
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -16,11 +16,8 @@ After unblocking a user from your organization, they'll be able to contribute to
|
||||
|
||||
If you selected a specific amount of time to block the user, they will be automatically unblocked when that period of time ends. For more information, see "[AUTOTITLE](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip**: Any settings that were removed when you blocked the user from your organization, such as collaborator status, stars, and watches, will not be restored when you unblock the user.
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> Any settings that were removed when you blocked the user from your organization, such as collaborator status, stars, and watches, will not be restored when you unblock the user.
|
||||
|
||||
## Unblocking a user in a comment
|
||||
|
||||
|
||||
@@ -32,11 +32,8 @@ You can unblock a user in your account settings or from the user's profile page.
|
||||
|
||||
1. Click **Unblock user**.
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip**: Settings that were removed when you blocked the user, such as collaborator status, stars, and follows, are not restored when you unblock the user.
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> Settings that were removed when you blocked the user, such as collaborator status, stars, and follows, are not restored when you unblock the user.
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -82,11 +82,8 @@ Deleting a comment creates a timeline event that is visible to anyone with read
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The initial comment (or body) of an issue or pull request can't be deleted. Instead, you can edit issue and pull request bodies to remove unwanted content.
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> The initial comment (or body) of an issue or pull request can't be deleted. Instead, you can edit issue and pull request bodies to remove unwanted content.
|
||||
|
||||
### Steps to delete a comment
|
||||
|
||||
|
||||
@@ -19,11 +19,8 @@ To direct people to specific support resources, you can add a SUPPORT file to yo
|
||||
|
||||
You can create default support resources for your organization or personal account. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** To help people find your support guidelines, you can link to your SUPPORT file from other places in your repository, such as your [README file](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> To help people find your support guidelines, you can link to your SUPPORT file from other places in your repository, such as your [README file](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes).
|
||||
|
||||
## Adding support resources to your project
|
||||
|
||||
|
||||
@@ -25,11 +25,8 @@ For both owners and contributors, contribution guidelines save time and hassle c
|
||||
|
||||
You can create default contribution guidelines for your organization or personal account. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
|
||||
## Adding a _CONTRIBUTING_ file
|
||||
|
||||
|
||||
@@ -67,11 +67,8 @@ Here is the rendered version of the issue form.
|
||||
|
||||
You can encourage contributors to use issue templates by setting `blank_issues_enabled` to `false`. If you set `blank_issues_enabled` to `true`, people will have the option to open a blank issue.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If you used the legacy workflow to manually create an `issue_template.md` file in the `.github` folder and enable blank issues in your _config.yml_ file, the template in `issue_template.md` will be used when people choose to open a blank issue. If you disable blank issues, the template will never be used.
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> If you used the legacy workflow to manually create an `issue_template.md` file in the `.github` folder and enable blank issues in your _config.yml_ file, the template in `issue_template.md` will be used when people choose to open a blank issue. If you disable blank issues, the template will never be used.
|
||||
|
||||
If you prefer to receive certain reports outside of {% data variables.product.product_name %}, you can direct people to external sites with `contact_links`.
|
||||
|
||||
|
||||
@@ -32,11 +32,8 @@ assignees: octocat
|
||||
---
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`.
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
|
||||
@@ -9,11 +9,8 @@ topics:
|
||||
- Community
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.company_short %}'s form schema is currently in {% data variables.release-phases.public_preview %} and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> {% data variables.product.company_short %}'s form schema is currently in {% data variables.release-phases.public_preview %} and subject to change.
|
||||
|
||||
## About {% data variables.product.company_short %}'s form schema
|
||||
|
||||
@@ -89,13 +86,10 @@ You can use a `markdown` element to display Markdown in your form that provides
|
||||
| --- | ----------- | -------- | ---- | ------- | ------- |
|
||||
| `value` | The text that is rendered. Markdown formatting is supported. | {% octicon "check" aria-label="Required" %} | String | {% octicon "dash" aria-label="Not applicable" %} | {% octicon "dash" aria-label="Not applicable" %} |
|
||||
|
||||
{% tip %}
|
||||
|
||||
**Tips:** YAML processing will treat the hash symbol as a comment. To insert Markdown headers, wrap your text in quotes.
|
||||
|
||||
For multi-line text, you can use the pipe operator.
|
||||
|
||||
{% endtip %}
|
||||
> [!TIP]
|
||||
> YAML processing will treat the hash symbol as a comment. To insert Markdown headers, wrap your text in quotes.
|
||||
>
|
||||
> For multi-line text, you can use the pipe operator.
|
||||
|
||||
#### Example of `markdown`
|
||||
|
||||
|
||||
@@ -19,11 +19,8 @@ Issue forms are not supported for pull requests. You can create pull request tem
|
||||
|
||||
This example YAML configuration file defines an issue form using several inputs to report a bug.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The `required` field key is only supported in public repositories. In private and internal repositories, all fields are optional.
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE]
|
||||
> The `required` field key is only supported in public repositories. In private and internal repositories, all fields are optional.
|
||||
|
||||
{% data reusables.community.issue-forms-sample %}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user