-
Notifications
You must be signed in to change notification settings - Fork 197
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 improperly formatted internal deep links; prevent them from happening again. #4902
Conversation
👋 🤖 🤔 Hello, @pepopowitz! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
docs/apis-tools/frontend-development/03-forms/02-embed-forms/02-embed-in-javascript.md
Outdated
Show resolved
Hide resolved
docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md
Outdated
Show resolved
Hide resolved
docs/apis-tools/frontend-development/03-forms/02-embed-forms/02-embed-in-javascript.md
Outdated
Show resolved
Hide resolved
docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md
Outdated
Show resolved
Hide resolved
2a41435
to
d6b80af
Compare
@@ -1,5 +1,5 @@ | |||
extends: existence | |||
message: "Improper link format: '%s'. Please use relative URLs." | |||
message: "Improper link format: `%s`. Please use relative URLs." |
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.
I noticed that my rule was emitting the links and GitHub was actually processing them as markdown, turning them into a clickable link 😅 That's not what we want, we want to see the source of the link. So I changed all these other rules to do the same.
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.
😍 🤩
Ok, I was creeping on this PR earlier and I LOOOOOVE that we can lint for it! 🙌 Thank you for correcting and linting it. See ya never improperly formatted internal deep links!
Description
Discovered in #4872.
Once this is merged, I'll propagate to my docusaurus 3 branch.
What's wrong with these links?
The links in question are internal, targeting a document via file path including extension...and they include a slash (/) before the hash (#) of the anchor on the target page.
Docusaurus 2 appears to have no problem rendering links with this format. None of the links I've adjusted in this PR seem to be broken in production.
In Docusaurus 3, the engine does not treat these links as internal, and it does not attempt to translate the file path into the corresponding URL. You can see this happening in this build, in my docusaurus 3 working branch.
Both versions of Docusaurus appear to have no problem with the format where the slash is removed. Thus, we can update these links in
main
now, instead of in the docusaurus 3 branch.What it looks like when an infraction is introduced
I temporarily added some infractions to this PR, to generate these comments:
When should this change go live?
bug
orsupport
label)available & undocumented
label)hold
label)low prio
label)PR Checklist
/docs
directory (aka/next/
)./versioned_docs
directory.@camunda/tech-writers
unless working with an embedded writer.