-
Notifications
You must be signed in to change notification settings - Fork 60.3k
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 3 #35222
Fix inconsistent alerts by using the markdown notation - part 3 #35222
Conversation
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 💛 |
898d8c4
to
32ad841
Compare
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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? 💛
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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? 💛
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski Similarly to comment above, can we ensure the quotation marks remain absent? 💛
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski One more update from our team being reverted here! 25182f4
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski One more update from our team being reverted here! 25182f4
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski One more update from our team being reverted here! 25182f4
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akordowski One more update from our team being reverted here! 25182f4
@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! |
169ace7
to
b9f8c61
Compare
@nguyenalex836 I fixed and reviewed the branches part 3 & 4. If you notice something please notify me. Thank you! |
@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!! |
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 ⚡ |
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
andwarning
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).
data
directory.For content changes, I have completed the self-review checklist.