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

feat(docs) Add docs for deletions subsystem #28915

Merged
merged 1 commit into from
Sep 29, 2021
Merged

Conversation

markstory
Copy link
Member

I thought these docs were a little too low-level and specific to be in develop.sentry.io and decided to expand the existing module docstring instead.

I thought these docs were a little too low-level and specific to be in
develop.sentry.io and decided to expand the existing module docstring
instead.
@markstory markstory requested a review from a team September 28, 2021 20:49
Copy link
Member

@wedamija wedamija left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good.

One thing that would be good to figure out as a backend team would be how to remind people to add things to deletions. I forget to do this all the time, and I'm sure many people aren't aware of it at all.

I wonder if there's a way we can automate it somehow. Like all models need to be explicitly added to some list to mark off that deletions have at least been considered

@markstory
Copy link
Member Author

One thing that would be good to figure out as a backend team would be how to remind people to add things to deletions. I forget to do this all the time, and I'm sure many people aren't aware of it at all.

Yeah we don't have a good system for this yet. I'm going to think on this a bit more, as I agree this should be added to CI as a test to ensure that all models with foreign keys or xyz_id properties to one of the 'root' objects are included in deletions.

@markstory markstory merged commit fa43324 into master Sep 29, 2021
@markstory markstory deleted the add-deletion-docs branch September 29, 2021 18:15
vuluongj20 pushed a commit that referenced this pull request Sep 30, 2021
I thought these docs were a little too low-level and specific to be in
develop.sentry.io and decided to expand the existing module docstring
instead.
@github-actions github-actions bot locked and limited conversation to collaborators Oct 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants