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

New docs area for URL semantics, relocate some HTTP pages here #35202

Merged
merged 17 commits into from
Aug 26, 2024

Conversation

Josh-Cena
Copy link
Member

I assume I have gotten enough support in https://github.com/orgs/mdn/discussions/700, so this is the first part of the proposal. I have created a new "URL" area, and moved a few HTTP pages that talk about URLs here.

@Josh-Cena Josh-Cena requested review from a team as code owners July 28, 2024 19:36
@Josh-Cena Josh-Cena requested review from jpmedley, Elchi3 and estelle and removed request for a team July 28, 2024 19:36
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:HTML Hypertext Markup Language docs Content:WebExt WebExtensions docs Content:WebAPI Web API docs Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label Content:HTTP HTTP docs Content:Glossary Glossary entries system [PR only] Infrastructure and configuration for the project size/m [PR only] 51-500 LoC changed labels Jul 28, 2024
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

github-actions bot commented Jul 28, 2024

Preview URLs (37 pages)
Flaws (18)

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

URL: /en-US/docs/Web/API/Fenced_frame_API
Title: Fenced Frame API
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/Navigator/runAdAuction does not exist

URL: /en-US/docs/Web/HTTP/Basics_of_HTTP
Title: Basics of HTTP
Flaw count: 5

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs
  • broken_links:
    • Can't resolve /en-US/docs/Web/HTTP/Frame_and_message_structure_in_HTTP_2
    • Can't resolve /en-US/docs/Web/HTTP/Connection_management_in_HTTP_2

URL: /en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors
Title: CSP: frame-ancestors
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources
Title: CSP source values
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Session
Title: A typical HTTP session
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs

URL: /en-US/docs/Web/HTTP/Status/421
Title: 421 Misdirected Request
Flaw count: 3

  • macros:
    • /en-US/docs/Web/HTTP/Basics_of_HTTP/Identifying_resources_on_the_Web does not exist
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/HTTP/Basics_of_HTTP/Choosing_between_www_and_non-www_URLs
External URLs (6)

URL: /en-US/docs/Web/OpenSearch
Title: OpenSearch description format


URL: /en-US/docs/Web/API/Canvas_API/Tutorial/Pixel_manipulation_with_canvas
Title: Pixel manipulation with canvas


URL: /en-US/docs/Web/URI/Authority
Title: URI authority


URL: /en-US/docs/Web/URI/Fragment
Title: URI fragment


URL: /en-US/docs/Web/URI/Schemes
Title: URI schemes


URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts
Title: Content scripts

(comment last updated: 2024-08-26 15:29:45)

files/en-us/web/url/index.md Outdated Show resolved Hide resolved
@hamishwillee
Copy link
Collaborator

The sidebar's far from pretty, but I think it makes sense.

Agreed. At least all the docs are present and it gives us a baseline for discussion. I'm happy enough with it.

There are a couple more suggestions there, but I think this is good. Let's see if we can also get review from @bsmth (I'll approve tomorrow)

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

@bsmth Can you scan this. I think it is good, but extra eyes would be welcome.

@Josh-Cena Approved, but would be good to give Brian a chance to look at it if he is available today.

files/en-us/web/uri/index.md Outdated Show resolved Hide resolved
Co-authored-by: Brian Thomas Smith <[email protected]>

Any of those URLs can be typed into your browser's address bar to tell it to load the associated page (resource).

A URL is composed of different parts, some mandatory and others optional. A more complex example might look like this:
Copy link
Member

Choose a reason for hiding this comment

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

Do you want to mention that the parts of a URL are described in detail below?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this is fine as-is. The details below aren't directly dependent on this example anyway.

Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Thanks a lot, Josh & Hamish. I'm also +1 on this with some minor nits. Also agree about sidebar improvements, but this is a great start

@Josh-Cena Josh-Cena merged commit 6b730e3 into mdn:main Aug 26, 2024
10 checks passed
@Josh-Cena Josh-Cena deleted the url-area branch August 26, 2024 15:41
@Josh-Cena
Copy link
Member Author

Thanks to you both for the reviews!

yin1999 added a commit to mdn/translated-content that referenced this pull request Aug 27, 2024
yin1999 added a commit to mdn/translated-content that referenced this pull request Aug 27, 2024
yin1999 added a commit to mdn/translated-content that referenced this pull request Aug 27, 2024
* zh-cn: sync translated content

* Move URL related docs to the new area

ref: mdn/content#35202

---------

Co-authored-by: allo <[email protected]>
yin1999 added a commit to mdn/translated-content that referenced this pull request Aug 27, 2024
* zh-tw: sync translated content

* Move URL related docs to the new area

ref: mdn/content#35202

---------

Co-authored-by: allo <[email protected]>
@bsmth
Copy link
Member

bsmth commented Aug 27, 2024

BTW @Josh-Cena there's some fixes to be done on sidebars: mdn/yari#11700

At the moment, adding the links to the new locations, but we should have a think if it makes sense to have these entries here at all (under Resources and URIs).

@Josh-Cena
Copy link
Member Author

Great, thanks!

I don't have any opinions on how the HTTP sidebar should be structured.

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:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs Content:WebExt WebExtensions docs size/l [PR only] 501-1000 LoC changed system [PR only] Infrastructure and configuration for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants