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

Add docs for stable telemetry #20648

Merged
merged 4 commits into from
Apr 16, 2024
Merged

Conversation

rohandubal
Copy link
Contributor

Description

Added fluidframework.com documentation for stable telemetry.

This PR will be merged after rc-3 release.

@github-actions github-actions bot added documentation Improvements or additions to documentation base: main PRs targeted against main branch labels Apr 12, 2024
Copy link
Contributor

@alexvy86 alexvy86 left a comment

Choose a reason for hiding this comment

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

@tylerbutler recently posted about binary files in the repo. Do we want to leverage git-lfs again for things like these? In this case since they're going into the public docs site, I think they must go in the repo (vs the wiki or some other place).

@rohandubal rohandubal marked this pull request as ready for review April 15, 2024 20:47
Copy link
Member

Choose a reason for hiding this comment

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

We should not commit binary files to the repo. If we need images we can upload them to our CDN and reference them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tylerbutler @alexvy86 updated PR to use CDN for image assets

Copy link
Contributor

@alexvy86 alexvy86 left a comment

Choose a reason for hiding this comment

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

The content here is good, the comment below is a bit more a "meta" concern.

@@ -0,0 +1,326 @@
---
title: Typed telemetry
menuPosition: 3
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it might make sense to make this #2 and the existing telemetry one #3, but I need to chew on it more. Might also consider a bit of updating the existing one. There's good content there, but I think it might be confusing to have both articles especially if that one doesn't say something along the lines of "this is for Fluid's internal telemetry which is subject to change", and a reworded title.

Copy link
Contributor

@alexvy86 alexvy86 left a comment

Choose a reason for hiding this comment

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

It's better to have it than not, whatever we decide on the other telemetry one, so approving.

@tylerbutler tylerbutler merged commit 5c87f64 into main Apr 16, 2024
29 checks passed
@tylerbutler tylerbutler deleted the rohanduba/telemetry-docs-update branch April 16, 2024 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
base: main PRs targeted against main branch documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants