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.

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(docs): link first child of every description term in post-processing #9862

Merged
merged 6 commits into from
Oct 30, 2023
Merged

fix(docs): link first child of every description term in post-processing #9862

merged 6 commits into from
Oct 30, 2023

Conversation

KartikSoneji
Copy link
Contributor

Summary

Fixes #9817

Problem

Markdown engine generates <dl> tags that include linking metadata.

Solution

Populate the href attribute during postprocessing.

How did you test this change?

Checked that the old code and the new version both generate the same markup for a few pages.
Haven't verified against the full build.

@github-actions github-actions bot added macros tracking issues related to kumascript macros markdown markdown related issues and pull requests labels Oct 20, 2023
@KartikSoneji KartikSoneji force-pushed the fix/dont-modify-md-engine branch from f063ffb to 24d9bb7 Compare October 21, 2023 16:04
@KartikSoneji KartikSoneji mentioned this pull request Oct 21, 2023
Closed
3 tasks
@caugner caugner self-assigned this Oct 24, 2023
@caugner caugner requested a review from a team as a code owner October 27, 2023 15:53
@caugner caugner marked this pull request as draft October 27, 2023 17:14
@caugner caugner added the p1 We will address this soon and will provide capacity from our team for it in the next few releases. label Oct 27, 2023
@caugner caugner temporarily deployed to xyz October 30, 2023 10:07 — with GitHub Actions Inactive
@caugner
test(markdown): update test expectation
b44e2ff 
Definition terms now get anchor links.
@caugner
Copy link
Contributor

caugner commented Oct 30, 2023

@KartikSoneji This branch is now deployed at https://developer.allizom.xyz/ for review before merging.

@caugner caugner marked this pull request as ready for review October 30, 2023 17:13
@caugner caugner changed the title fix(m2h): make <dt> clickable in postprocessing fix(docs): make description terms clickable in postprocessing Oct 30, 2023
@caugner caugner merged commit 0295813 into mdn:main Oct 30, 2023
10 checks passed
@caugner caugner changed the title fix(docs): make description terms clickable in postprocessing fix(docs): link first child of every description term in post-processing Oct 30, 2023
@github-actions github-actions bot mentioned this pull request Oct 30, 2023
Merged
@KartikSoneji
Copy link
Contributor Author

@caugner sorry didn't get a chance to review it but it makes sense to use the same id generation code to determine which element to link.
Thank you for finishing this.

@KartikSoneji KartikSoneji deleted the fix/dont-modify-md-engine branch October 30, 2023 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Josh-Cena Josh-Cena Josh-Cena left review comments

@caugner caugner caugner left review comments

Assignees

@caugner caugner

Labels
macros tracking issues related to kumascript macros markdown markdown related issues and pull requests p1 We will address this soon and will provide capacity from our team for it in the next few releases.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Adding anchor links to <dt> should not modify Markdown engine
3 participants
@KartikSoneji @caugner @Josh-Cena