help: Do not allow autolinks for help center docs.

mdxjs does not allow autolinks.
See https://github.com/mdx-js/mdx/issues/1049.
We also added a linter check for the same.
Preparatory commit for #30451.
This commit is contained in:
Shubham Padia 2024-06-17 14:03:36 +00:00 committed by Tim Abbott
parent 7ff1227984
commit a98363fe36
4 changed files with 11 additions and 3 deletions

View File

@ -132,7 +132,7 @@ names.
!!! tip "" !!! tip ""
<https://emojipedia.org/> may be a helpful resource. [https://emojipedia.org/](https://emojipedia.org/) may be a helpful resource.
{end_tabs} {end_tabs}

View File

@ -1,4 +1,4 @@
1. Go to <https://selfhosting.zulip.com/serverlogin/>. 1. Go to [https://selfhosting.zulip.com/serverlogin/](https://selfhosting.zulip.com/serverlogin/).
1. Fill out the requested server information, and click **Continue**. 1. Fill out the requested server information, and click **Continue**.

View File

@ -15,7 +15,7 @@ website (e.g., **Sponsors** or **Acknowledgements**).
logo](https://github.com/zulip/zulip/tree/main/static/images/logo), logo](https://github.com/zulip/zulip/tree/main/static/images/logo),
preferably a **round Zulip icon** (available in `.png` and `.svg` formats). preferably a **round Zulip icon** (available in `.png` and `.svg` formats).
1. Link to <https://zulip.com/>. 1. Link to [https://zulip.com/](https://zulip.com/).
2. If appropriate, add a brief description: 2. If appropriate, add a brief description:

View File

@ -839,6 +839,14 @@ markdown_rules = RuleList(
{ {
"pattern": r"\[(?P<url>[^\]]+)\]\((?P=url)\)", "pattern": r"\[(?P<url>[^\]]+)\]\((?P=url)\)",
"description": "Linkified Markdown URLs should use cleaner <http://example.com> syntax.", "description": "Linkified Markdown URLs should use cleaner <http://example.com> syntax.",
"exclude": {"help/"},
},
{
"pattern": r"<http(s?)://[^>]+>",
"description": """Autolinks are not allowed in /help documentation due to the upcoming migration to mdx.
Use Linkified markdown URLs [url](url) instead.
See https://github.com/mdx-js/mdx/issues/1049 for more info.""",
"include_only": {"help/"},
}, },
{ {
"pattern": "https://zulip.readthedocs.io/en/latest/[a-zA-Z0-9]", "pattern": "https://zulip.readthedocs.io/en/latest/[a-zA-Z0-9]",