Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): organize configurations.rst #11076

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

erikayasuda
Copy link
Contributor

@erikayasuda erikayasuda commented Oct 17, 2024

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

  • 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 erikayasuda added the changelog/no-changelog A changelog entry is not required for this PR. label Oct 17, 2024
Copy link
Contributor

CODEOWNERS have been resolved as:

docs/configuration.rst                                                  @DataDog/python-guild

@pr-commenter
Copy link

pr-commenter bot commented Oct 17, 2024

Benchmarks

Benchmark execution time: 2024-10-18 21:50:50

Comparing candidate commit 7261b93 in PR branch erikayasuda/organize-configs with baseline commit a201fc0 in branch main.

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

@erikayasuda erikayasuda marked this pull request as ready for review October 18, 2024 13:41
@erikayasuda erikayasuda requested a review from a team as a code owner October 18, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant