Skip to content

Commit e721416

Browse files
authored
Merge branch 'master' into docs/5823-write-lp-guide
2 parents 46b4665 + 6de0ea0 commit e721416

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -546,6 +546,25 @@ Insert warning markdown content here.
546546
{{% /warn %}}
547547
```
548548

549+
### Product data
550+
551+
Display the full product name and version name for the current page--for example:
552+
553+
- InfluxDB 3 Core
554+
- InfluxDB 3 Cloud Dedicated
555+
556+
```md
557+
{{% product-name %}}
558+
```
559+
560+
Display the short version name (part of the key used in `products.yml`) from the current page URL--for example:
561+
562+
- `/influxdb3/core` returns `core`
563+
564+
```md
565+
{{% product-key %}}
566+
```
567+
549568
### Enterprise Content
550569

551570
For sections content that relate specifically to InfluxDB Enterprise, use the `{{% enterprise %}}` shortcode.

content/shared/v3-core-plugins/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ influxdb3 install package <PACKAGE_NAME>
255255
--name CONTAINER_NAME \
256256
-v /path/to/.influxdb3/data:/data \
257257
-v /path/to/.influxdb3/plugins:/plugins \
258-
quay.io/influxdb/influxdb3-core:latest \
258+
quay.io/influxdb/influxdb3-{{< product-key >}}:latest \
259259
serve --node-id=node0 \
260260
--object-store=file \
261261
--data-dir=/data \

layouts/shortcodes/product-key.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{- $productPathData := findRE "[^/]+.*?" .Page.RelPermalink -}}
2+
{{- $currentProduct := index $productPathData 1 -}}
3+
{{ $currentProduct }}

0 commit comments

Comments
 (0)