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

Docs - Update Docs to Show Permission Requirements for Different media Types #33454

Closed
wants to merge 4 commits into from

Conversation

zachdotai
Copy link

@zachdotai zachdotai commented Jun 11, 2024

Why:

Closes: This is in response with an issue that I was facing and managed to resolve by finding this discussion.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Updated the media type section of the documentation to outline that different media types may require different permissions.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

…Media Types

This is in response with an issue that I was facing and managed to resolve by finding this [discussion](https://github.com/orgs/community/discussions/38159).
Copy link

welcome bot commented Jun 11, 2024

Thanks for opening this pull request! 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 Jun 11, 2024
Copy link
Contributor

github-actions bot commented Jun 11, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
rest/using-the-rest-api/getting-started-with-the-rest-api.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. and removed triage Do not begin working on this issue until triaged by the team labels Jun 11, 2024
@nguyenalex836
Copy link
Contributor

@zachdotai Thanks so much for opening a PR! I'll get this triaged for review ✨

@skedwards88 skedwards88 added the fix-internally Triggers a workflow to copy the issue internally and close the current issue label Jun 18, 2024
@skedwards88
Copy link
Contributor

Thanks for this PR! This is something that we should fix internally. I'll raise this discrepancy with the team that owns the data from which the permission docs are generated.

@zachdotai
Copy link
Author

Thanks for this PR! This is something that we should fix internally. I'll raise this discrepancy with the team that owns the data from which the permission docs are generated.

@skedwards88 Thank you for your response. As far as I understand from the author of the earlier discussion, the issue could not be resolved back then in 2022 due to Github not having the capacity to do it.
I think this small comment in the docs will go a long way in saving some precious time for the engineers who can be stuck on the issue while it is resolved by Github. We can caveat the comment with this note as well. What do you think?

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 fix-internally Triggers a workflow to copy the issue internally and close the current issue rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants