fix: correct link to toolchain documentation #1978
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mgred
requested review from
alexeagle,
gravypod,
pcj and
smukherj1
as code owners
gravypod
requested changes
Dec 17, 2021
container/image.bzl
Outdated
| @@ -946,7 +946,7 @@ def container_image(**kwargs): | |||
| layers inside the Docker registry. | |||
|
|
|||
| This rule references the `@io_bazel_rules_docker//toolchains/docker:toolchain_type`. | |||
| See [How to use the Docker Toolchain](toolchains/docker/readme.md#how-to-use-the-docker-toolchain) for details. | |||
| See [How to use the Docker Toolchain](https://github.com/bazelbuild/rules_docker/tree/master/toolchains/docker/readme.md#how-to-use-the-docker-toolchain) for details. | |||
There was a problem hiding this comment.
This would break previewing at a specific PR. Could we change do a similar change except replace https://github.com/bazelbuild/rules_docker/tree/master/ with /? That will allow GitHub to rewrite the urls for a specific branch/pr/commit. This is very useful for looking into the past for docs.
There was a problem hiding this comment.
@gravypod thanks for your review and suggestions! I made the change and tested it, perfectly works. This will still not work for the documentation published under docs.aspect.dev. Is this something we should have in mind?
There was a problem hiding this comment.
Sorry, I fixed and rebased already 🙃
gravypod
approved these changes
Dec 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The link on How to use the Docker Toolchain in
docs/container.mdneither works in Github nor in the online documentationWhat is the new behavior?
The link now works and points to the right page and anchor.
Does this PR introduce a breaking change?