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.

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

Doc: Don't use markdown in the callout section #50437

Merged
merged 2 commits into from
May 8, 2023

Conversation

t-hamano
Copy link
Contributor

@t-hamano t-hamano commented May 8, 2023

Related to: #50110, #50090

What?

This PR rewrites the markdown to an anchor element to ensure that the link in the callout section of the document displays correctly.

This PR rewrites the markdown to an anchor element to ensure that the link in the callout section of the document displays correctly.


https://developer.wordpress.org/block-editor/how-to-guides/themes/theme-json/#patterns

theme-json


https://developer.wordpress.org/block-editor/reference-guides/packages/packages-blocks/

blocks


https://developer.wordpress.org/block-editor/reference-guides/packages/packages-e2e-test-utils-playwright/

ese-test-utils-playwright

Why?

As noted in this comment, if HTML is used within the callout section, it appears to display correctly. This PR uses the a and code elements, which also appear to be rendered correctly in the README on GitHub.

@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label May 8, 2023
@t-hamano t-hamano requested review from gziolo and ryanwelcher May 8, 2023 15:03
@t-hamano t-hamano self-assigned this May 8, 2023
@t-hamano t-hamano marked this pull request as ready for review May 8, 2023 15:07
@t-hamano t-hamano changed the title Doc: Rewrite links from markdown to anchor elements in the callout section Doc: Don't use markdown in the callout section May 8, 2023
Copy link
Member

@ndiego ndiego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks @t-hamano 🚢

@t-hamano
Copy link
Contributor Author

t-hamano commented May 8, 2023

Thanks for the review, @ndiego!

I noticed that I had left out one part about rewriting with code elements, so I responded with 8783f12👍

code

Copy link
Member

@ndiego ndiego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

@github-actions
Copy link

github-actions bot commented May 8, 2023

Flaky tests detected in 8783f12.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4916745261
📝 Reported issues:

@t-hamano t-hamano merged commit 0c88718 into trunk May 8, 2023
@t-hamano t-hamano deleted the docs/use-atag-in-callout branch May 8, 2023 16:51
@github-actions github-actions bot added this to the Gutenberg 15.8 milestone May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants