Fixing broken links by nate-double-u · Pull Request #203 · etcd-io/website

nate-double-u · 2021-04-08T22:17:15Z

Fixing broken links throughout

fixes: #50, #87, #146 (any remaining broken links should be addressed in a new, specific, issue.)
contributes to: #147
supersedes: #100, #104

Spreadsheet https://docs.google.com/spreadsheets/d/1TWDL6RHCEQiPK1G3PJcpne8UK74Eb2ZoCGOSoTBBECw/edit#gid=621691032 -- most work has been on the htmltest 2021-04-14 tab.

nate-double-u · 2021-04-14T02:57:29Z

[edited as this content is referenced below]

nate-double-u · 2021-04-20T22:36:54Z

I've gotten this to a point where there are a handful broken links left, and I'm not sure where they should point:

docs/v3.4/learning/why/index.html

Non-OK status: 404 --- docs/v3.4/learning/why/index.html --> https://godoc.org/github.com/coreos/etcd-io/etcdserver/api/v3election/v3electionpb

docs/v3.3/learning/why/index.html

Non-OK status: 404 --- docs/v3.3/learning/why/index.html --> https://godoc.org/github.com/coreos/etcd-io/etcdserver/api/v3election/v3electionpb

docs/v3.1/libraries-and-tools/index.html

Non-OK status: 404 --- docs/v3.1/libraries-and-tools/index.html --> https://github.com/scrz/scrz

docs/v3.1/op-guide/monitoring/index.html

request exceeded our ExternalTimeout --- docs/v3.1/op-guide/monitoring/index.html --> http://dash.etcd.io/dashboard/db/test-etcd

docs/next/learning/why/index.html

Non-OK status: 404 --- docs/next/learning/why/index.html --> https://godoc.org/github.com/etcd-io/etcd/server/etcdserver/api/v3lock/v3lockpb
Non-OK status: 404 --- docs/next/learning/why/index.html --> https://godoc.org/github.com/etcd-io/etcd/server/etcdserver/api/v3election/v3electionpb
Non-OK status: 404 --- docs/next/learning/why/index.html --> https://godoc.org/github.com/etcd-io/etcd/server/etcdserver/api/v3lock/v3lockpb

At this point, I think we should review this PR, and open a separate issue for the remaining links.

nate-double-u · 2021-04-21T16:48:02Z

Note I have tried to avoid changing links in code samples. If these need to change (and I think probably they do for at least v3.4 and next) we should open a separate issue to address those updates.

chalin · 2021-04-22T14:33:20Z

content/docs/next/branch_management.md

 All branches with prefix `release-` are considered _stable_ branches.

