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

Update plugin configuration docs #488

Merged

Conversation

nikita-tkachenko-datadog
Copy link
Collaborator

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Updates plugin documentation following the configuration structure update.
Instructions for configuring the plugin via UI, Groovy scripts and environment variables are updated.

The configuration changes are backward-compatible, so existing scripts and environment variables continue to work, but going forward the users will benefit from utilising the new structure because it is simpler and clearer.

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added changelog/no-changelog Changes don't appear in changelog documentation Documentation related changes labels Jan 7, 2025
@nikita-tkachenko-datadog nikita-tkachenko-datadog marked this pull request as ready for review January 7, 2025 14:34
@nikita-tkachenko-datadog nikita-tkachenko-datadog merged commit 9678de8 into master Jan 10, 2025
19 checks passed
@nikita-tkachenko-datadog nikita-tkachenko-datadog deleted the nikita-tkachenko/update-configuration-docs branch January 10, 2025 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog Changes don't appear in changelog documentation Documentation related changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants