Skip to content

Commit

Permalink
chore(docs): organize configurations.rst (#11076)
Browse files Browse the repository at this point in the history
Organizing our configuration docs. We should eventually switch over to
using Envier for all of these so they can be auto-generated and the raw
.rst file is much more clean, but for now this will help with
readability. No content was changed, just reshuffling of the ordering
and some grouping.

See the sample generated doc
[here](https://ddtrace.readthedocs.io/en/erikayasuda-organize-configs/configuration.html)
compared to what is published as
[latest](https://ddtrace.readthedocs.io/en/latest/configuration.html).

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [ ] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
  • Loading branch information
erikayasuda authored Nov 13, 2024
1 parent 2c3ab58 commit 4f7052e
Showing 1 changed file with 556 additions and 415 deletions.
Loading

0 comments on commit 4f7052e

Please sign in to comment.