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 inconsistent alerts by using the markdown notation #35216

Closed

Conversation

akordowski
Copy link
Contributor

Why:

As described in the issue #35195 the display of alerts is inconsistent across the documentation. The following PR provides changes to all alerts according to the docs guidelines using the Markdown notation.

Closes: #35195

What's being changed (if available, include any code snippets, screenshots, or gifs):

All alerts for note, tip, important and warning have been changed and unified from the following notation to the Markdown notation according to the docs guidelines.

{% note %}
text
{% endnote %}

> [!NOTE]
> Text

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@akordowski akordowski requested a review from a team as a code owner November 7, 2024 09:27
Copy link

welcome bot commented Nov 7, 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.

Copy link
Contributor

github-actions bot commented Nov 7, 2024

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:

  • src/fixtures/fixtures/content/get-started/liquid/notes.md
  • src/fixtures/fixtures/content/get-started/liquid/tips.md
  • src/ghes-releases/lib/deprecation-steps.md
  • src/ghes-releases/lib/release-templates/release-steps-3.md
  • src/ghes-releases/lib/release-templates/release-steps-4.md
  • src/ghes-releases/lib/release-templates/release-steps-5.md

You'll need to revert all of the files you changed that match that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

The complete list of files we can't accept are:

  • .devcontainer/**
  • .github/**
  • data/reusables/rai/**
  • Dockerfile*
  • src/**
  • package*.json
  • content/actions/deployment/security-hardening-your-deployments/**

We also can't accept contributions to files in the content directory with frontmatter type: rai.

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

github-actions bot commented Nov 7, 2024

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
account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md fpt
fpt
account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md fpt
ghec
fpt
ghec
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/about-organization-membership.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ [3.14](https://docs.github.com/enterprise-server@3.14/...*[Comment body truncated]*

@akordowski
Copy link
Contributor Author

Is there a way to go around the following lint error?

__ running gh pr diff __
could not find pull request diff: HTTP 406: Sorry, the diff exceeded the maximum number of files (300). Consider using 'List pull requests files' API or locally cloning the repository instead. (https://api.github.com/repos/github/docs/pulls/35216)
PullRequest.diff too_large

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs and removed triage Do not begin working on this issue until triaged by the team labels Nov 7, 2024
@nguyenalex836
Copy link
Contributor

@akordowski Thank you so much for the time and effort put into this PR! ✨ 🚀 We didn't expect a PR to change every inconsistency, and are greatly appreciative of the energy put into improve our docs 🙇

Is there a way to go around the following lint error?

Unfortunately there isn't - would you be alright with breaking up your PR into multiple PRs smaller than the max files limit (300)? 💛

@akordowski
Copy link
Contributor Author

@nguyenalex836

We didn't expect a PR to change every inconsistency, and are greatly appreciative of the energy put into improve our docs 🙇

You're very welcome! ☺️

would you be alright with breaking up your PR into multiple PRs smaller than the max files limit (300)?

That was also my idea. Maybe a PR for each seaction? (Actions, Copilot, ...) That would propably also make it easier to review. What do you think?

Should I also create an new issue for each PR or reference to the existing one?

@nguyenalex836
Copy link
Contributor

@akordowski

That was also my idea. Maybe a PR for each seaction? (Actions, Copilot, ...) That would propably also make it easier to review.

This sounds like an excellent plan! 💛

Should I also create an new issue for each PR or reference to the existing one?

Feel free to just have each PR reference the existing issue! Thank you!

@akordowski
Copy link
Contributor Author

@nguyenalex836 Ok, will do. Thank you!

@akordowski
Copy link
Contributor Author

As this PR exceeds the linter limit of 300 files, this PR is splited into 4 new ones, see here. This PR will be closed.

@akordowski akordowski closed this Nov 7, 2024
@akordowski akordowski deleted the fix/unified-alerts-blocks-display branch November 7, 2024 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent labeling of Note/Warning blocks
2 participants