Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix prepared a fix for the issue found in the latest run.
- ✅ Fixed: Duplicated config example across two documentation files
- I removed the duplicated YAML blocks and replaced the defaults wording with a reference to the Getting Started example config mapping.
Or push these changes by commenting:
@cursor push d254b10ff4
Preview (d254b10ff4)
diff --git a/docs/product/relay/options.mdx b/docs/product/relay/options.mdx
--- a/docs/product/relay/options.mdx
+++ b/docs/product/relay/options.mdx
@@ -22,26 +22,6 @@
## Configuration Reference
-For a comprehensive and up-to-date list of all configuration options, see [ConfigValues](https://getsentry.github.io/relay/relay_config/struct.ConfigValues.html). Note that some options, such as `processing`, are only relevant when [self-hosting](https://develop.sentry.dev/self-hosted/).
+For a comprehensive and up-to-date list of all configuration options, see [ConfigValues](https://getsentry.github.io/relay/relay_config/struct.ConfigValues.html). Note that some options, such as `processing`, are only relevant when [self-hosting](https://develop.sentry.dev/self-hosted/).
-All configuration values are optional and default to these settings:
-
-```yaml {tabTitle:Run in Docker}
-relay:
- mode: managed
- # The upstream hostname is taken from any of your DSNs.
- # Go to your Project Settings, and then to "Client Keys (DSN)" to see them.
- upstream: https://___ORG_INGEST_DOMAIN___
- host: 0.0.0.0
- port: 3000
-```
-
-```yaml {tabTitle:Run Executable}
-relay:
- mode: managed
- # The upstream hostname is taken from any of your DSNs.
- # Go to your Project Settings, and then to "Client Keys (DSN)" to see them.
- upstream: https://___ORG_INGEST_DOMAIN___
- host: 127.0.0.1
- port: 3000
\ No newline at end of file
-```
+For an example `config.yml` showing how `ConfigValues` map to YAML keys, see [Getting Started](../getting-started/).
\ No newline at end of fileThis Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


DESCRIBE YOUR PR
As a follow up on #17114 (review) :
ConfigValuesinstead of the entire crate.ConfigValuesmap to keys in the actual config.ymlFixes https://linear.app/getsentry/issue/INGEST-687/replace-product-relay-configuration-options-with-link-to-rust-docs
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES