Skip to content

[error-tracking] Apply general doc update #28724

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

[error-tracking] Apply general doc update #28724

wants to merge 16 commits into from

Conversation

Guillaume-Barrier
Copy link
Contributor

@Guillaume-Barrier Guillaume-Barrier commented Apr 11, 2025 •
edited
Loading

Miscellaneous doc updates of some Error Tracking pages:

  • grouping
  • explorer
  • issue states
  • data collection
  • troubleshooting

📝 See gdoc for tracking

@github-actions github-actions bot added the Images Images are added/removed with this PR label Apr 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 11, 2025 •
edited
Loading

Preview links (active after the build_preview check completes)

Modified Files

@Guillaume-Barrier Guillaume-Barrier marked this pull request as ready for review April 14, 2025 12:31
@Guillaume-Barrier Guillaume-Barrier requested a review from a team as a code owner April 14, 2025 12:31
@joepeeples joepeeples added the editorial review Waiting on a more in-depth review label Apr 14, 2025
iadjivon
iadjivon reviewed Apr 14, 2025
View reviewed changes
content/en/error_tracking/manage_data_collection.md
- rule 3 (this rule is disabled): team:security
- rule 4: service:foo

The processing flow is as follows:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The processing flow is as follows:
The processing flow is as follows:

In this section, it might be helpful to explain the result of the example given. In essence describe the diagram in words. (i.e. what is happening as the flow progresses and what is the end result for this specific event?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can do that! I thought it's pretty clear, we used to have nothing.
Also do we need a proper designer to work on this schematic? I've heard from @meghanlo someone made the diagram we have in issue states.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I see! Think that the image and steps are wonderful additions. I think an explanation around it might help when users need to create their own steps to satisfy their use cases. Sort of like this explanation for workflows ( but less in-depth

iadjivon
iadjivon requested changes Apr 14, 2025
View reviewed changes
Copy link
Contributor

@iadjivon iadjivon left a comment

Choose a reason for hiding this comment

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

Hi Guillaume, thanks for these changes. I have made some small changes. Let me know what you think and if you have any questions.

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

@iadjivon iadjivon

@meghanlo meghanlo

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Guillaume-Barrier @iadjivon @joepeeples