wlswo opened a new pull request, #19487:
URL: https://github.com/apache/druid/pull/19487

   ### Description
   
   The Docker tutorial's `DRUID_LOG4J` bullet links to an example line in
   `distribution/docker/environment`:
   
   ```md
   * `DRUID_LOG4J` -- set the entire [`log4j.xml` configuration 
file](https://logging.apache.org/log4j/2.x/manual/configuration.html#XML)  
verbatim. 
([Example](https://github.com/apache/druid/blob/{{DRUIDVERSION}}/distribution/docker/environment#L52))
   ```
   
   The anchor is off by one. The `environment` file ends at line **51**,
   which is where the `DRUID_LOG4J=` row lives — there is no line 52.
   Readers who follow the link land at the bottom of the file with nothing
   highlighted.
   
   You can see the behavior on `master`:
   
   - Current (broken): 
https://github.com/apache/druid/blob/master/distribution/docker/environment#L52 
— no line highlighted, scrolled past end of file
   - After this PR: 
https://github.com/apache/druid/blob/master/distribution/docker/environment#L51 
— `DRUID_LOG4J=<?xml ...` row highlighted
   
   Verified against `master` and the `druid-37.0.0` tag.
   
   This is a one-character follow-up to #19485, which fixed the sibling
   `#L125 → #L129` anchor on the same page.
   
   #### Release note
   
   The Docker tutorial's `DRUID_LOG4J` example link now lands on the
   correct line of the `environment` file.
   
   ##### Key changed/added classes in this PR
   - `docs/tutorials/docker.md`
   
   <hr>
   
   This PR has:
   
   - [x] been self-reviewed.
   - [x] added documentation for new or modified features or behaviors. *(this 
PR is itself a documentation fix)*
   - [x] a release note entry in the PR description.
   - [x] added Javadocs for most classes and all non-trivial methods. *(N/A — 
docs only)*
   - [x] added or updated version, license, or notice information in 
[licenses.yaml](https://github.com/apache/druid/blob/master/licenses.yaml) 
*(N/A — no dependency change)*
   - [x] 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)*
   - [x] added unit tests or modified existing tests to cover new code paths. 
*(N/A — docs only)*
   - [x] added integration tests. *(N/A)*
   - [x] been tested in a test Druid cluster. *(N/A — verified by inspecting 
the linked file at `master` and `druid-37.0.0`)*
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to