dd-trace-py icon indicating copy to clipboard operation
dd-trace-py copied to clipboard

chore(docs): organize configurations.rst

Open erikayasuda opened this issue 1 year ago • 2 comments

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 compared to what is published as latest.

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
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

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 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

erikayasuda avatar Oct 17 '24 20:10 erikayasuda

CODEOWNERS have been resolved as:

docs/configuration.rst                                                  @DataDog/python-guild

github-actions[bot] avatar Oct 17 '24 20:10 github-actions[bot]

Benchmarks

Benchmark execution time: 2024-11-13 19:52:33

Comparing candidate commit f76c0a9d691a69fc9820baa330a509cce5908fff in PR branch erikayasuda/organize-configs with baseline commit 2c3ab58922c6b1029a57dbbfd8e6bcfead6a17ed in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 388 metrics, 2 unstable metrics.

pr-commenter[bot] avatar Oct 17 '24 20:10 pr-commenter[bot]