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

[docs] [infra] hugo shortcode updates #11399

Merged
merged 9 commits into from
Feb 12, 2022

Conversation

polarweasel
Copy link
Contributor

@polarweasel polarweasel commented Feb 9, 2022

Problem: external-pointing links in admonitions (note, tip, warning) weren't getting styled correctly. This fixes that, and applies the same fix to several other shortcodes that turned out to have the same problem.

The updates allow external URLs (meaning any link that starts with http or https) to get styled as such, with the usual icon and a target of _blank. To test, have a look at the Cloud Troubleshooting page, at the bottom, and verify that the link to Yugabyte Support shows as external now. Or, have a look at the first note on the ddl_alter_table reference page, and verify that the link is styled correctly.

As for the grammar and syntax diagrams, the includeMarkdown shortcode has changed. So if they're still rendering correctly, that change passes the test. This PR also includes output from the latest version of the RRDiagram tool, which adds the ebnf language to the grammar code blocks, so those are syntax-highlighted now.

As a random example, please also verify that the code blocks and diagrams work on this page or another like it:

@netlify /latest/api/ysql/exprs/aggregate_functions/invocation-syntax-semantics/

@netlify
Copy link

netlify bot commented Feb 9, 2022

✔️ Deploy Preview for infallible-bardeen-164bc9 ready!

🔨 Explore the source changes: d30fc53

🔍 Inspect the deploy log: https://app.netlify.com/sites/infallible-bardeen-164bc9/deploys/62032c2580f9fe0008e14aeb

😎 Browse the preview: https://deploy-preview-11399--infallible-bardeen-164bc9.netlify.app/latest/api/ysql/exprs/aggregate_functions/invocation-syntax-semantics/

@netlify
Copy link

netlify bot commented Feb 9, 2022

✔️ Deploy Preview for infallible-bardeen-164bc9 ready!

🔨 Explore the source changes: 0c92f13

🔍 Inspect the deploy log: https://app.netlify.com/sites/infallible-bardeen-164bc9/deploys/6205ac863ee3db0008e8a4a0

😎 Browse the preview: https://deploy-preview-11399--infallible-bardeen-164bc9.netlify.app/latest/api/ysql/exprs/aggregate_functions/invocation-syntax-semantics/

@bllewell
Copy link
Contributor

bllewell commented Feb 9, 2022

This page has no notes, tips, or warnings. So what is there to check. The syntax diagrams seem to have come out OK. But why suspect that they would not?

@polarweasel
Copy link
Contributor Author

polarweasel commented Feb 9, 2022

@bllewell I've updated the link in the note that started this whole thing when you pointed out that links in notes weren't getting styled correctly.

Have a look at the first note on the ddl_alter_table reference page, and notice that the link (which is in markdown format as of commit 02d7ee4) is styled correctly.

As for the syntax diagrams, the includeMarkdown shortcode has changed. So if they're still rendering correctly, that change passes the test. 👍

Copy link
Contributor

@ddhodge ddhodge left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@lizayugabyte lizayugabyte left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@aishwarya24 aishwarya24 left a comment

Choose a reason for hiding this comment

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

LGTM

@polarweasel polarweasel marked this pull request as ready for review February 12, 2022 01:39
@polarweasel polarweasel merged commit cd6e3d5 into yugabyte:master Feb 12, 2022
@polarweasel polarweasel deleted the docs-hugo-shortcode-updates branch February 12, 2022 01:44
jayant07-yb pushed a commit to jayant07-yb/yugabyte-db that referenced this pull request Mar 8, 2022
External links are now correctly styled in all cases.
Also includes updated EBNF with syntax highlighting.
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.

5 participants