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

content/rest/README.md references files that don't exist #35457

Open
1 task done
gsnedders opened this issue Nov 27, 2024 · 5 comments
Open
1 task done

content/rest/README.md references files that don't exist #35457

gsnedders opened this issue Nov 27, 2024 · 5 comments
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue rest Content related to rest - overview. SME reviewed An SME has reviewed this issue/PR

Comments

@gsnedders
Copy link

Code of Conduct

What article on docs.github.com is affected?

N/A (this is a README.md file in the repo)

content/rest/README.md

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

As of writing, this page says:

* The `/content/rest/guides` and `/content/rest/overview` directories contain regular articles. These are human-editable.
* The `/content/rest/reference` directory contains an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using `include` tags.

However, of the three paths mentioned here, two do not exist:

Additional information

No response

@gsnedders gsnedders added the content This issue or pull request belongs to the Docs Content team label Nov 27, 2024
Copy link

welcome bot commented Nov 27, 2024

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 27, 2024
@nguyenalex836
Copy link
Contributor

@gsnedders Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. needs SME This proposal needs review from a subject matter expert and removed triage Do not begin working on this issue until triaged by the team labels Nov 28, 2024
Copy link
Contributor

github-actions bot commented Dec 2, 2024

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

@nguyenalex836 nguyenalex836 added SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Dec 13, 2024
@nguyenalex836
Copy link
Contributor

nguyenalex836 commented Dec 13, 2024

@gsnedders Thank you for your patience while our SME team reviewed! 💛 Our team is proposing the following update to content/rest/README.md

REST

The /content/rest directory is where the GitHub REST API docs live!

  • The /content/rest/about-the-rest-api, /content/rest/guides and /content/rest/using-the-rest-api directories contain regular articles. These are human-editable.

  • The remaining directories contain an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using include tags.

    The content rendered by include tags is sourced from the /src/rest/data directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the /src/rest/README.md.

    We cannot accept changes to content that is rendered by include tags. However, you can open an issue describing the changes you would like to see.

Thank you again for raising a flag on this issue! Would you be willing to open a PR to make this update? ✨

@nguyenalex836 nguyenalex836 added the help wanted Anyone is welcome to open a pull request to fix this issue label Dec 18, 2024
@nguyenalex836
Copy link
Contributor

@gsnedders I've went ahead and added the help wanted label so that you, or anyone else, may open a PR to make this update 💛

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 help wanted Anyone is welcome to open a pull request to fix this issue rest Content related to rest - overview. SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

No branches or pull requests

3 participants
@gsnedders @nguyenalex836 and others