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] Logs > Exporters > Stdout - drop leading "OpenTelemetry" from the page title #3939

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Mar 13, 2024

I wonder if y'all at the specs SIG would be open to dropping the leading "OpenTelemetry" for this and other exporter pages, in those situations were it is unnecessary?

None of the Log's other subpages start with "OpenTelemetry"; here's the list:

  • Data Model Appendix
  • Events API Interface
  • Logs Bridge API
  • Logs Data Model
  • Logs SDK
  • Logs Bridge API No-Op Implementation
  • Supplementary Guidelines

This makes "OpenTelemetry LogRecord Exporter - Standard output" stand out. So, for consistency, the Stdout exporter page probably shouldn't have OTel as the start of the title either. Also, for sake of consistency with the other exporters for Metrics and Traces, I think the title should use "Logs" rather than "LogRecord". WDYT?

/cc @theletterf @svrnm

None of the section's subpages start with OpenTelemetry so, for consistency, the Stdout exporter page probably shouldn't either. Here's the list of subpages:

Data Model Appendix
Events API Interface
Logs Bridge API
Logs Data Model
Logs SDK
Logs Bridge API No-Op Implementation
OpenTelemetry LogRecord Exporter - Standard output
Supplementary Guidelines
@chalin chalin requested review from a team March 13, 2024 15:05
@reyang
Copy link
Member

reyang commented Mar 13, 2024

I'm supportive 👍

@reyang reyang added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Mar 13, 2024
@chalin
Copy link
Contributor Author

chalin commented Mar 13, 2024

FYI, here's a PR with the other exporter page titles adjusted too:

@reyang reyang merged commit 56a7e47 into open-telemetry:main Mar 13, 2024
7 checks passed
@chalin chalin deleted the chalin-im-logs-stdout-title-adjustment-2024-03-12 branch March 13, 2024 18:46
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants