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

Fix scheme in CORS example code #7447

Merged
merged 2 commits into from
Jul 30, 2021
Merged

Conversation

uberswe
Copy link
Contributor

@uberswe uberswe commented Jul 30, 2021

Issue number to be fixed

N/A, I did not see any issue related to this

What was wrong/why is this fix needed? (quick summary only)

The example uses https:// instead of http:// without mentioning that this is wrong. The same example is later referenced with http:// on https://github.com/mdn/content/blob/main/files/en-us/web/http/cors/index.html#L216.

Anything else that could help us review it

I found this confusing as I was trying to understand if CORS cares about the scheme and the example implies that it does not without specifically stating that it does or not.

@uberswe uberswe requested a review from a team as a code owner July 30, 2021 08:27
@uberswe uberswe requested review from mirunacurtean and removed request for a team July 30, 2021 08:27
@github-actions
Copy link
Contributor

github-actions bot commented Jul 30, 2021

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Web/HTTP/CORS
Title: Cross-Origin Resource Sharing (CORS)
on GitHub

No new external URLs

(this comment was updated 2021-07-30 11:24:09.932596)

@teoli2003 teoli2003 added the Content:HTTP HTTP docs label Jul 30, 2021
@sideshowbarker
Copy link
Member

The example uses https:// instead of http:// without mentioning that this is wrong. The same example is later referenced with http:// on https://github.com/mdn/content/blob/main/files/en-us/web/http/cors/index.html#L216.

Given that, I think the better fix here would be to replace that reference with https://foo.example — and to also replace the other remaining cases of http://foo.example with https://foo.example.

@uberswe
Copy link
Contributor Author

uberswe commented Jul 30, 2021

The example uses https:// instead of http:// without mentioning that this is wrong. The same example is later referenced with http:// on https://github.com/mdn/content/blob/main/files/en-us/web/http/cors/index.html#L216.

Given that, I think the better fix here would be to replace that reference with https://foo.example — and to also replace the other remaining cases of http://foo.example with https://foo.example.

Should I make a new commit on this existing PR or make a new branch and PR with these changes?

@sideshowbarker
Copy link
Member

Should I make a new commit on this existing PR

Please go ahead and add the new commit on this existing PR branch. It’s also find to git commit --amend the existing commit — to overwrite it — and then force-push to this branch.

@uberswe
Copy link
Contributor Author

uberswe commented Jul 30, 2021

@sideshowbarker I have changed every example to use https, if this is unwanted please let me know.

One thing I want to note is that I did not update the images which I would need help with to change as they also use http://.

96e7e79f244643e123f94588f7d8f9e2

@teoli2003
Copy link
Contributor

Unfortunately I lost the source file of these diagrams, but can you open a follow-up issue? I'm planning to rework the http area starting next Monday, and redoing and improving all these diagrams are in my plans. (But I need to have problems recorded so I don't forget). It would be useful.

@uberswe
Copy link
Contributor Author

uberswe commented Jul 30, 2021

Unfortunately I lost the source file of these diagrams, but can you open a follow-up issue? I'm planning to rework the http area starting next Monday, and redoing and improving all these diagrams are in my plans. (But I need to have problems recorded so I don't forget). It would be useful.

I have opened #7455 regarding this.

@sideshowbarker sideshowbarker changed the title Fixes scheme in CORS example code Fix scheme in CORS example code Jul 30, 2021
@sideshowbarker sideshowbarker merged commit 53d1cdb into mdn:main Jul 30, 2021
@sideshowbarker
Copy link
Member

Markus, thanks much, and congrats on landing your first docs change here — welcome aboard 🎉

Anurella added a commit to Anurella/content that referenced this pull request Jul 30, 2021
* 'main' of https://github.com/mdn/content: (24 commits)
  added clarity (mdn#6879)
  Adds NavigatorUAData (mdn#7280)
  User-agent client hints API overview, and extensions to Navigator (mdn#7340)
  chore(deps): bump @mdn/yari from 0.4.658 to 0.4.660 (mdn#7459)
  Fix scheme in CORS example code (mdn#7447)
  Fix misstatement in docs about Date() function call (mdn#7454)
  Fix RTCErrorEvent and RTCError.event (mdn#7453)
  Fix broken {{page}} by incorporating the right data. (mdn#7451)
  Clean up some code examples (mdn#7449)
  Duplicated text from description can be removed. (mdn#7428)
  (CSS: Web Fonts) - various typographical fixes/improvements (mdn#7355)
  Drop the Implementations list from “JavaScript language resources” (mdn#7446)
  Removed links in headings (mdn#7442)
  Strict correct between primitive type names and wrapper class names (mdn#7439)
  Fix code indentation (mdn#7440)
  Fix up notesyntax to new standard (mdn#7437)
  Fix flaws on CSSOM View's Coordinate systems (mdn#7424)
  Add missing 'a' in “Using server-sent events” doc (mdn#7434)
  Removed unnecessary punctation in “Basic Concepts of grid layout” doc (mdn#7435)
  Fix MediaCapture example flaws (mdn#7425)
  ...
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:HTTP HTTP docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants