Note on grammar page #1014
Note on grammar page #1014
Conversation
sql-grammar.md
Outdated
| } | ||
| </style> | ||
|
|
||
| {{site.data.alerts.callout_success}}This page describes the full CockroachDB SQL grammar. However, as a starting point, it's best to reference our <a href="sql-statements.html">statement-specific pages</a> first, which provide detailed explanations and examples.{{site.data.alerts.end}} |
There was a problem hiding this comment.
Use a markdown link: [statement-specific pages](sql-statements.html)
There was a problem hiding this comment.
As our alerts are currently set up, you have to use html formatting inside them. There's a way to enable markdown inside html, though (an extra attribute). Let me see if that works.
There was a problem hiding this comment.
Turns out that adding markdown="1" to the the relevant alert divs in _data\alerts.yml does let us use markdown formatting within alerts. One gotcha though is that the liquid before and after an alert needs to be on its own line. I'll update our internal docs on this.
| callout_success: '<div class="bs-callout bs-callout-success">' | ||
| callout_info: '<div class="bs-callout bs-callout-info">' | ||
| callout_warning: '<div class="bs-callout bs-callout-warning">' | ||
| callout_danger: '<div class="bs-callout bs-callout-danger" markdown="1">' |
There was a problem hiding this comment.
Oh I didn't know you had to add this stuff :( Thanks for figuring that out though.
This PR adds a note to the top of the full SQL grammar page encouraging users to checkout the statement-specific pages first.
It also adds a link to the warning in the beta-20170112 release notes.
Fixes #1013
This change is