octokit / octokit.net

A GitHub API client library for .NET
https://octokitnet.readthedocs.io/en/latest/
MIT License
2.69k stars 1.08k forks source link

[DOCS] Update all links to developer.github.com in docs and code comments to the more accurate docs.github.com #2474

Closed nickfloyd closed 4 weeks ago

nickfloyd commented 2 years ago

It's been a while since we've updated the documentation for octokit.net (*.md). The hostname for the docs site on GitHub has since changed from developer.github.com to docs.github.com so all of the references need to change given the redirects might not always be there and might not currently be accurate.

Things to watch out for:

SeanKilleen commented 2 years ago

Planning this task a little more.

The below powershell script tells me there are 1928 unique URLs containing developer.github.com in the project.

Get-ChildItem -Path *.cs -Recurse | Select-String -Pattern '(?:(?:https?|ftp|file):\/\/|www\.|ftp\.)(?:\([-A-Z0-9+&@#\/%=~_|$?!:,.]*\)|[-A-Z0-9+&@#\/%=~_|$?!:,.])*(?:\([-A-Z0-9+&@#\/%=~_|$?!:,.]*\)|[A-Z0-9+&@#\/%=~_|$])' | Foreach-Object { $_.matches.Value } | Where-Object { $_ -Match "developer.github.com" } | Get-Unique | Measure-Object

So I exported a text file:

Get-ChildItem -Path *.cs -Recurse | Select-String -Pattern '(?:(?:https?|ftp|file):\/\/|www\.|ftp\.)(?:\([-A-Z0-9+&@#\/%=~_|$?!:,.]*\)|[-A-Z0-9+&@#\/%=~_|$?!:,.])*(?:\([-A-Z0-9+&@#\/%=~_|$?!:,.]*\)|[A-Z0-9+&@#\/%=~_|$])' | Foreach-Object { $_.matches.Value } | Where-Object { $_ -Match "developer.github.com" } | Get-Unique >> links.txt

And I put that into Excel, which I'm linking here: https://1drv.ms/x/s!AuaqsrDoMOUHofFGQlnoE6jKbcuxHg?e=v7JX7a

I'm thinking the next step would be to do some quick analysis to see if there's a systemic way to approach it, or at least use the Excel file to create a checklist to break things down.

JonruAlveus commented 2 years ago

Nice! How about this for a starter

github-actions[bot] commented 1 month ago

👋 Hey Friends, this issue has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!