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

Inconsistent HTTP headers name #35429

Open
1 task done
akordowski opened this issue Nov 26, 2024 · 3 comments · May be fixed by #35430
Open
1 task done

Inconsistent HTTP headers name #35429

akordowski opened this issue Nov 26, 2024 · 3 comments · May be fixed by #35430
Labels
content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review

Comments

@akordowski
Copy link
Contributor

akordowski commented Nov 26, 2024

Code of Conduct

What article on docs.github.com is affected?

Multiple articles.

What part(s) of the article would you like to see updated?

There are occurrences where HTTP headers X-GitHub- are written as X-Github-.

There are also two HTTP mentioned, which don't have the X- prefix (e.g. here):

  • Github-Public-Key-Identifier
  • Github-Public-Key-Signature

Additional information

I can provide a PR with fixes.

@akordowski akordowski added the content This issue or pull request belongs to the Docs Content team label Nov 26, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 26, 2024
@akordowski akordowski linked a pull request Nov 26, 2024 that will close this issue
3 tasks
@akordowski
Copy link
Contributor Author

In the provided PR I fixed only the X-GitHub- headers. I was unsure if the headers Github-Public-Key-Identifier and Github-Public-Key-Signature should be fixed as well.

@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team label Nov 26, 2024
@nguyenalex836
Copy link
Contributor

@akordowski Thank you for catching this inconsistency! ✨

Just in case, I'll put this up for review by the team so we can confirm there aren't any negative downstream effects of updating the Github-Public-Key-Identifier, Github-Public-Key-Identifier, or Github-Public-Key-Signature headers.

Will also be good to just have the team's visibility on this inconsistency as well 💛

@nguyenalex836 nguyenalex836 added the waiting for review Issue/PR is waiting for a writer's review label Nov 26, 2024
@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Nov 27, 2024
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants