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] Remove inline styles from Web/API docs #5438

Closed
wbamberg opened this issue May 28, 2021 · 6 comments
Closed

[Markdown] Remove inline styles from Web/API docs #5438

wbamberg opened this issue May 28, 2021 · 6 comments
Assignees
Labels
help wanted If you know something about this topic, we would love your help! MDN:Project Anything related to larger core projects on MDN

Comments

@wbamberg
Copy link
Collaborator

In preparation for moving to Markdown we'll need to remove inline styles from almost all elements in our documentation. I've done this for JS and am close for CSS.

This issue is to track the work to remove them for Web/API. I count 268 pages under https://developer.mozilla.org/en-US/docs/Web/API that use the style attribute. Proportionately this is less than CSS, but it's still enough that I'd be very happy to have people help out with the work.

So I have crafted a spreadsheet: https://docs.google.com/spreadsheets/d/1HSt5T4b2GAsHhrJiEFGugvFWR5EcujA1-6QlRKIa53o/edit?usp=sharing to coordinate things. If you think you might want to help, ask for editor access to the spreadsheet and also add a comment here so I know who you are. Please note though that this is unlikely to be a suitable "first task" on MDN, so it would be best for people who already have some experience contributing.

My experience with the CSS docs is that many of the changes are likely to be trivial (the style can just be removed) and some are much more involved. In Markdown-land we can keep some inline styles if we really have to: in particular, we're keeping complex tables in HTML, so they can continue to contain inline styles and things will still work. But even in these cases I'd prefer us to find alternatives if we can.

@wbamberg wbamberg added help wanted If you know something about this topic, we would love your help! needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels May 28, 2021
@hamishwillee
Copy link
Collaborator

hamishwillee commented May 31, 2021

Very happy to help with this (once I have finished the Firefox updates this week). I assume more important to you than Page macro fixes. I have added me to assignee list.

@hamishwillee hamishwillee self-assigned this May 31, 2021
@wbamberg
Copy link
Collaborator Author

Thanks @hamishwillee , that would be most appreciated!

@Blakelist7
Copy link
Contributor

@wbamberg sure, I would like to help on this. :)

@wbamberg
Copy link
Collaborator Author

wbamberg commented Jun 4, 2021

@Blakelist7 , sounds great! Please see the "Instructions" page in https://docs.google.com/spreadsheets/d/1HSt5T4b2GAsHhrJiEFGugvFWR5EcujA1-6QlRKIa53o/edit?usp=sharing to understand how we're organizing this work, and please feel free to ask in here if you have any questions either about the process or about the actual changes to make. I expect that in most cases the style isn't doing anything useful in the page and can just be removed. There will be some cases that are trickier though and require some rework.

@Blakelist7
Copy link
Contributor

Blakelist7 commented Jun 5, 2021

Hey, @wbamberg please grant edit access.

@wbamberg
Copy link
Collaborator Author

wbamberg commented Sep 1, 2021

#8503 did the last bit of this, so this issue can be closed!

@wbamberg wbamberg closed this as completed Sep 1, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
help wanted If you know something about this topic, we would love your help! MDN:Project Anything related to larger core projects on MDN
Projects
None yet
Development

No branches or pull requests

4 participants