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.

Sign up for GitHub

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

Jump to bottom

Fix formatting issues in documentation: Removed periods and added backticks #35696

Merged
merged 6 commits into from
Dec 18, 2024
Merged

Fix formatting issues in documentation: Removed periods and added backticks #35696

merged 6 commits into from
Dec 18, 2024

Conversation

lalithaar
Copy link
Contributor

@lalithaar lalithaar commented Dec 18, 2024 •
edited
Loading

Removed periods, Use backticks to format references to the file names (instead of italics).

Why:

The bullet points were not complete sentences, and according to the style guide, lists with incomplete sentences should not end with periods. This change ensures the article follows the documentation style guide.

Closes: #35661
Closes: #35660
Closes: #35658
Closes: #35657

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

@lalithaar
Removed periods from list
8cc8686 
Remove periods from the list in understanding-github-actions#workflows
@welcome Welcome
Copy link

welcome bot commented Dec 18, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 18, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 18, 2024 •
edited
Loading

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
discussions/guides/best-practices-for-community-conversations-on-github.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
actions/about-github-actions/understanding-github-actions.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
from reusable
actions/writing-workflows/about-workflows.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
from reusable
actions/security-for-github-actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
from reusable
admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
from reusable
code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
from reusable
pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
from reusable

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@lalithaar lalithaar changed the title Removed periods from list in understanding-github-actions#workflows Edited formatting issues in content docs Dec 18, 2024
@lalithaar lalithaar changed the title Edited formatting issues in content docs Fix formatting issues in documentation: Removed periods and added backticks Dec 18, 2024
@nguyenalex836
Copy link
Contributor

@lalithaar Thanks so much for opening a PR with this fix! I made on small tweak and removed the parentheses around the file name, as they aren't needed 💛 I'll update the branch and get this merged once tests are passing 🍏

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Dec 18, 2024
Merged via the queue into github:main with commit c884174 Dec 18, 2024
45 checks passed
@github-actions GitHub Actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nguyenalex836 nguyenalex836 nguyenalex836 approved these changes

Assignees
No one assigned
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Milestone
No milestone
2 participants
@lalithaar @nguyenalex836