Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix lists in communicating-on-github.md (#33100) #33174

Merged
merged 1 commit into from
May 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions content/get-started/using-github/communicating-on-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs.

{% ifversion discussions %}

Check warning on line 25 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'discussions' includes all possible versions and will always be true
{% ifversion team-discussions %}
You can create and participate in issues, pull requests, {% data variables.product.prodname_discussions %}, and team discussions, depending on the type of conversation you'd like to have.
{% else %}
Expand All @@ -34,36 +34,36 @@

### {% data variables.product.prodname_github_issues %}

- are useful for discussing specific details of a project such as bug reports, planned improvements and feedback.
- are specific to a repository, and usually have a clear owner.
- are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system.
- Are useful for discussing specific details of a project such as bug reports, planned improvements and feedback
- Are specific to a repository, and usually have a clear owner
- Are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system

### Pull requests

- allow you to propose specific changes.
- allow you to comment directly on proposed changes suggested by others.
- are specific to a repository.
- Allow you to propose specific changes
- Allow you to comment directly on proposed changes suggested by others
- Are specific to a repository

{% ifversion fpt or ghec %}

### {% data variables.product.prodname_discussions %}

- are like a forum, and are best used for open-form ideas and discussions where collaboration is important.
- may span many repositories.
- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base.
- often don’t have a clear owner.
- often do not result in an actionable task.
- Are like a forum, and are best used for open-form ideas and discussions where collaboration is important
- May span many repositories
- Provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base
- Often don’t have a clear owner
- Often do not result in an actionable task
{% endif %}

{% ifversion team-discussions %}

### Team discussions

- can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion.

Check warning on line 62 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

First word of list item should be capitalized

Expected: Can
- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes %}

Check warning on line 63 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

First word of list item should be capitalized

Expected: Allow
- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas.

Check warning on line 64 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

First word of list item should be capitalized

Expected: Provide
- often don’t have a clear owner.

Check warning on line 65 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

First word of list item should be capitalized

Expected: Often
- often do not result in an actionable task.{% endif %}

Check warning on line 66 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

First word of list item should be capitalized

Expected: Often
{% endif %}

## Which discussion tool should I use?
Expand Down Expand Up @@ -109,7 +109,7 @@
- The user creates a pull request with the fix.
- A repository maintainer reviews the pull request, comments on it, and merges it.

{% ifversion discussions %}

Check warning on line 112 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'discussions' includes all possible versions and will always be true

### Scenarios for {% data variables.product.prodname_discussions %}

Expand Down Expand Up @@ -140,7 +140,7 @@

This example shows a team post for the `octo-team` team.

![Example of team discussion.](/assets/images/help/projects/team-discussions-example.png)

Check warning on line 143 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

Images alternate text should be between 40-150 characters

Image alternate text is 27 characters long.

The `octocat` team member posted a team discussion, informing the team of various things:
- A team member called Mona started remote game events.
Expand All @@ -156,7 +156,7 @@

For pull requests, you can create draft pull requests if your proposed changes are still a work in progress. Draft pull requests cannot be merged until they're marked as ready for review. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests)."

{% ifversion discussions %}

Check warning on line 159 in content/get-started/using-github/communicating-on-github.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'discussions' includes all possible versions and will always be true
For {% data variables.product.prodname_discussions %}, you can{% ifversion fpt or ghec %} set up a code of conduct and{% endif %} pin discussions that contain important information for your community. For more information, see "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
{% endif %}

Expand Down
Loading