Skip to content

docs: use {{DRUIDVERSION}} template in docker tutorial port link#19485

Merged
jtuglu1 merged 1 commit into
apache:masterfrom
wlswo:fix/docker-doc-version-pin
May 20, 2026
Merged

docs: use {{DRUIDVERSION}} template in docker tutorial port link#19485
jtuglu1 merged 1 commit into
apache:masterfrom
wlswo:fix/docker-doc-version-pin

Conversation

@wlswo
Copy link
Copy Markdown
Contributor

@wlswo wlswo commented May 20, 2026

Description

The Docker tutorial (docs/tutorials/docker.md) tells the reader how to change the console port and links to the ports section of docker-compose.yml for reference. The link is hardcoded to the 0.21.1 release of that file:

...you can change the port in the ports section of the docker-compose.yml file.

You can see the broken behavior on the published docs today: https://druid.apache.org/docs/latest/tutorials/docker — clicking the ports link 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 (see website/README.md). This one link appears to have just been missed when the rest of the page was templated.

This change:

  • Replaces 0.21.1 with {{DRUIDVERSION}} so the link follows the same pattern as the rest of the file.
  • Updates the line anchor from #L125 to #L129, which is the router service's ports: row in distribution/docker/docker-compose.yml at the current release (verified against both master and the druid-37.0.0 tag).

Release note

The Docker tutorial's ports link now points to the current release of docker-compose.yml instead of 0.21.1.

Key changed/added classes in this PR
  • docs/tutorials/docker.md

This PR has:

  • been self-reviewed.
  • added documentation for new or modified features or behaviors. (this PR is itself a documentation fix)
  • a release note entry in the PR description.
  • added Javadocs for most classes and all non-trivial methods. (N/A — docs only)
  • added or updated version, license, or notice information in licenses.yaml (N/A — no dependency change)
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader. (N/A — single-line docs change)
  • added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met. (N/A — docs only)
  • added integration tests. (N/A)
  • been tested in a test Druid cluster. (N/A — verified by inspecting the rendered link target on the published docs and confirming the {{DRUIDVERSION}} template usage on adjacent lines)

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.
@jtuglu1 jtuglu1 self-requested a review May 20, 2026 04:43
@jtuglu1 jtuglu1 merged commit e2af664 into apache:master May 20, 2026
8 checks passed
@github-actions github-actions Bot added this to the 38.0.0 milestone May 20, 2026
@wlswo wlswo deleted the fix/docker-doc-version-pin branch May 20, 2026 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants