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

[tracing][doc] PromptFlow Span Specifications #3020

Merged
merged 11 commits into from
May 13, 2024
Merged

Conversation

liucheng-ms
Copy link
Contributor

Description

This pull request introduces a update to the PromptFlow span documentation. The doc include refined explanations of the span types, standardized formatting for attributes and events, and the addition of a conclusion section that emphasizes the importance of adhering to the tracing specifications for system transparency and consistency.

All Promptflow Contribution checklist:

  • The pull request does not introduce [breaking changes].
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: suggested workflow.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@liucheng-ms liucheng-ms requested a review from a team as a code owner April 25, 2024 12:03
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 25, 2024
@liucheng-ms liucheng-ms changed the title Add doc on PromptFlow Span Specifications Add Document on PromptFlow Span Specifications Apr 25, 2024
@liucheng-ms liucheng-ms changed the title Add Document on PromptFlow Span Specifications [tracing][document] Add Document on PromptFlow Span Specifications Apr 26, 2024
@liucheng-ms liucheng-ms changed the title [tracing][document] Add Document on PromptFlow Span Specifications [tracing][document] PromptFlow Span Specifications Apr 26, 2024
@liucheng-ms liucheng-ms changed the title [tracing][document] PromptFlow Span Specifications [tracing][doc] PromptFlow Span Specifications Apr 26, 2024
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
docs/how-to-guides/tracing/trace_span.md Outdated Show resolved Hide resolved
@liucheng-ms liucheng-ms force-pushed the liucheng/20240424_doc branch from 830e857 to 6902503 Compare April 29, 2024 12:14
jiaochenlu
jiaochenlu previously approved these changes May 13, 2024
@liucheng-ms liucheng-ms merged commit d4c4a86 into main May 13, 2024
11 checks passed
@liucheng-ms liucheng-ms deleted the liucheng/20240424_doc branch May 13, 2024 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants