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

Make Test your skills pages consistent #15579

Merged
merged 34 commits into from
Jun 7, 2022
Merged

Make Test your skills pages consistent #15579

merged 34 commits into from
Jun 7, 2022

Conversation

glmvc
Copy link
Contributor

@glmvc glmvc commented May 1, 2022

Summary

made "Test your skills!" pages of the Learn/HTML and Learn/CSS modules more consistent:

  • add tags where they where missing / incomplete
  • add missing sidebar in the background and borders skill test
  • adapt introduction sentences
  • adapt note box (under the introduction sentences) - the "However" part.
  • adapt headings to fit the articles title and use numbers instead of written out numbers (i thought this is easier to read and also in the discourse forum easier and clearer to handle)
  • adapt "Assessment or further help" sections to be uniform
  • adapt the code example (interactive editor) sentences and "boxes"

Motivation

to keep things consistent - i have done this "consistency changes" now a few times in prs and it was always appreciated.

i made a few decisions based on how most test your skills pages (including the ones for Learn/JavaScript...) were structured and written (e.g. the boxes below the interactive editros were written most of the time in the "shorter way", but not for the Learn/CSS part)

Metadata

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

@glmvc glmvc requested review from a team as code owners May 1, 2022 10:38
@glmvc glmvc requested review from dipikabh and removed request for a team May 1, 2022 10:38
@github-actions github-actions bot added the Content:Learn Learning area docs label May 1, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2022

Preview URLs

Flaws

Note! 21 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Learn/CSS/CSS_layout/Multiple-column_Layout
Title: Multiple-column layout
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/CSS_layout/Grids
Title: Grids
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/CSS_layout/Media_queries
Title: Beginner's guide to media queries
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/Building_blocks/Values_and_units
Title: CSS values and units
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/Building_blocks/Handling_different_text_directions
Title: Handling different text directions
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/Building_blocks/Images_media_form_elements
Title: Images, media, and form elements
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/Building_blocks/The_box_model
Title: The box model
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/CSS/Building_blocks/Backgrounds_and_borders
Title: Backgrounds and borders
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/HTML_text_fundamentals
Title: HTML text fundamentals
on GitHub
Flaw count: 8

  • macros:
    • /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h3 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h4 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h5 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • and 2 more flaws omitted
  • broken_links:
    • Link points to the page it's already on

External URLs

URL: /en-US/docs/Learn/CSS/CSS_layout/Grid_skills
Title: Test your skills: Grid
on GitHub


URL: /en-US/docs/Learn/CSS/CSS_layout/Multiple-column_Layout
Title: Multiple-column layout
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/CSS_layout/Floats_skills
Title: Test your skills: Floats
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/CSS_layout/Position_skills
Title: Test your skills: Positioning
on GitHub


URL: /en-US/docs/Learn/CSS/CSS_layout/rwd_skills
Title: Test your skills: Responsive web design and media queries
on GitHub


URL: /en-US/docs/Learn/CSS/CSS_layout/Grids
Title: Grids
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/CSS_layout/Multicol_skills
Title: Test your skills: Multicol
on GitHub


URL: /en-US/docs/Learn/CSS/CSS_layout/Flexbox_skills
Title: Test your skills: Flexbox
on GitHub


URL: /en-US/docs/Learn/CSS/CSS_layout/Media_queries
Title: Beginner's guide to media queries
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Writing_Modes_Tasks
Title: Test your skills: Writing modes and logical properties
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Box_Model_Tasks
Title: Test your skills: The box model
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Overflow_Tasks
Title: Test your skills: Overflow
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Cascade_tasks
Title: Test your skills: The Cascade
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Tables_tasks
Title: Test your skills: Tables
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Values_and_units
Title: CSS values and units
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Values_tasks
Title: Test your skills: Values and units
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Handling_different_text_directions
Title: Handling different text directions
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Images_media_form_elements
Title: Images, media, and form elements
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Test_your_skills_backgrounds_and_borders
Title: Test your skills: Backgrounds and borders
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/The_box_model
Title: The box model
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Selectors/Selectors_Tasks
Title: Test your skills: Selectors
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Sizing_tasks
Title: Test your skills: Sizing
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Backgrounds_and_borders
Title: Backgrounds and borders
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Images_tasks
Title: Test your skills: Images and form elements
on GitHub


URL: /en-US/docs/Learn/HTML/Multimedia_and_embedding/Video_and_audio_content/Test_your_skills:_Multimedia_and_embedding
Title: Test your skills: Multimedia and embedding
on GitHub


