Skip to content

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Mar 22, 2022

Summary

Fixes the following broken links by removing step 2 from the setup guide. Log correlation is enabled by default in version 1.30:

08:40:20 INFO:build_docs:Bad cross-document links:
08:40:20 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/ecs-logging/java/0.x/intro.html contains broken links to:
08:40:20 INFO:build_docs:   - en/apm/agent/java/current/config-logging.html#config-enable-log-correlation
08:40:20 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/ecs-logging/java/0.x/setup.html contains broken links to:
08:40:20 INFO:build_docs:   - en/apm/agent/java/current/config-logging.html#config-enable-log-correlation
08:40:20 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/ecs-logging/java/1.x/setup.html contains broken links to:
08:40:20 INFO:build_docs:   - en/apm/agent/java/current/config-logging.html#config-enable-log-correlation
08:40:20 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/ecs-logging/java/current/setup.html contains broken links to:
08:40:20 INFO:build_docs:   - en/apm/agent/java/current/config-logging.html#config-enable-log-correlation
08:40:20 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/ecs-logging/java/master/setup.html contains broken links to:
08:40:20 INFO:build_docs:   - en/apm/agent/java/current/config-logging.html#config-enable-log-correlation

Downside / Question

Because only the 1.x version of the Java agent docs are published, we don't have anywhere to send users who are using
a version > 1.30. I'm wondering if we should keep deprecated enable_log_correlation documentation for these users. See elastic/apm-agent-java#2535 (comment) for more context.

Related

For elastic/apm-agent-java#2535.

Backport

Backport to 1.x and 0.x.

@bmorelli25 bmorelli25 requested a review from eyalkoren March 22, 2022 19:52
@bmorelli25 bmorelli25 self-assigned this Mar 22, 2022
@ghost
Copy link

ghost commented Mar 22, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-03-29T20:21:38.775+0000

  • Duration: 7 min 8 sec

Test stats 🧪

Test Results
Failed 0
Passed 196
Skipped 0
Total 196

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@eyalkoren
Copy link
Contributor

eyalkoren commented Mar 28, 2022

Because only the 1.x version of the Java agent docs are published, we don't have anywhere to send users who are using
a version > 1.30. I'm wondering if we should keep deprecated enable_log_correlation documentation for these users.

See elastic/apm-agent-java#2535 (comment) - would a plain mention in the agent docs with a similar explanation and/or reference to this page here be sufficient?

@bmorelli25
Copy link
Member Author

See elastic/apm-agent-java#2535 (comment) - would a plain mention in the agent docs with a similar explanation and/or reference to this page here be sufficient?

Added a note to these docs in cb6d7f6.

@bmorelli25 bmorelli25 merged commit 5300767 into elastic:main Mar 29, 2022
@bmorelli25 bmorelli25 deleted the fix-java-docs branch March 29, 2022 20:56
bmorelli25 added a commit to bmorelli25/ecs-logging-java that referenced this pull request Mar 29, 2022
(cherry picked from commit 5300767)
@bmorelli25
Copy link
Member Author

💚 All backports created successfully

Status Branch Result
1.x

Questions ?

Please refer to the Backport tool documentation

bmorelli25 added a commit to bmorelli25/ecs-logging-java that referenced this pull request Mar 29, 2022
(cherry picked from commit 5300767)
@bmorelli25
Copy link
Member Author

💚 All backports created successfully

Status Branch Result
0.x

Questions ?

Please refer to the Backport tool documentation

bmorelli25 added a commit that referenced this pull request Mar 29, 2022
(cherry picked from commit 5300767)
bmorelli25 added a commit that referenced this pull request Mar 29, 2022
(cherry picked from commit 5300767)
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