-After every minor release (http://semver.org/), we will have a new stable branch for that release, managed by a [patch release manager](./dev-internal/release#release-management). We will keep fixing the backwards-compatible bugs for the latest two stable releases. A _patch_ release to each supported release branch, incorporating any bug fixes, will be once every two weeks, given any patches.
+After every minor release (http://semver.org/\), we will have a new stable branch for that release, managed by a [patch release manager](./dev-internal/release#release-management). We will keep fixing the backwards-compatible bugs for the latest two stable releases. A _patch_ release to each supported release branch, incorporating any bug fixes, will be once every two weeks, given any patches.


Why the \ at the end of http://semver.org/\?

Without the \ Hugo renders the link with the ), appended.

https://etcd.io/docs/next/branch_management/#stable-branches

https://deploy-preview-203--etcd.netlify.app/docs/next/branch_management/#stable-branches

Oh, that's a raw URL! (I was reviewing too quickly.) We should avoid raw URLs in the docs. Hmm, I thought that I had fixed that particular case -- maybe on the docsy branch? I'll check tomorrow, or as soon as I can.

We should avoid raw URLs in the docs.

I agree.

Will track via #253

chalin

See inlined comments

content/docs/next/dev-internal/release.md

nate-double-u · 2021-04-23T18:10:30Z

/cc @ChaitanyaKaranam (as you opened issue #50 🙂)

chalin · 2021-04-26T13:38:10Z

fixes: #50, #87, #146, #147

This PR contributes to #147, but doesn't quite close it. We'll still have to decide what to do with the "next" subsection, if I'm not mistaken. Could you change the opening comment to that effect (so that #147 isn't automatically closed)? Or, I suppose, we could open a followup PR.

content/docs/v3.4/upgrades/upgrade_3_4.md

chalin · 2021-04-26T13:41:10Z

content/docs/next/upgrades/upgrade_3_3.md

 ```

-[The new client balancer](https://github.com/etcd-io/etcd/blob/master/Documentation/learning/design-client.md) uses an asynchronous resolver to pass endpoints to the gRPC dial function. As a result, [v3.3.14](https://github.com/etcd-io/etcd/releases/tag/v3.3.14) or later requires `grpc.WithBlock` dial option to wait until the underlying connection is up.
+[The new client balancer](/docs/next/learning/design-client/) uses an asynchronous resolver to pass endpoints to the gRPC dial function. As a result, [v3.3.14](https://github.com/etcd-io/etcd/releases/tag/v3.3.14) or later requires `grpc.WithBlock` dial option to wait until the underlying connection is up.


As I mentioned elsewhere, I'm very glad that you are fixing these external-meant-to-be-internal links. But in this case it exposes an issue with the "next" subsection: when we create a real version subsection from it (by copy-pasting the next subdirectory), links like these will need to be updated, right?

I agree, links like this will need to be updated during the release process. We may be able to replace this with another front-matter parameter solution

chalin

I haven't double checked all links, but overall LGTM.

Have you run this through the internal and external link checker?

nate-double-u · 2021-04-26T16:34:54Z

I haven't double checked all links, but overall LGTM.

Thanks, I appreciate the look.

Have you run this through the internal and external link checker?

I've run it through both -- the internal link checker comes back all correct, but the external one is throwing a lot of non-404 style errors (primarily 416 errors).

The make check-all-links command is finally returning few enough results that I feel like I can add it inline:

htmltest started at 09:25:45 on public
========================================================================
blog/jepsen-343-results/index.html
  Non-OK status: 416 --- blog/jepsen-343-results/index.html --> https://fauna.com/blog/demystifying-database-systems-part-4-isolation-levels-vs-consistency-levels
docs/v3.4/learning/why/index.html
  Non-OK status: 404 --- docs/v3.4/learning/why/index.html --> https://godoc.org/github.com/coreos/etcd-io/etcdserver/api/v3election/v3electionpb
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/commands/lock
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/api-docs#consistency
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/api/kv#txn
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/watches
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/docs/security/acl
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/api-docs#formatted-json-output
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://learn.hashicorp.com/tutorials/consul/add-remove-servers?in=consul/day-2-operations
  Non-OK status: 416 --- docs/v3.4/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/sessions
docs/v3.3/learning/why/index.html
  Non-OK status: 404 --- docs/v3.3/learning/why/index.html --> https://godoc.org/github.com/coreos/etcd-io/etcdserver/api/v3election/v3electionpb
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/commands/lock
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/api-docs#consistency
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/api/kv#txn
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/watches
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/docs/security/acl
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/api-docs#formatted-json-output
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://learn.hashicorp.com/tutorials/consul/add-remove-servers?in=consul/day-2-operations
  Non-OK status: 416 --- docs/v3.3/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/sessions
docs/v3.1/libraries-and-tools/index.html
  Non-OK status: 404 --- docs/v3.1/libraries-and-tools/index.html --> https://github.com/scrz/scrz
docs/v3.1/op-guide/monitoring/index.html
  request exceeded our ExternalTimeout --- docs/v3.1/op-guide/monitoring/index.html --> http://dash.etcd.io/dashboard/db/test-etcd
docs/next/learning/why/index.html
  Non-OK status: 404 --- docs/next/learning/why/index.html --> https://godoc.org/github.com/etcd-io/etcd/server/etcdserver/api/v3lock/v3lockpb
  Non-OK status: 404 --- docs/next/learning/why/index.html --> https://godoc.org/github.com/etcd-io/etcd/server/etcdserver/api/v3election/v3electionpb
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/commands/lock
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/api-docs#consistency
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/api/kv#txn
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/watches
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/docs/security/acl
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/api-docs#formatted-json-output
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://learn.hashicorp.com/tutorials/consul/add-remove-servers?in=consul/day-2-operations
  Non-OK status: 416 --- docs/next/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/sessions
  Non-OK status: 404 --- docs/next/learning/why/index.html --> https://godoc.org/github.com/etcd-io/etcd/server/etcdserver/api/v3lock/v3lockpb
docs/v3.2/learning/why/index.html
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/commands/lock
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/api-docs#consistency
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/api/kv#txn
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/watches
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/docs/security/acl
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/api-docs#formatted-json-output
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://learn.hashicorp.com/tutorials/consul/add-remove-servers?in=consul/day-2-operations
  Non-OK status: 416 --- docs/v3.2/learning/why/index.html --> https://www.consul.io/docs/dynamic-app-config/sessions
========================================================================
✘✘✘ failed in 26.476602353s
40 errors in 399 documents

nate-double-u · 2021-04-26T16:36:31Z

fixes: #50, #87, #146, #147

This PR contributes to #147, but doesn't quite close it. We'll still have to decide what to do with the "next" subsection, if I'm not mistaken. Could you change the opening comment to that effect (so that #147 isn't automatically closed)? Or, I suppose, we could open a followup PR.

I'll change the description.

adding web archive link for older versions linking to fanhattan/etcd-backup, removing link for v3.4 and next fixing link in v2.3 backward_compatibility correcting link from github to local updating v2.3 coreos github links updating coreos github links to etcd-io updating coreos github links to etcd-io in v2.3 updating coreos github links to etcd-io in v3.1 updating coreos github links to etcd-io in v3.1 cont. coreos references in code snippets not updated correcting link w/ escape character updating coreos github links to etcd-io in v3.2 coreos references in code snippets not updated updating coreos github links to etcd-io in v3.3 coreos references in code snippets not updated updating coreos github links to etcd-io in v3.4 coreos references in code snippets not updated updating coreos github links to etcd-io in "next" coreos references in code snippets not updated adding escape character for link surrounded by () updating and removing links to https://github.com/mickep76/etcd-rest. Updated to webarchive in v2-v3.3, removed in v3.4 and next updating links to https://github.com/kamilhark/etcdsh to webarchive correcting links in v2.3 dev/releases updating links -- adding escape character for links with " at the end updating links hyper.sh -> https://github.com/hyperhq updating api-protobuf links updating kv-protobuf links updating apache celix etcdlib links updating consul-lock links updating consul-linread links updating consul links updating wal-pkg links updating zookeeper links updating stanford pdf links updating pdf link updating links from old etcd/etcd-io documentaiton folder to website updating old repo Documentaiton links to point back ot the site updating code links correcting cockroachlabs link Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>

…r, as per PR feedback Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>

nate-double-u · 2021-04-26T17:56:25Z

Regarding the results I posted above, other than the 416 errors, the broken links list referred to in #203 (comment) is the same.

* Fixing broken links * Updating links to Github that contain versions to use a Hugo parameter, as per PR feedback Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>

nate-double-u force-pushed the 50-fixing-broken-links branch 3 times, most recently from 3fb5ae6 to 5f8a0e0 Compare April 12, 2021 21:18

nate-double-u marked this pull request as ready for review April 12, 2021 23:03

nate-double-u added this to the 21Q1-pre-docsy milestone Apr 16, 2021

nate-double-u added the cleanup/refactoring label Apr 16, 2021

nate-double-u force-pushed the 50-fixing-broken-links branch 2 times, most recently from a074cf6 to e1cf759 Compare April 20, 2021 22:31

This was linked to issues Apr 21, 2021

Cleanup #87

Closed

Replace coreos by etcd-io as an organization in links into GitHub #146

Closed

vX.Y.Z doc pages with links into GitHub should link to vX.Y.Z not master #147

Open

This was referenced Apr 21, 2021

Update faq.md #104

Closed

Update link to zookeeper docs #100

Closed

chalin reviewed Apr 22, 2021

View reviewed changes

chalin requested changes Apr 22, 2021

View reviewed changes

content/docs/next/dev-internal/release.md Show resolved Hide resolved

chalin mentioned this pull request Apr 26, 2021

Docsy theme #244

Merged

chalin reviewed Apr 26, 2021

View reviewed changes

content/docs/v3.4/upgrades/upgrade_3_4.md Show resolved Hide resolved

chalin reviewed Apr 26, 2021

View reviewed changes

chalin approved these changes Apr 26, 2021

View reviewed changes

nate-double-u removed a link to an issue Apr 26, 2021

vX.Y.Z doc pages with links into GitHub should link to vX.Y.Z not master #147

Open

nate-double-u added 2 commits April 26, 2021 10:37

updating links to github that contain versions to use a Hugo paramete…

fc9cf58

…r, as per PR feedback Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>

nate-double-u force-pushed the 50-fixing-broken-links branch from c5fe05c to fc9cf58 Compare April 26, 2021 17:41

nate-double-u merged commit ae1b7f6 into etcd-io:master Apr 26, 2021

nate-double-u mentioned this pull request Apr 26, 2021

Fix remaining broken external links #245

Open

nate-double-u deleted the 50-fixing-broken-links branch April 26, 2021 18:05

This was referenced Apr 26, 2021

Use only real version names, not next, for doc version subdirectories under /content #252

Open

Branch management pages: avoid raw URLs in the page text #253

Closed

nate-double-u mentioned this pull request Jun 25, 2021

Etcd.io Docs/SEO Improvement Plan #65

Closed

Conversation

nate-double-u commented Apr 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nate-double-u commented Apr 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nate-double-u commented Apr 20, 2021

Uh oh!

nate-double-u commented Apr 21, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nate-double-u commented Apr 23, 2021

Uh oh!

chalin commented Apr 26, 2021

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalin left a comment

Choose a reason for hiding this comment

Uh oh!

nate-double-u commented Apr 26, 2021

Uh oh!

nate-double-u commented Apr 26, 2021

Uh oh!

nate-double-u commented Apr 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nate-double-u commented Apr 8, 2021 •

edited

Loading

nate-double-u commented Apr 14, 2021 •

edited

Loading