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

[editorial] Spec updates for OTel website publication #149

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Jun 28, 2023

Updates (task list taken from #148) made in this PR:

Local repo preview: https://github.com/open-telemetry/opamp-spec/blob/9ba5f927bec431e8997d0cdc6e406bd82740cd31/specification.md

/cc @tigrannajaryan @svrnm @cartermp

@chalin chalin requested a review from a team June 28, 2023 20:28
@@ -173,7 +185,7 @@ Note: this document requires a simplification pass to reduce the scope, size and

</details>

# Introduction
## Introduction
Copy link
Contributor Author

@chalin chalin Jun 28, 2023

Choose a reason for hiding this comment

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

@tigrannajaryan et al. - since there is no significant content above this point, I'd drop this header. It naturally follows that the prose below the page title is introductory. E.g., there is no "Introduction" heading in the OTLP spec. WDYT?

specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
@chalin
Copy link
Contributor Author

chalin commented Jul 3, 2023

Anything left to do before this can get merged?

@tigrannajaryan tigrannajaryan merged commit 90612ae into open-telemetry:main Jul 3, 2023
@chalin chalin deleted the chalin-im-spec-updates-2023-06-28 branch July 7, 2023 13:37
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.

[editorial] Update spec to make it suitable for publication on the OTel website
2 participants