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

Add missing link, and remove admon markup #45

Merged
merged 2 commits into from
May 14, 2021
Merged

Conversation

Loquacity
Copy link
Contributor

Description

Link was written, but no URL provided. This PR adds a URL, and removes the unnecessary admon markup.

Version

Which documentation version does this PR apply to?

  • Latest (Default)
  • Version 1.7
  • Older [specify]

Links

Community report: https://timescaledb.slack.com/archives/C4GT3N90X/p1620772714211200

@github-actions
Copy link

Copy link
Contributor

@jonatas jonatas left a comment

Choose a reason for hiding this comment

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

I don't get why we're removing the highlight block.

AFAIR to use highlight with links we should have default MD markup for links like anchor.

@Loquacity
Copy link
Contributor Author

I don't get why we're removing the highlight block.

AFAIR to use highlight with links we should have default MD markup for links like anchor.

Oh, I removed it more because it was a bit unnecessary. It has a lot more content in it than an admon should have,. and there's nothing in it that really needs to be called out. Additionally, it's really important to remember that readers quite often skip over admons, especially if they're over used. We need to make sure we're keeping admons to things that are actually really important, and use them sparingly.

@jonatas
Copy link
Contributor

jonatas commented May 14, 2021

Thank you @Loquacity!

@Loquacity Loquacity merged commit df3c3c6 into latest May 14, 2021
@Loquacity Loquacity deleted the realtimeca-404-lana branch May 14, 2021 06:24
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