Skip to content

Conversation

glmvc
Copy link
Contributor

@glmvc glmvc commented Apr 24, 2022

Summary

made overview pages of modules in the learning area and the references more consistent:

  • the word "Web" is most of the time written uppercase in the context of "the Web" - so i changed the lowercase ones across the articles
  • renaming the "Conclusion" sections in the Complete Beginner's Guide articles to "Summary" - like it's in the other modules of the learning area
  • making "In this module" sections uniform
  • add CSS layout cookbook to "See also" section of learn CSS layout

Motivation

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

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 April 24, 2022 10:27
@glmvc glmvc requested review from dipikabh and removed request for a team April 24, 2022 10:27
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:Learn Learning area docs labels Apr 24, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 24, 2022

Preview URLs

Flaws

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

URL: /en-US/docs/Learn/HTML/Multimedia_and_embedding/Adding_vector_graphics_to_the_Web
Title: Adding vector graphics to the web
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/Getting_started
Title: Getting started with HTML
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/Getting_started_with_the_web/How_the_Web_works
Title: How the web works
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Learn/Getting_started_with_the_web/CSS_basics
Title: CSS basics
on GitHub
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /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/Getting_started_with_the_web/JavaScript_basics
Title: JavaScript basics
on GitHub
Flaw count: 1

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

External URLs

URL: /en-US/docs/Learn/HTML
Title: Structuring the web with HTML
on GitHub

No new external URLs


URL: /en-US/docs/Learn/HTML/Multimedia_and_embedding
Title: Multimedia and embedding
on GitHub

No new external URLs


URL: /en-US/docs/Learn/HTML/Multimedia_and_embedding/Adding_vector_graphics_to_the_Web
Title: Adding vector graphics to the web
on GitHub

No new external URLs


URL: /en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started
Title: Getting started with HTML
on GitHub

No new external URLs


URL: /en-US/docs/Learn/Front-end_web_developer
Title: Front-end web developer
on GitHub


URL: /en-US/docs/Learn/Getting_started_with_the_web
Title: Getting started with the web
on GitHub

No new external URLs


URL: /en-US/docs/Learn/Getting_started_with_the_web/How_the_Web_works
Title: How the web works
on GitHub

No new external URLs


URL: /en-US/docs/Learn/Getting_started_with_the_web/CSS_basics
Title: CSS basics
on GitHub

No new external URLs


URL: /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
Title: JavaScript basics
on GitHub


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

No new external URLs


URL: /en-US/docs/Web/HTML
Title: HTML: HyperText Markup Language
on GitHub

No new external URLs


URL: /en-US/docs/Web/CSS
Title: CSS: Cascading Style Sheets
on GitHub

(this comment was updated 2022-04-29 19:46:29.475391)

@dipikabh
Copy link
Contributor

Hello @glmvc, thanks for the PR. I'm afraid the "web" to "Web" change is not correct. Check this: https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Writing_style_guide#capitalization.
Also because we follow sentence casing in headings: https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Writing_style_guide#page_titles

I'll review the other changes shortly.

@dipikabh
Copy link
Contributor

  • renaming the "Conclusion" sections in the Complete Beginner's Guide articles to "Summary" - like it's in the other modules of the learning area

I think it is better to leave the section headings as "Conclusion" in Getting started with the Web. If you notice, the "Conclusion" section only exists on the "HTML basics", "CSS basics", and "Javascript basics" pages and the content of these sections is very different from the "Summary" sections in the other modules of the learning area. In fact, changing those "Conclusion" headings to "Summary" might almost be incorrect because we're not technically summarizing the concepts covered on the page, just concluding with the resultant web page after following the instructions.

@github-actions github-actions bot added the Content:CSS Cascading Style Sheets docs label Apr 29, 2022
@glmvc
Copy link
Contributor Author

glmvc commented Apr 29, 2022

@dipikabh Thank you for reviewing this pr and helping out!

I'm afraid the "web" to "Web" change is not correct. ...

Also thanks for referring to the writing style guides - I somehow did not get the idea to check there before making changes - I am very sorry! I have of course undone the affected changes. But I have changed the spelling of the article titles to sentence case - I hope this fits better now :)
Personally, I also like this spelling better, but I saw the other one more often in the learning area so I thought this one would be the preferred one. But now everything is clear to me thanks to the writing guides you referred.

I think it is better to leave the section headings as "Conclusion" in Getting started with the Web. ...

I agree with you about the "Conclusion" sections, it was a too quick change on my part, without really thinking about it more carefully - also sorry. (I have of course undone that too)

glmvc and others added 2 commits April 29, 2022 20:56
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.

Looks good. Thank you!

@dipikabh dipikabh merged commit 15ed3e4 into mdn:main May 2, 2022
@glmvc glmvc deleted the patch-2 branch May 3, 2022 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:Learn Learning area docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants