elastic / ecs-logging-java

https://www.elastic.co/guide/en/ecs-logging/java/current/intro.html
Apache License 2.0
139 stars 74 forks source link

docs: remove step 2 #170

Closed bmorelli25 closed 2 years ago

bmorelli25 commented 2 years ago

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 https://github.com/elastic/apm-agent-java/issues/2535#issuecomment-1075580099 for more context.

Related

For https://github.com/elastic/apm-agent-java/issues/2535.

Backport

Backport to 1.x and 0.x.

apmmachine commented 2 years ago

:green_heart: 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_tube: | Test | Results | | ------------ | :-----------------------------: | | Failed | 0 | | Passed | 196 | | Skipped | 0 | | Total | 196 |

:robot: GitHub comments

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

eyalkoren commented 2 years ago

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 https://github.com/elastic/apm-agent-java/issues/2535#issuecomment-1079852953 - would a plain mention in the agent docs with a similar explanation and/or reference to this page here be sufficient?

bmorelli25 commented 2 years ago

See https://github.com/elastic/apm-agent-java/issues/2535#issuecomment-1079852953 - 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 commented 2 years ago

šŸ’š All backports created successfully

Status Branch Result
āœ… 1.x

Questions ?

Please refer to the Backport tool documentation

bmorelli25 commented 2 years ago

šŸ’š All backports created successfully

Status Branch Result
āœ… 0.x

Questions ?

Please refer to the Backport tool documentation