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

[Markdown] Prepare Learn docs for Markdowning #9218

Closed
13 tasks done
wbamberg opened this issue Sep 24, 2021 · 2 comments
Closed
13 tasks done

[Markdown] Prepare Learn docs for Markdowning #9218

wbamberg opened this issue Sep 24, 2021 · 2 comments
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@wbamberg
Copy link
Collaborator

wbamberg commented Sep 24, 2021

This is a tracking bug for the work we have to do to prepare the Learn documentation for Markdown conversion.

@wbamberg
Copy link
Collaborator Author

wbamberg commented Oct 6, 2021

This comment is an analysis of <table> conversion in the Learn area.

There are 290 tables in the Learn docs. h2m can convert just 37 of them.

As usual, there are two questions to answer here:

  • are there many currently unconvertible tables we could make convertible, given a bit of work?
  • are there some tables that are currently getting converted, that should not be?

Converting more tables

290-37 = 253 tables are unconverted. Of these, 220 are tables of a particular form, like this:

Screen Shot 2021-10-05 at 8 07 36 PM

Tables like this are not convertible because they have a header column, and I think this design is an editorial choice we should respect. So there's only at most 33 tables that might be made convertible. I've had a look through these, and I don't think it makes sense to try to make them convertible - they are generally unconvertible because they have cells containing block elements, or header columns, or other good reasons.

Converting fewer tables

The good reason for not converting tables that could be converted is that their GFM representation would be too wide to be readable, per https://developer.mozilla.org/en-US/docs/MDN/Contribute/Markdown_in_MDN#gfm_table_maximum_width.

Of the 37 convertible tables, 16 have a GFM representation wider than 150 characters, so I'll suppress conversion for those tables: #9604.

@wbamberg
Copy link
Collaborator Author

wbamberg commented Oct 9, 2021

Converted in #9632.

@wbamberg wbamberg closed this as completed Oct 9, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

1 participant