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

Change admonition title style/syntax #3107

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

colleenmcginnis
Copy link
Contributor

The new AsciiDoc serverless docs have lots of admonitions with titles. Admonition titles are currently h3s. I'd like to change them to:

  • Not use a heading tag. Using an h3 messes with the "On this page" list of headings and can result in headings that are not necessarily incremental (admonitions can come after h3s, h4s, etc).
  • Style using bold text instead of larger text. This is subjective. I just think the current text is too big.
Before After
Screenshot 2024-11-06 at 5 03 33 PM Screenshot 2024-11-06 at 5 03 54 PM

@colleenmcginnis colleenmcginnis self-assigned this Nov 6, 2024
Copy link

github-actions bot commented Nov 6, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review November 7, 2024 14:51
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner November 7, 2024 14:51
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

I agree it looks better

@colleenmcginnis colleenmcginnis merged commit 4658579 into elastic:master Nov 7, 2024
5 checks passed
@colleenmcginnis colleenmcginnis deleted the admon-title branch November 7, 2024 20:34
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.

2 participants