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

Bigeye documentation #842

Merged
merged 2 commits into from
Sep 13, 2024
Merged

Bigeye documentation #842

merged 2 commits into from
Sep 13, 2024

Conversation

alekhyamoz
Copy link
Contributor

Initial Bigeye documentation that guides users on essential Bigeye features, how to deploy metrics and issues management.

@alekhyamoz
Copy link
Contributor Author

@kik-kik or @scholtzan please feel free to add or modify the documentation (esp. the recommendations section)

badboy
badboy previously requested changes Sep 10, 2024
src/SUMMARY.md Outdated Show resolved Hide resolved
src/SUMMARY.md Outdated Show resolved Hide resolved
src/cookbooks/data_quality/collections.md Outdated Show resolved Hide resolved
src/cookbooks/data_quality/intro.md Outdated Show resolved Hide resolved
src/cookbooks/data_quality/intro.md Outdated Show resolved Hide resolved
src/cookbooks/data_quality/issues_management.md Outdated Show resolved Hide resolved
src/cookbooks/data_quality/issues_management.md Outdated Show resolved Hide resolved
src/cookbooks/data_quality/issues_management.md Outdated Show resolved Hide resolved
@alekhyamoz alekhyamoz requested a review from badboy September 10, 2024 14:18
@alekhyamoz
Copy link
Contributor Author

@badboy thank you for the very helpful comments.

@alekhyamoz alekhyamoz force-pushed the bigeye_documentation_1 branch 3 times, most recently from 1e55af5 to e4d981e Compare September 10, 2024 16:06

To add metrics to a collection in Bigeye, navigate to the collection you want to update and click "Add Metrics." You can search or filter for specific metrics that align with your monitoring goals.

<iframe width="560" height="315" src="https://www.youtube.com/embed/ZFRAaeX6z8w?si=ba3jYHTQNZPDi9ua" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we should upload these videos to our internal GDrive instead of having them publicly on Youtube. Just in case it shows sensitive information.

Copy link
Member

Choose a reason for hiding this comment

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

It was my recommendation to put them on Youtube, to make them embeddable (I would have liked to have it on airmo, but that doesn't have an embeddable player).

This is going on a public doc site, so I would prefer to have the videos also publicly accessible. I haven't checked them in detail if there's something that shouldn't be online. If there is maybe we should redact that information instead of making those videos hidden.
The videos are currently marked as unlisted (mostly so they don't clutter the channel page).
But this now being in a public PR means they are public.

@badboy
Copy link
Member

badboy commented Sep 11, 2024

I can fix up spellcheck and prettifier once this is reviewed. The link checks seem to be broken on main, I'll fix that separately.

src/SUMMARY.md Outdated Show resolved Hide resolved
src/SUMMARY.md Outdated Show resolved Hide resolved
@alekhyamoz alekhyamoz force-pushed the bigeye_documentation_1 branch from 85d7f0c to afeefc2 Compare September 11, 2024 15:30
Copy link
Contributor

@scholtzan scholtzan left a comment

Choose a reason for hiding this comment

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

A few suggestions, but looking good.

I guess in a follow-up PR we might want to add some docs around BigConfig and how Bigeye integrates into our ETL pipeline.

src/cookbooks/data_monitoring/intro.md Outdated Show resolved Hide resolved
src/SUMMARY.md Outdated Show resolved Hide resolved
src/SUMMARY.md Outdated Show resolved Hide resolved
src/cookbooks/data_monitoring/deploying_metrics.md Outdated Show resolved Hide resolved
src/cookbooks/data_monitoring/deploying_metrics.md Outdated Show resolved Hide resolved
src/cookbooks/data_monitoring/features.md Outdated Show resolved Hide resolved
src/cookbooks/data_monitoring/features.md Outdated Show resolved Hide resolved
src/cookbooks/data_monitoring/cost_considerations.md Outdated Show resolved Hide resolved
@badboy badboy force-pushed the bigeye_documentation_1 branch from aeb27dd to 1191155 Compare September 13, 2024 09:32
@badboy badboy force-pushed the bigeye_documentation_1 branch from 1191155 to 0ce2be8 Compare September 13, 2024 10:13
@badboy badboy force-pushed the bigeye_documentation_1 branch from 0ce2be8 to 6195ec2 Compare September 13, 2024 10:39
Copy link
Member

@badboy badboy left a comment

Choose a reason for hiding this comment

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

Squashed, rebased and prettified/links-fixed/etc. Ready to land.

Starting at h1 everywhere
@badboy badboy force-pushed the bigeye_documentation_1 branch from 6195ec2 to 2ae8c00 Compare September 13, 2024 10:46
@badboy badboy merged commit 0525732 into main Sep 13, 2024
9 checks passed
@badboy badboy deleted the bigeye_documentation_1 branch September 13, 2024 10:48
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.

4 participants