URL: /en-US/docs/Learn/HTML/Multimedia_and_embedding/Images_in_HTML/Test_your_skills:_HTML_images
Title: Test your skills: HTML images
on GitHub


URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Test_your_skills:_Advanced_HTML_text
Title: Test your skills: Advanced HTML text
on GitHub


URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Test_your_skills:_HTML_text_basics
Title: Test your skills: HTML text basics
on GitHub


URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/HTML_text_fundamentals
Title: HTML text fundamentals
on GitHub

No new external URLs


URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Test_your_skills:_Links
Title: Test your skills: Links
on GitHub

(this comment was updated 2022-06-03 17:31:27.128754)

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Lots of comments, but they are all minor edits that you may or may not agree with. Thank you!!!

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Thank you @glmvc for your efforts to keep the content consistent! Just like @estelle, I have added multiple comments, all involving minor edits.

For simplicity, consistency, and maintainability, I've suggested renaming all headings in "Test your skills" to "Task 1", "Task 2", and so on. The title of the page tells us what the task is about.

glmvc and others added 5 commits May 4, 2022 19:46
Co-authored-by: Estelle Weyl <estelle@openwebdocs.org>
Co-authored-by: Estelle Weyl <estelle@openwebdocs.org>
…s/index.md

Co-authored-by: Estelle Weyl <estelle@openwebdocs.org>
Co-authored-by: Estelle Weyl <estelle@openwebdocs.org>
…unds_and_borders/index.md

Co-authored-by: Estelle Weyl <estelle@openwebdocs.org>
glmvc and others added 5 commits May 4, 2022 20:13
…/test_your_skills_colon__html_images/index.md

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
…o_content/test_your_skills_colon__multimedia_and_embedding/index.md

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
@glmvc
Copy link
Contributor Author

glmvc commented May 4, 2022

@estelle, @dipikabh,
Thank you for reviewing and helping me out - I am glad that someone helps me and makes the changes even better :)
I left a few comments on the suggestions where I wasn't quite sure.

I made a few more "consistent changes" based on the suggestions and because I went back through all the "test your skills" pages (to be exact in Learn/HTML and Learn/CSS, where the CSS layout modul is still missing, which I will make soon), and I have did the tests too to see if they are working as intended.
I hope these additional adjustments/changes fit for you.

ps: I'm sorry for the numerous commits, since I am quite new to git and github, I found out a bit later that you can add the suggestions to the batch. 🤯

@wutthichai46 wutthichai46 mentioned this pull request May 5, 2022
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
@glmvc
Copy link
Contributor Author

glmvc commented May 7, 2022

Hi @dipikabh, I also improved the contrast in some interactive examples like it's mentioned in issue #2054
Here I've changed the images to fit the improved contrast values in mdn/css-examples.

I hope the images fit like this. I tried to make them the same as they were. But I did not know exactly how to make these screenshots, because I cannot get (even with compress) the same file size If the new screenshots don't suit, I will of course update them, but then someone would have to tell me how exactly to do it please...

important: note that pr #74 and pr #75 have to be ideally merged at the same time I think?

@dipikabh
Copy link
Contributor

Hi @glmvc, not sure what's pending on this PR. Is this waiting on the other PRs you mentioned to land?
Also, I see that some checks are failing.

@glmvc
Copy link
Contributor Author

glmvc commented Jun 3, 2022

Hey @dipikabh,

I've resolved the failed checks. (1 image was not compressed)

This pr should ideally be merged at the same time with the following prs from mdn/css-examples:

because here in the pr there are changes for them...

Sorry for the "crossover" with mdn/css-examples - afterwards this would have been something for a seperate pr 🤦‍♂️
Are you able to merge in mdn/css-examples? Or do we need to tell someone who can do it?


I made also a seperate pr (#16032) for the discussed "Assessment or further help" sections (to make them also consistent). But the prs are independent from each other.

Note pr Make mailto anchor work inside iframe which is also pending, but there is no change here in this pr yet (because I'm waiting for suggestions there).
But it should not hold up this pr any longer, unless you say it is requested because it is only a very small change.

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Thank you so much @glmvc for your work on this!

@dipikabh dipikabh merged commit 50bdaf8 into mdn:main Jun 7, 2022
@glmvc
Copy link
Contributor Author

glmvc commented Jun 8, 2022

@dipikabh you're welcome :) thank you for helping out! 🎉

@glmvc glmvc deleted the patch-3 branch June 8, 2022 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn Learning area docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants