docs: use {{DRUIDVERSION}} template in docker tutorial port link#19485
Merged
Conversation
The Docker tutorial links to the `ports` section of `docker-compose.yml`
to show how to override the console port. The link was hardcoded to the
0.21.1 release of the file, so readers who follow it land on a four-year
-old version that no longer reflects the current cluster layout. The
three other GitHub links in the same page (lines 51, 84, and 134) use
the `{{DRUIDVERSION}}` template variable, which the docs build replaces
with the current Druid release tag — this one link looks like it was
just missed.
Replace `0.21.1` with `{{DRUIDVERSION}}` so the link follows the rest of
the file, and update the line anchor from `#L125` to `#L129` to point at
the router service's `ports:` row in the current file layout.
This file contains hidden or 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
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.
Description
The Docker tutorial (
docs/tutorials/docker.md) tells the reader how to change the console port and links to theportssection ofdocker-compose.ymlfor reference. The link is hardcoded to the 0.21.1 release of that file:You can see the broken behavior on the published docs today: https://druid.apache.org/docs/latest/tutorials/docker — clicking the
portslink in that paragraph lands on the 0.21.1 version of the file, which is four years out of date and no longer reflects the current cluster layout.The other three GitHub links in the same page (lines 51, 84, and 134) use the
{{DRUIDVERSION}}template variable, which the docs build replaces with the current Druid release tag (seewebsite/README.md). This one link appears to have just been missed when the rest of the page was templated.This change:
0.21.1with{{DRUIDVERSION}}so the link follows the same pattern as the rest of the file.#L125to#L129, which is the router service'sports:row indistribution/docker/docker-compose.ymlat the current release (verified against bothmasterand thedruid-37.0.0tag).Release note
The Docker tutorial's
portslink now points to the current release ofdocker-compose.ymlinstead of0.21.1.Key changed/added classes in this PR
docs/tutorials/docker.mdThis PR has:
{{DRUIDVERSION}}template usage on adjacent lines)