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

[SNOW-85] Document RAW tables #94

Merged
merged 5 commits into from
Dec 19, 2024
Merged

[SNOW-85] Document RAW tables #94

merged 5 commits into from
Dec 19, 2024

Conversation

jaymedina
Copy link
Contributor

@jaymedina jaymedina commented Dec 17, 2024

problem

Most of the bronze layer tables and their columns were missing documentation.

solution

Add table and column comments for all the bronze layer tables that don't have. I used the Synapse-Stack-Builder repo and the Jira documentation for column and table descriptions.

testing

I ran all the scripts against the raw tables in this clone and was able to confirm all table + column comments were applied.

@jaymedina jaymedina marked this pull request as ready for review December 18, 2024 05:54
@jaymedina jaymedina requested a review from a team as a code owner December 18, 2024 05:54
Copy link
Member

@thomasyu888 thomasyu888 left a comment

Choose a reason for hiding this comment

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

🔥 LGTM! Note: I did not carefully read all of the docstrings AND I really hope GPT or copilot was leveraged in this endeavor.

Thanks so much!

@jaymedina
Copy link
Contributor Author

Codeium 😄 Thanks! I'll leave it open for @philerooski to give it a final pass jic

Copy link
Collaborator

@philerooski philerooski left a comment

Choose a reason for hiding this comment

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

What information did you find in the Confluence documentation that wasn't available in the Synapse-Stack-Builder config?

@jaymedina
Copy link
Contributor Author

What information did you find in the Confluence documentation that wasn't available in the Synapse-Stack-Builder config?

The descriptions of the tables and columns for certifiedquiz and certifiedquizquestions were not on the Synapse-Stack-Builder config I think just because they are deprecated tables that got replaced with the snapshots counterparts, but I wanted to document them anyway because we haven't removed them from prod and so people might still be using them for their queries.

@jaymedina jaymedina merged commit ba28178 into dev Dec 19, 2024
3 checks passed
@jaymedina jaymedina deleted the snow-85-document-raw-tables branch December 19, 2024 22:12
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.

3 participants