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.

Sign up for GitHub

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

document fixed-table shortcode, update column-list shortcode #918

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

document fixed-table shortcode, update column-list shortcode #918

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a5d85ab
document fixed-table shortcode, update column-list shortcode
robbymilo Dec 9, 2024
fb0744a
explain how to specify column count
robbymilo Dec 10, 2024
c2fadb5
improve fixed-table description
robbymilo Dec 10, 2024
927b77f
Fix CloudWatch spelling
jdbaldry Jan 2, 2025
c9571ae
Fix heading param example
jdbaldry Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 51 additions & 6 deletions docs/sources/write/shortcodes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,13 @@ compactor:

## Column-list

Formats a list with columns. Content is equally divided between columns.
Formats a list with columns. Content is equally divided between columns unless specified with the `count` argument.

| Parameter | Description | Required |
| --------- | ----------------------------------------------------------------------------------------- | -------- |
| `count` | The number columns in desktop view. You can specify a minimum of two and maximum of four. | no |

### Example

```markdown
{{</* column-list */>}}
Expand Down Expand Up @@ -649,13 +655,13 @@ For example:
**Reference:**

```markdown
[Grafana website]: www.grafana.com
[grafana website]: www.grafana.com
```

**Body text:**

```markdown
Find more information on [Grafana][Grafana website].
Find more information on [Grafana][grafana website].
```

## Docs/shared
Expand Down Expand Up @@ -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 prevents column overflow by breaking content to a new line at any character, not just spaces between words.

### Example

```markdown
{{</* fixed-table */>}}

| Metric | CloudWatch Metric | Statistics |
| ------------------------------ | ----------------- | ------------------------------------------------------------------------ |
| **aws_amazonmq_info** | |
| **aws_amazonmq_ack_rate** | AckRate | **Average**, Maximum, Minimum, Sum, SampleCount, p50, p75, p90, p95, p99 |
| **aws_amazonmq_burst_balance** | BurstBalance | **Average**, Maximum, Minimum, Sum, SampleCount, p50, p75, p90, p95, p99 |

{{</* /fixed-table */>}}
```

Produces:

{{< fixed-table >}}

| Metric | CloudWatch Metric | Statistics |
| ------------------------------ | ----------------- | ------------------------------------------------------------------------ |
| **aws_amazonmq_info** | |
| **aws_amazonmq_ack_rate** | AckRate | **Average**, Maximum, Minimum, Sum, SampleCount, p50, p75, p90, p95, p99 |
| **aws_amazonmq_burst_balance** | BurstBalance | **Average**, Maximum, Minimum, Sum, SampleCount, p50, p75, p90, p95, p99 |

{{< /fixed-table >}}

Without the shortcode:
robbymilo marked this conversation as resolved.
Show resolved Hide resolved

| Metric | CloudWatch Metric | Statistics |
| ------------------------------ | ----------------- | ------------------------------------------------------------------------ |
| **aws_amazonmq_info** | |
| **aws_amazonmq_ack_rate** | AckRate | **Average**, Maximum, Minimum, Sum, SampleCount, p50, p75, p90, p95, p99 |
| **aws_amazonmq_burst_balance** | BurstBalance | **Average**, Maximum, Minimum, Sum, SampleCount, p50, p75, p90, p95, p99 |

## Figure

The `figure` shortcode renders an image with a caption using an HTML [`<figure>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/figure#usage_notes) element.
Expand Down Expand Up @@ -900,11 +944,12 @@ To add a new variable definition:
1. Define a [`cascade` variable](https://grafana.com/docs/writers-toolkit/write/front-matter/#cascade) in the parent topic.
1. Insert the `param` variable where it's required in the parent and child topics.

{{< admonition type="note" >}}
If you use the `param` shortcode in headings, you must use `%` in place of `<` and `>`.
For example:

For example: `{{% param VARIABLE %}}`.
{{< /admonition >}}
```markdown
# Heading {{%/* param VARIABLE */%}}
```

### Example

Expand Down
Loading