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 - part 2 #35221

Merged
merged 4 commits into from
Nov 8, 2024

Conversation

akordowski
Copy link
Contributor

@akordowski akordowski commented Nov 7, 2024

Why:

As described in the issue #35195 the display of alerts is inconsistent across the documentation.

As the original PR #35216 exceeds the linter limit of 300 files, this PR is part 2 of the changes. It provides changes to alerts across the documentation according to the docs guidelines using the Markdown notation.

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

Alerts for note, tip, important and warning have been changed and unified from the liquid notation ({% note %}) to the Markdown notation (> [!NOTE]) according to the docs guidelines.

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.

@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
billing/managing-billing-for-your-products/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-git-large-file-storage/viewing-your-git-large-file-storage-usage.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-actions/viewing-your-github-actions-usage.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.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
billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/managing-the-spending-limit-for-github-codespaces.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/viewing-your-github-codespaces-usage.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-marketplace-apps/about-billing-for-github-marketplace.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-billing-for-github-packages/viewing-your-github-packages-usage.md fpt
ghec
fpt
ghec
billing/managing-billing-for-your-products/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md ghec
ghec
billing/managing-the-plan-for-your-github-account/about-billing-for-plans.md fpt
ghec
fpt
ghec
billing/managing-the-plan-for-your-github-account/about-per-user-pricing.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
billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription.md fpt
ghec
ghes@ 3.14 3.13 3.12
fpt
ghec
ghes@ 3.14 3.13 3.12
billing/managing-the-plan-for-your-github-account/discounted-plans-for-github-accounts.md fpt
ghec
fpt
ghec
billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan.md fpt
ghec
fpt
ghec
billing/managing-the-plan-for-your-github-account/one-time-payments-for-customers-in-india.md fpt
ghec
fpt
ghec
billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server.md ghes@ 3.14 3.13 3.12 3.11 3.10
ghes@ 3.14 3.13 3.12 3.11 3.10
billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/renewing-your-clients-paid-organization.md fpt
ghec
fpt
ghec
billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md fpt
ghec
fpt
ghec
billing/using-the-billing-platform/adding-information-to-your-receipts.md fpt
ghec
fpt
ghec
billing/using-the-billing-platform/adding-or-editing-a-payment-method.md fpt
ghec
fpt
ghec
billing/using-the-billing-platform/changing-the-duration-of-your-billing-cycle.md fpt
ghec
fpt
ghec
billing/using-the-billing-platform/viewing-your-payment-history-and-receipts.md fpt
ghec
fpt
ghec
billing/using-the-billing-platform/viewing-your-subscriptions-and-billing-date.md fpt
ghec
fpt
ghec
code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.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
code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.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
code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.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
code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.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
code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.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
code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.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
code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.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
code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.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
code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts.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
code-security/code-scanning/managing-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md fpt
ghec
ghes@ 3.14 3.13 3.12 [3.11](https://docs-35221-95e4dd.preview.ghdocs.com/enterprise-server@3.11/code-security/code-scann...*[Comment body truncated]*

@nguyenalex836
Copy link
Contributor

@akordowski Reviewing this now! 💛

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

@akordowski Part 2 approved! ✨

I know we're only halfway through this PR series, but I wanted to relay thanks from the team for this undertaking 💛 I'll have this merged shortly.

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Nov 8, 2024
@akordowski
Copy link
Contributor Author

@nguyenalex836

I wanted to relay thanks from the team for this undertaking

Thank you very much! ☺️ It's my pleasure to give something back.

I'll have this merged shortly.

No rush! Thank you for your effort to review this big chunks.

Merged via the queue into github:main with commit b1a68cb Nov 8, 2024
48 checks passed
Copy link
Contributor

github-actions bot commented Nov 8, 2024

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

@akordowski akordowski deleted the fix/unify-docs-alerts-part-2 branch November 13, 2024 07:19
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants