Update some docs links #2571

SeanKilleen · 2022-09-15T13:16:35Z

Supports #2474.

This PR:

Converts the links in markdown
Removes the Beta packages section of the README, which had bad links
Moves all current docs.github.com links to be https.
Removes /en from existing routes.

Remaining Work

Convert Markdown links
Decide what to do about the README beta packages section
Remove /en from all changed links (docs know how to handle language now)
Correct http links in changed links

SeanKilleen · 2022-09-15T13:29:50Z

@nickfloyd as part of adding the GH Action to check links, I saw that the following text in README appears to 404:

### Beta packages ###

Unstable NuGet packages that track the `main` branch of this repository are available at
[https://ci.appveyor.com/nuget/octokit-net](https://ci.appveyor.com/nuget/octokit-net)

Is there a new beta packages link? Or should I remove that section?

⚠️ I'm not sure if this is the right path. Should we update the gist list links to point to the most specific docs possible?

This reverts commit 9e84148.

SeanKilleen · 2022-09-15T15:08:40Z

Hmm....tried configuring Lychee to fail when links are redirected, since most of the links we're seeing are 301 permanent redirects. However, setting args: --max-redirects 0 in the github action YAML didn't do what I expected it to. Will fix it another time.

nickfloyd · 2022-09-15T15:24:12Z

@nickfloyd as part of adding the GH Action to check links, I saw that the following text in README appears to 404:
### Beta packages ###

Unstable NuGet packages that track the `main` branch of this repository are available at
[https://ci.appveyor.com/nuget/octokit-net](https://ci.appveyor.com/nuget/octokit-net)
Is there a new beta packages link? Or should I remove that section?

That should now be removed - good catch, thx! ❤️. Also, you are an absolute hero for picking this one up! Thanks for giving it a go!

Per octokit#2571 (comment)

SeanKilleen · 2022-09-15T15:37:10Z

ℹ️ 💡 @nickfloyd while changing links in the MiscellaneousClient, I noticed that the misc docs now redirect to https://docs.github.com/en/rest/emojis

The MiscellaneousClient should likely be split up into MarkownClient, EmojiClient, GitignoreClient, etc. and then have the larger MiscellaneousClient retired in a future major release. Noting it here because you may want to add it to a backlog somewhere (happy to create an issue if you'd like).

For now, I will remove the top-level "misc" link as it no longer exists, and will add text to refer to the doc link at the method level.

nickfloyd · 2022-09-15T15:41:35Z

Noting it here because you may want to add it to a backlog somewhere (happy to create an issue if you'd like).

If you get the chance, please feel free to create an issue so that we can get what you're suggesting here implemented. Thanks!

This reverts commit 9177014.

SeanKilleen · 2022-09-15T18:04:28Z

ℹ️ Realizing that lychee doesn't support anchor tags so its usefulness will be limited in this case. Will likely end up removing it, as the majority of the links are in C# files and we'd need to convert them to UTF-8 first and then I'm still not sure we'd get the benefit.

SeanKilleen · 2022-09-15T18:06:18Z

@nickfloyd question for you -- how important is linking to the correct anchor tag on the page?

If we wanted to go more toward the 80/20 rule, we could remove the anchor references in the links and link to the correct page. This would let us update the links quickly, but we'd lose some specificity, and the links would be more fragile as heading/anchor names change.

I'm fine to proceed either way, but if you don't care about anchor-level specificity, I can remove them.

It turned out not to provide a ton of value: * Would have taken some adjustment for C# files to be converted to UTF-8 to be scanned with it * Doesn't have the ability to check anchor links, where there's a lot of drift here.

SeanKilleen · 2022-09-15T18:29:32Z

ℹ️ Removed lychee -- it wasn't going to provide enough value to guide the process and I'm not sure a lot of the drift would have been detected by it going forward. Plus, it would take a bit of elbow grease to get it to work with the C# files.

SeanKilleen · 2022-09-15T18:45:25Z

@nickfloyd I realized that this is going to be a larger effort than thought so I'll split it over multiple PRs.

I'll probably update #2474 with a breakdown list so that we can slice it in more meaningful ways going forward.

I'm going to do a review pass for basic fixes & comments and then it'll be ready for review / merge and I'll zoom out prior to next steps.

SeanKilleen · 2022-09-15T18:59:38Z

Actually as much as this pains me, I'm going to close this PR and start over because:

I don't like the way it's structured overall -- changes aren't targeted, too hard to review.
I didn't realize and I accidentally changed all the whitespace in C# files due to VS Code formatting on save. Again, very hard to review.

Look for smaller, targeted PRs toward this task going forward.

SeanKilleen added 4 commits September 15, 2022 09:13

Update overall REST URL

6a3fd03

Update main API docs URL

1f76005

Update /v3/issues in MD files

e486a2f

Add attempt at link-checking GH Action

131dece

SeanKilleen changed the title ~~WIP: Update docs links~~ WIP: Update docs links and add link checker Sep 15, 2022

SeanKilleen added 14 commits September 15, 2022 09:38

more links

b728acc

more links

6841d64

Replace remaining links in markdown

21f37ab

replace base link

cef6131

Update user agent required link

e6df8f4

Move generic "gist list" link to main gist article

98f08f7

⚠️ I'm not sure if this is the right path. Should we update the gist list links to point to the most specific docs possible?

A test to see if the link checker will pick up on these 404s

9e84148

Revert "A test to see if the link checker will pick up on these 404s"

e6b1e0f

This reverts commit 9e84148.

Use 0 max redirects, which should help give us our to-do list

deb7d98

try quoting the arg

024ea90

oh well.

b079328

SeanKilleen mentioned this pull request Sep 15, 2022

Problem setting max-redirect arg on action lycheeverse/lychee-action#164

Closed

replace oauth_authorizations link

7fb7d61

SeanKilleen added 2 commits September 15, 2022 11:25

base migration link

050675c

Removed beta package info

7913db6

Per octokit#2571 (comment)

SeanKilleen added 2 commits September 15, 2022 11:41

Add message for method level redirects

5900412

Add some of the method level messages

0606ed3

SeanKilleen added 9 commits September 15, 2022 13:34

Link update

102235c

Link update

d82a130

Link update

4a5531e

Link update

4b3ebc7

Link update

943f471

Link update

81a234e

Link update

a6d746e

Quick test to see if lychee checks anchor names

9177014

Revert "Quick test to see if lychee checks anchor names"

0792e80

This reverts commit 9177014.

SeanKilleen added 10 commits September 15, 2022 14:14

Link update

f753e93

Link update

2f397fc

Link update

9fc7750

Link update

c95a92a

Link update

b5d2f0b

Link update

a1a0f2c

Link update

2e876c3

Link update

025f5b1

Link update

34d9b45

Remove lychee

23bd9b0

It turned out not to provide a ton of value: * Would have taken some adjustment for C# files to be converted to UTF-8 to be scanned with it * Doesn't have the ability to check anchor links, where there's a lot of drift here.

Link Update

26d4353

SeanKilleen changed the title ~~WIP: Update docs links and add link checker~~ Update docs links and add link checker Sep 15, 2022

SeanKilleen changed the title ~~Update docs links and add link checker~~ Update some docs links Sep 15, 2022

SeanKilleen added 2 commits September 15, 2022 14:47

http --> https for docs.github.com

066cbe3

remove "en" from docs routes

37b32a2

SeanKilleen closed this Sep 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update some docs links #2571

Update some docs links #2571

SeanKilleen commented Sep 15, 2022 •

edited

Loading

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022 •

edited

Loading

nickfloyd commented Sep 15, 2022 •

edited

Loading

SeanKilleen commented Sep 15, 2022 •

edited

Loading

nickfloyd commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022 •

edited

Loading

SeanKilleen commented Sep 15, 2022

Update some docs links #2571

Update some docs links #2571

Conversation

SeanKilleen commented Sep 15, 2022 • edited Loading

Remaining Work

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022 • edited Loading

nickfloyd commented Sep 15, 2022 • edited Loading

SeanKilleen commented Sep 15, 2022 • edited Loading

nickfloyd commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022 • edited Loading

SeanKilleen commented Sep 15, 2022

SeanKilleen commented Sep 15, 2022 •

edited

Loading

SeanKilleen commented Sep 15, 2022 •

edited

Loading

nickfloyd commented Sep 15, 2022 •

edited

Loading

SeanKilleen commented Sep 15, 2022 •

edited

Loading

SeanKilleen commented Sep 15, 2022 •

edited

Loading