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

docs: Fix multiple broken links #10576

Merged
merged 7 commits into from Mar 16, 2020
Merged

Conversation

errordeveloper
Copy link
Contributor

@errordeveloper errordeveloper commented Mar 13, 2020

This change is Reviewable

@errordeveloper errordeveloper added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/misc Impacts miscellaneous areas of the code not otherwise owned by another area. labels Mar 13, 2020
@errordeveloper errordeveloper requested review from borkmann and a team as code owners March 13, 2020 16:15
@maintainer-s-little-helper

This comment has been minimized.

2 similar comments
@maintainer-s-little-helper

This comment has been minimized.

@maintainer-s-little-helper

This comment has been minimized.

@errordeveloper
Copy link
Contributor Author

test-docs-please

@coveralls
Copy link

coveralls commented Mar 13, 2020

Coverage Status

Coverage increased (+0.01%) to 45.662% when pulling 40ba3ff on pr/errordeveloper/fix-links into ff6eb66 on master.

@errordeveloper
Copy link
Contributor Author

errordeveloper commented Mar 16, 2020

Some links are not passing the link checker tests right now and I'm not sure how to fix these, perhaps we could instruct the checker to ignore these somehow?

Anchors work fine in the browser, but not in the link checker:

(line   35) broken    https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-quick-configuration - Anchor 'cli-quick-configuration' not found
(line   19) broken    https://github.com/kubernetes-sigs/kubespray#requirements - Anchor 'requirements' not found

Commands that contain URL substrings:

(line   32) broken    https://github.com/weaveworks/eksctl/releases/download/latest_release/eksctl_$(uname - 404 Client Error: Not Found for url: https://github.com/weaveworks/eksctl/releases/download/latest_release/eksctl_$(uname
(line   39) broken    https://github.com/kubernetes/kops/releases/download/$(curl - 404 Client Error: Not Found for url: https://github.com/kubernetes/kops/releases/download/$(curl

This one needs auth:

(line   41) broken    https://github.com/cilium/cilium/projects/new - 404 Client Error: Not Found for url: https://github.com/cilium/cilium/projects/new

We also have a few localhost links like this:

(line   42) broken    http://localhost:9080 - HTTPConnectionPool(host='localhost', port=9080): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x7f31cddb0d10>: Failed to establish a new connection: [Errno 111] Connection refused'))
(line  238) broken    http://127.0.0.1:15000/logging?level=debug - HTTPConnectionPool(host='127.0.0.1', port=15000): Max retries exceeded with url: /logging?level=debug (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x7f31ce248bd0>: Failed to establish a new connection: [Errno 111] Connection refused'))

Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
Signed-off-by: Ilya Dmitrichenko <errordeveloper@gmail.com>
@errordeveloper
Copy link
Contributor Author

test-docs-please

@errordeveloper
Copy link
Contributor Author

errordeveloper commented Mar 16, 2020

@joestringer I think it would be good to merge as-is, happy to open a follow-up issue to look into other broken links and long-term CI strategy for this :)

@joestringer joestringer merged commit beb401b into master Mar 16, 2020
1.8.0 automation moved this from In progress to Merged Mar 16, 2020
@joestringer joestringer deleted the pr/errordeveloper/fix-links branch March 16, 2020 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/misc Impacts miscellaneous areas of the code not otherwise owned by another area. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.8.0
  
Merged
Development

Successfully merging this pull request may close these issues.

None yet

5 participants