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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(opentelemetry): add title to code blocks #25496

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Add title to code blocks in Opentelemetry document

Context

Material for MkDocs can show a filename or title in the codeblock. I think this looks better than having the filename "floating above" the corresponding code block.

When you view the file on GitHub the "nice preview" does not show the title. So we're trading a nicer look in the published doc, for a worse experience when browsing the Markdown files on GitHub. In the edit mode or raw mode you'll see the title in the code block, because you're looking at the plain text.

We should first try this on a single page, if it breaks it's easy to revert.

Let me know if you want me to go through the docs and put all the filenames in the code blocks (once we're sure it works properly)? 馃槈

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@rarkins rarkins added this pull request to the merge queue Oct 30, 2023
Merged via the queue into renovatebot:main with commit 21063f7 Oct 30, 2023
34 checks passed
@HonkingGoose HonkingGoose deleted the docs/add-title-to-codeblock-opentelemetry branch October 30, 2023 14:01
@renovate-release
Copy link
Collaborator

馃帀 This PR is included in version 37.36.2 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

jon4hz pushed a commit to jon4hz/renovate that referenced this pull request Nov 9, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants