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

Jump to bottom

Fixing dead/broken links for rest api docs #30833

Merged
merged 2 commits into from Jan 2, 2024
Merged

Fixing dead/broken links for rest api docs #30833

merged 2 commits into from Jan 2, 2024

Conversation

frankpengau
Copy link
Contributor

@frankpengau frankpengau commented Dec 27, 2023 •
edited

Fix dead link: https://docs.github.com/en/rest/overview/about-the-rest-api

Changed to: https://docs.github.com/en/rest/about-the-rest-api/about-the-rest-api

Added redirect for the old broken/dead link as well, just in case if it's referenced elsewhere.

Why:

Closes: #30836

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

Before:
Screenshot 2023-12-27 at 2 13 35 pm

After:
Screenshot 2023-12-27 at 2 26 01 pm

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • 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.

@frankpengau
Update index.md
3b2d551 
Fix dead link
@welcome Welcome
Copy link

welcome bot commented Dec 27, 2023

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 Dec 27, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 27, 2023 •
edited

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/about-the-rest-api/about-the-rest-api.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae
 fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae
rest/index.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae
 fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae

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

@frankpengau
Update about-the-rest-api.md
ca90980 
Add redirect from old broken link
@frankpengau frankpengau changed the title Update index.md Fixing dead/broken links for rest api docs Dec 27, 2023
@nguyenalex836
Copy link
Contributor

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

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

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

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

Thanks for this fix! We'll get this merged for you once our repos unfreeze in January.

@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label Dec 27, 2023
@docs-bot docs-bot added this to Triage in Docs open source board Dec 27, 2023
@skedwards88 skedwards88 added this pull request to the merge queue Jan 2, 2024
Merged via the queue into github:main with commit 4573062 Jan 2, 2024
79 checks passed
Docs open source board automation moved this from Triage to Done Jan 2, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 2, 2024

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skedwards88 skedwards88 skedwards88 approved these changes

Assignees
No one assigned
Labels
content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review
Projects
Docs open source board
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

GitHub REST API documentation Overview Button goes to a broken/dead link
3 participants
@frankpengau @nguyenalex836 @skedwards88