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

Consistency update for TOCs of manual instrumentation pages #2925

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Jun 28, 2023

Another consistency update for the manual instrumentation pages. After this PR gets merged:

  • all languages more or less have the same structure:
    Setup
    Traces
    Metrics
    Logs
    ...
    Next Steps
    
  • if a signal is not yet stable or documentation is missing, this is called out in place. if the signal is stable, readers are asked to contribute
  • Moved the section about OTLP Exporter for erlang to a separate page to follow the structure of other languages
  • Some other structural updates to create consistency

@svrnm svrnm requested review from a team as code owners June 28, 2023 15:31
@svrnm svrnm requested a review from a team June 28, 2023 15:31
@svrnm svrnm requested review from a team as code owners June 28, 2023 15:31
Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

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

Overall LGTM, just wondering why some files don't have a top-level Setup section? e.g., .NET

@svrnm
Copy link
Member Author

svrnm commented Jun 28, 2023

Overall LGTM, just wondering why some files don't have a top-level Setup section? e.g., .NET

That's a task for another update. I added some where possible, but that might need some extra work to create this consistently.

@cartermp
Copy link
Contributor

Sounds good!

@cartermp cartermp merged commit 5b82523 into open-telemetry:main Jun 28, 2023
8 checks passed
@svrnm svrnm deleted the manual-instrumentation-toc-consistency-update branch October 9, 2023 08:33
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.

None yet

2 participants