docs: update documentation for upstream opentelemetry-php-distro rebase (#373)#374
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR updates documentation across the repo: DEVELOPMENT.md is restructured to document the repository/submodule layout, where to make Elastic vs non-Elastic changes, how to update the upstream submodule, and native build instructions now target 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 16 minutes and 43 seconds.Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/edot-php/configuration.md`:
- Line 76: The docs are missing the legacy alias ELASTIC_OTEL_LOG_LEVEL in the
logging options / deprecated aliases section; update the logging options and
deprecated aliases text to list ELASTIC_OTEL_LOG_LEVEL as a deprecated/legacy
alias for OTEL_PHP_LOG_LEVEL (also mirror the same addition around lines
referenced 132-138), and ensure the example sentence explicitly references both
symbols (ELASTIC_OTEL_LOG_LEVEL -> OTEL_PHP_LOG_LEVEL) so readers see the
migration mapping and preferred name.
In `@docs/release-notes/deprecations.md`:
- Around line 40-70: The deprecation table is missing the legacy env var
ELASTIC_OTEL_LOG_LEVEL and its replacement; add a row mapping
`ELASTIC_OTEL_LOG_LEVEL` to `OTEL_PHP_LOG_LEVEL` in the same table so the 1.5.0
deprecation record is complete and consistent with the other entries (match
formatting used for entries like `ELASTIC_OTEL_LOG_LEVEL_FILE` →
`OTEL_PHP_LOG_LEVEL_FILE`).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Enterprise
Run ID: da01db06-d45d-4999-a8c2-6ff09f33fc74
📒 Files selected for processing (4)
DEVELOPMENT.mddocs/reference/edot-php/configuration.mddocs/reference/edot-php/migration.mddocs/release-notes/deprecations.md
🔍 Preview links for changed docs |
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
|
@alexandra5000 Please have a look — thx! |
alexandra5000
left a comment
There was a problem hiding this comment.
Thanks! 💟 The content looks accurate and the structure is clear.
A few nitpicks to address before merging, mostly related to the Elastic style guide:
-
Several option descriptions use enable/disable language, which Vale flagged and which Elastic style discourages. I know most of these are pre-existing descriptions where only the env var name was changed, but it's worth fixing them while you're in there.
-
Also we don't use latinisms (via, e.g., etc.) - I also flagged this.
-
Some copy-paste errors.
-
Section anchor change - I would advise against that.
alexandra5000
left a comment
There was a problem hiding this comment.
Thanks! 💟 The content looks accurate and the structure is clear.
A few nitpicks to address before merging, mostly related to the Elastic style guide:
-
Several option descriptions use enable/disable language, which Vale flagged and which Elastic style discourages. I know most of these are pre-existing descriptions where only the env var name was changed, but it's worth fixing them while you're in there.
-
Also we don't use latinisms (via, e.g., etc.) - I also flagged this.
-
Some copy-paste errors.
-
Section anchor change - I would advise against that.
Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/edot-php/configuration.md`:
- Line 21: Update the broken internal link by changing the anchor target used in
the link text "*EDOT PHP-specific configuration options*" from
"#options-only-available-in-edot-php" to the actual heading-generated anchor
"#edot-php-specific-configuration-options" so the link matches the heading (the
heading on line 62 that produces edot-php-specific-configuration-options) and
the pipeline build will succeed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Enterprise
Run ID: d4c55575-a59b-4577-8701-4348ec24937b
📒 Files selected for processing (4)
DEVELOPMENT.mddocs/reference/edot-php/configuration.mddocs/reference/edot-php/migration.mddocs/release-notes/deprecations.md
alexandra5000
left a comment
There was a problem hiding this comment.
2 fixes left to apply, approving to unblock 🚀
No description provided.