-
Notifications
You must be signed in to change notification settings - Fork 288
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
Fixing broken links #203
Fixing broken links #203
Conversation
3fb5ae6
to
5f8a0e0
Compare
[edited as this content is referenced below] |
a074cf6
to
e1cf759
Compare
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
docs/v3.3/learning/why/index.html
docs/v3.1/libraries-and-tools/index.html
docs/v3.1/op-guide/monitoring/index.html
docs/next/learning/why/index.html
At this point, I think we should review this PR, and open a separate issue for the remaining links. |
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 |
@@ -25,7 +25,7 @@ Before the release of the next stable version, feature PRs will be frozen. A [re | |||
|
|||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the \
at the end of http://semver.org/\
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Without the \
Hugo renders the link with the ),
appended.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should avoid raw URLs in the docs.
I agree.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will track via #253
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See inlined comments
/cc @ChaitanyaKaranam (as you opened issue #50 🙂) |
@@ -399,7 +399,7 @@ _, err := kvc.Get(ctx, "a") | |||
+ if s.Code() == codes.Canceled | |||
``` | |||
|
|||
[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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #252
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't double checked all links, but overall LGTM.
Have you run this through the internal and external link checker?
Thanks, I appreciate the look.
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
|
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>
c5fe05c
to
fc9cf58
Compare
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 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.