Skip to content

Conversation

@shashjar
Copy link
Member

@shashjar shashjar commented Feb 2, 2026

Adds comprehensive documentation for the ST consumer configuration structure to address the issue of scattered configuration files.

This PR introduces docs/ST_CONSUMER_CONFIGURATION.md, which includes:

  • A quick reference table mapping common changes to the relevant files.
  • Detailed descriptions of each configuration file's purpose and contents.
  • Step-by-step guides for common tasks (e.g., adjusting KEDA replicas, Kafka topic settings).
  • Explanations of configuration hierarchy, debugging tips, and naming conventions.

This documentation aims to improve clarity and reduce the effort required for engineers to locate and modify ST consumer configurations.

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.


Linear Issue: ID-1303

Open in Cursor Open in Web

- Create detailed documentation mapping 'I need to change X' → 'edit file Y'
- Document file structure for ST consumer config in ops repo
- Include quick reference table for common configuration tasks
- Add examples for KEDA autoscaling, Kafka topics, and regional overrides
- Document configuration hierarchy and precedence
- Provide debugging tips and common workflows

Resolves INC-1567: Document ops repo structure for ST consumer config

Co-authored-by: shashank.jarmale <shashank.jarmale@sentry.io>
@cursor
Copy link
Contributor

cursor bot commented Feb 2, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@linear
Copy link

linear bot commented Feb 2, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants