-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[docs] [infra] hugo shortcode updates #11399
Conversation
✔️ 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/ |
✔️ 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/ |
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? |
… docs-hugo-shortcode-updates
@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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
External links are now correctly styled in all cases. Also includes updated EBNF with syntax highlighting.
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
orhttps
) 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 theebnf
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/