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 "Assessment or further help" sections consistent #16032

Merged
merged 9 commits into from
Jul 11, 2022
Merged

Conversation

glmvc
Copy link
Contributor

@glmvc glmvc commented May 14, 2022

Summary

Like discussed and suggested in pr #15579:

  • adapt the "Assessment or further help" sections (at the end of assessments and test your skill articles) to be more consistent across the HTML and CSS learning modules
  • the other modules will follow if i move on in the learning section and if wanted of course

Motivation

To make things more consistent...

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 14, 2022 19:21
@glmvc glmvc requested review from estelle and removed request for a team May 14, 2022 19:21
@github-actions github-actions bot added the Content:Learn Learning area docs label May 14, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 14, 2022

Preview URLs

Flaws

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

URL: /en-US/docs/Learn/CSS/First_steps/Styling_a_biography_page
Title: Styling a biography page
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/CSS/Building_blocks/A_cool_looking_box
Title: A cool-looking box
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/CSS/Building_blocks/Creating_fancy_letterheaded_paper
Title: Creating fancy letterheaded paper
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/HTML/Element/h1 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/Fundamental_CSS_comprehension
Title: Fundamental CSS comprehension
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/CSS/Styling_text/Typesetting_a_homepage
Title: Typesetting a community school homepage
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/CSS/CSS_layout/Fundamental_Layout_Comprehension
Title: Fundamental layout comprehension
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/Structuring_a_page_of_content
Title: Structuring a page of content
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/Marking_up_a_letter
Title: Marking up a letter
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/HTML/Tables/Structuring_planet_data
Title: Structuring planet data
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/HTML/Multimedia_and_embedding/Mozilla_splash_page
Title: Mozilla splash page
on GitHub
Flaw count: 1

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

External URLs

URL: /en-US/docs/Learn/CSS/First_steps/Styling_a_biography_page
Title: Styling a biography page
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/Box_Model_Tasks
Title: Test your skills: The box model
on GitHub


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/Writing_Modes_Tasks
Title: Test your skills: Writing modes and logical properties
on GitHub


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/CSS/Building_blocks/Values_tasks
Title: Test your skills: Values and units
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/Cascade_tasks
Title: Test your skills: The Cascade
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/A_cool_looking_box
Title: A cool-looking box
on GitHub

No new external URLs


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/Overflow_Tasks
Title: Test your skills: Overflow
on GitHub


URL: /en-US/docs/Learn/CSS/Building_blocks/Creating_fancy_letterheaded_paper
Title: Creating fancy letterheaded paper
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Building_blocks/Fundamental_CSS_comprehension
Title: Fundamental CSS comprehension
on GitHub

No new external URLs


URL: /en-US/docs/Learn/CSS/Styling_text/Typesetting_a_homepage
Title: Typesetting a community school homepage
on GitHub

No new external URLs


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/Position_skills
Title: Test your skills: Positioning
on GitHub


URL: /en-US/docs/Learn/CSS/CSS_layout/Fundamental_Layout_Comprehension
Title: Fundamental layout comprehension
on GitHub


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/Floats_skills
Title: Test your skills: Floats
on GitHub


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/HTML/Introduction_to_HTML/Structuring_a_page_of_content
Title: Structuring a page of content
on GitHub

No new external URLs


URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Marking_up_a_letter
Title: Marking up a letter
on GitHub

No new external URLs


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/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:_Links
Title: Test your skills: Links
on GitHub


URL: /en-US/docs/Learn/HTML/Tables/Structuring_planet_data
Title: Structuring planet data
on GitHub

No new external URLs


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/Multimedia_and_embedding/Mozilla_splash_page
Title: Mozilla splash page
on GitHub

(this comment was updated 2022-06-29 18:18:37.752482)

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.

Thank you.
Most of my edits are all the same: based on removing the e.g. My reasoning is on the last one.

@glmvc glmvc requested a review from estelle June 14, 2022 19:55
@dipikabh
Copy link
Contributor

About the sentence:

"Details of what you have already tried, and what you would like us to do, e.g. if you are stuck and need help, or want an assessment."

I agree with @estelle that the two commas should go and that we should state the latter phrase as an example. My only nit is about how we state that example.

As per MDN's writing style guide, we should use contractions such as i.e. and e.g. inside parenthesis. I'm not sure how widely this guideline has been followed on MDN, but if we try to stick to this guideline in this instance, we can rephrase the sentence as:

"Details of what you have already tried and what you would like us to do; for example, tell us if you're stuck and need help or want an assessment."

@glmvc
Copy link
Contributor Author

glmvc commented Jun 20, 2022

Hi @dipikabh, thanks for your input and suggestion, I think we should go with the sentence you suggested 🎉
Should we wait for @estelle's thoughts or can I start replacing the sentences?
Thank you in advance :)

@estelle
Copy link
Member

estelle commented Jun 27, 2022

Anything @dipikabh suggests is fine by me. She's an excellent tech editor!

@glmvc
Copy link
Contributor Author

glmvc commented Jun 29, 2022

hey @dipikabh, I've changed the sentences according to your suggestion (HTML and CSS Learning Areas).

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.

👍

@glmvc
Copy link
Contributor Author

glmvc commented Jul 5, 2022

@estelle i think we are ready to merge :)

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.

thank you!

@estelle estelle merged commit ace1400 into mdn:main Jul 11, 2022
@glmvc glmvc deleted the patch-5 branch July 12, 2022 16:40
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