document fixed-table shortcode, update column-list shortcode #918
Conversation
robbymilo
requested review from
chri2547,
clayton-cornell,
knylander-grafana and
a team
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| {{< fixed-table >}} | ||
|
|
||
| | Metric | Cloudwatch Metric | Statistics | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Grafana.Spelling] Did you really mean 'Cloudwatch'? The Grafana dictionary might not know of this word yet. To add a new word, refer to Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. For UI elements, use bold formatting. The spell checker doesn't check words with bold formatting. For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use code formatting. The spell checker doesn't check words with code formatting.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
|
|
||
| {{< fixed-table >}} | ||
|
|
||
| | Metric | Cloudwatch Metric | Statistics | |
There was a problem hiding this comment.
[Grafana.AmazonCloudWatch] Use 'CloudWatch' instead of 'Cloudwatch'.
For more information, refer to https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
|
|
||
| Without the shortcode: | ||
|
|
||
| | Metric | Cloudwatch Metric | Statistics | |
There was a problem hiding this comment.
[Grafana.AmazonCloudWatch] Use 'CloudWatch' instead of 'Cloudwatch'.
For more information, refer to https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
|
|
||
| Without the shortcode: | ||
|
|
||
| | Metric | Cloudwatch Metric | Statistics | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Grafana.Spelling] Did you really mean 'Cloudwatch'? The Grafana dictionary might not know of this word yet. To add a new word, refer to Add words to the Grafana Labs dictionary. Alternatively, raise an issue and a maintainer will add it for you. For UI elements, use bold formatting. The spell checker doesn't check words with bold formatting. For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use code formatting. The spell checker doesn't check words with code formatting.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
| @@ -716,6 +722,44 @@ Headings are offset by one level, so if the source content contains an `h1`, the | |||
| {{</* docs/shared lookup="shared-page.md" source="enterprise-metrics" version="<GEM_VERSION>" leveloffset="+1" */>}} | |||
| ``` | |||
|
|
|||
| ## Fixed-table | |||
|
|
|||
| The `fixed-table` shortcode allows the column contents to be wrapped to a new line at any character. | |||
There was a problem hiding this comment.
Still more questions. Presumably you can specify the width of the table or column to define when the wrapping is supposed to begin?
There was a problem hiding this comment.
Specifying the fixed (character?) width of a column would be super useful... and would resolve other issues I've trying to work around.
There was a problem hiding this comment.
At this time we do not have a way to specify the width of a column as we would have to consider how it works with desktop, mobile, etc. breakpoints.
I've clarified this line in c2fadb5.
for https://github.com/grafana/website/issues/22852
for https://github.com/grafana/website/issues/23016
upstream of https://github.com/grafana/website/pull/23049