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

Merged

nguyenalex836 merged 3 commits into github:main from akordowski:fix/unify-docs-alerts-part-3

Nov 12, 2024

Contributor

akordowski commented Nov 7, 2024 •

edited

Loading

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 3 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.

akordowski requested a review from a team as a code owner

November 7, 2024 18:54

github-actions bot added the triage label

Contributor

github-actions bot commented Nov 7, 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
`organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.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
`organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md`	ghec	ghec
`organizations/collaborating-with-your-team/about-team-discussions.md`	ghes@ 3.12 3.11 3.10	ghes@ 3.12 3.11 3.10
`organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md`	ghec	ghec
`organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md`	ghec	ghec
`organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-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
`organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization.md`	fpt ghec	fpt ghec
`organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md`	ghec	ghec
`organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-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
`organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.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
`organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-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
`organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication.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
`organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-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
`organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/viewing-whether-users-in-your-organization-have-2fa-enabled.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
`organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md`	ghes@ 3.14 3.13 3.12 3.11 3.10	ghes@ 3.14 3.13 3.12 3.11 3.10
`organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md`	ghes@ 3.14 3.13 3.12 3.11 3.10	ghes@ 3.14 3.13 3.12 3.11 3.10
`organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md`	ghes@ 3.14 3.13 3.12 3.11 3.10	ghes@ 3.14 3.13 3.12 3.11 3.10
`organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.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
`organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md`	fpt ghec	fpt ghec
`organizations/managing-membership-in-your-organization/removing-a-member-from-your-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
`organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions.md`	fpt ghec	fpt ghec
`organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md`	fpt ghec	fpt ghec
`organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md`	fpt ghec	fpt ghec
`organizations/managing-organization-settings/archiving-an-organization.md`	fpt ghec ghes@ 3.14 3.13 3.12 3.11	fpt ghec ghes@ 3.14 3.13 3.12 3.11
`organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization.md`	fpt ghec	fpt ghec
`organizations/managing-organization-settings/converting-an-organization-into-a-user.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
`organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.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
`organizations/managing-organization-settings/deleting-an-organization-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
`organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-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
`organizations/managing-organization-settings/managing-base-permissions-for-projects.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
`organizations/managing-organization-settings/renaming-an-organization.md`	fpt ghec ghes@ 3.14 3.13 3.12 3.11 3.10	fpt ghec ghes@ 3.14 [3.13](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/rena...[Comment body truncated]

akordowski mentioned this pull request

Inconsistent labeling of Note/Warning blocks #35195

Closed

1 task

Contributor

nguyenalex836 commented Nov 7, 2024

Just a note for the record! This series of PRs will be reviewed and merged in order, to keep this process as simple and efficient as possible 💛

akordowski force-pushed the fix/unify-docs-alerts-part-3 branch from 898d8c4 to 32ad841 Compare

November 8, 2024 11:32

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

		@@ -65,7 +65,7 @@ To troubleshoot, make sure that your `_config.yml` file follows these rules:

		This error means that one of the pages on your site includes an invalid datetime.

		To troubleshoot, search the file in the error message and the file's layouts for calls to any date-related Liquid filters. Make sure that any variables passed into date-related Liquid filters have values in all cases and never pass `nil` or `""`. For more information, see [Filters](https://shopify.dev/docs/api/liquid/filters) in the Liquid documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski Howdy! 👋 It looks like an update made by our team is being reverted here - 25182f4

Can we ensure the update our team made remains intact? 💛

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

		@@ -121,22 +121,22 @@ To troubleshoot, make sure the YAML files in your __data_ folder follow these ru

		{% data reusables.pages.yaml-linter %}

		For more information about Jekyll data files, see [Data Files](https://jekyllrb.com/docs/datafiles/) in the Jekyll documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski Similar situation here! It looks like these quotation marks were recently removed by our team in an update - 25182f4

Can we ensure the quotation marks remain absent? 💛

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               ## Markdown errors
               This error means that your repository contains Markdown errors.
               To troubleshoot, make sure you are using a supported Markdown processor. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll)."
-              Then, make sure the file in the error message uses valid Markdown syntax. For more information, see [Markdown: Syntax](https://daringfireball.net/projects/markdown/syntax) on Daring Fireball.

Contributor

nguyenalex836 Nov 8, 2024 •

edited

Loading

@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               ## Missing docs folder
               This error means that you have chosen the `docs` folder on a branch as your publishing source, but there is no `docs` folder in the root of your repository on that branch.
               To troubleshoot, if your `docs` folder was accidentally moved, try moving the `docs` folder back to the root of your repository on the branch you chose for your publishing source. If the `docs` folder was accidentally deleted, you can either:
-              * Use Git to revert or undo the deletion. For more information, see [git-revert](https://git-scm.com/docs/git-revert.html) in the Git documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

		@@ -146,38 +146,38 @@ This error means that your repository includes a submodule that doesn't exist or

		{% data reusables.pages.remove-submodule %}

		If you do want to use a submodule, initialize the submodule. For more information, see [Git Tools - Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in the _Pro Git_ book.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               ## Relative permalinks configured
               This errors means that you have relative permalinks, which are not supported by {% data variables.product.prodname_pages %}, in your `_config.yml` file.
-              Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see [Permalinks](https://jekyllrb.com/docs/permalinks/) in the Jekyll documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               To troubleshoot, remove the `relative_permalinks` line from your `_config.yml` file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)."
               ## Syntax error in 'for' loop
               This error means that your code includes invalid syntax in a Liquid `for` loop declaration.
-              To troubleshoot, make sure all `for` loops in the file in the error message have proper syntax. For more information about proper syntax for `for` loops, see [Tags](https://shopify.dev/docs/api/liquid/tags/for) in the Liquid documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski One more update from our team being reverted here! 25182f4

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               ## Tag not properly closed
               This error message means that your code includes a logic tag that is not properly closed. For example, {% raw %}`{% capture example_variable %}` must be closed by `{% endcapture %}`{% endraw %}.
-              To troubleshoot, make sure all logic tags in the file in the error message are properly closed. For more information, see [Tags](https://shopify.dev/docs/api/liquid/tags) in the Liquid documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski One more update from our team being reverted here! 25182f4

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               ## Tag not properly terminated
               This error means that your code includes an output tag that is not properly terminated. For example, {% raw %}`{{ page.title }` instead of `{{ page.title }}`{% endraw %}.
-              To troubleshoot, make sure all output tags in the file in the error message are terminated with `}}`. For more information, see [Objects](https://shopify.dev/docs/api/liquid/objects) in the Liquid documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski One more update from our team being reverted here! 25182f4

nguyenalex836 reviewed

View reviewed changes

...-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md Outdated

               ## Unknown tag error
               This error means that your code contains an unrecognized Liquid tag.
-              To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see [Variables](https://jekyllrb.com/docs/variables/) in the Jekyll documentation.

Contributor

nguyenalex836 Nov 8, 2024

@akordowski One more update from our team being reverted here! 25182f4

Contributor Author

akordowski commented Nov 8, 2024

@nguyenalex836 I will review the files over the weekend also for the part 4 branch. You can then continue with the review next week. Thank you!

akordowski added 2 commits

November 9, 2024 13:38


          Fix inconsistent alerts by using the markdown notation

353738b


          Rebase main branch, fix conflicts

b9f8c61

akordowski force-pushed the fix/unify-docs-alerts-part-3 branch from 169ace7 to b9f8c61 Compare

November 9, 2024 13:10

Contributor Author

akordowski commented Nov 9, 2024

@nguyenalex836 I fixed and reviewed the branches part 3 & 4. If you notice something please notify me. Thank you!

nguyenalex836 approved these changes

View reviewed changes

Contributor

nguyenalex836 commented Nov 11, 2024

@akordowski Part 3 approved! ✨ 🚀

I do need to grab a review from our Site Policy team since our site policy files were modified, but we should hopefully have this merged soon after 💛 thank you!!

khxu approved these changes

View reviewed changes


          Merge branch 'main' into fix/unify-docs-alerts-part-3

96de6f7

nguyenalex836 added content and removed triage labels

nguyenalex836 enabled auto-merge

November 12, 2024 00:04

nguyenalex836 added this pull request to the merge queue

Merged via the queue into github:main with commit 7453457

53 of 54 checks passed

Contributor

github-actions bot commented Nov 12, 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 deleted the fix/unify-docs-alerts-part-3 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