From f4a93cba38f91e0a83fe408d0d511145abd22d20 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 25 Sep 2025 11:59:51 -0500 Subject: [PATCH] chore(qol): Instruction to use /version/ in shared links --- .github/instructions/content.instructions.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/.github/instructions/content.instructions.md b/.github/instructions/content.instructions.md index 3467792cd..cd6c3019f 100644 --- a/.github/instructions/content.instructions.md +++ b/.github/instructions/content.instructions.md @@ -208,6 +208,23 @@ When building shared content, use the `show-in` and `hide-in` shortcodes to show or hide blocks of content based on the current InfluxDB product/version. For more information, see [show-in](#show-in) and [hide-in](#hide-in). +#### Links in shared content + +When creating links in shared content files, use `/influxdb3/version/` instead of the `{{% product-key %}}` shortcode. +The keyword `version` gets replaced during the build process with the appropriate product version. + +**Use this in shared content:** +```markdown +[Configuration options](/influxdb3/version/reference/config-options/) +[CLI serve command](/influxdb3/version/reference/cli/influxdb3/serve/) +``` + +**Not this:** +```markdown +[Configuration options](/influxdb3/{{% product-key %}}/reference/config-options/) +[CLI serve command](/influxdb3/{{% product-key %}}/reference/cli/influxdb3/serve/) +``` + #### Shortcodes in Markdown files For the complete shortcodes reference, see `/.github/instructions/shortcodes-reference.instructions.md`. @@ -219,4 +236,4 @@ For the complete shortcodes reference, see `/.github/instructions/shortcodes-ref - Format code examples to fit within 80 characters - Use long options in command line examples (`--option` instead of `-o`) - Use GitHub callout syntax for notes and warnings -- Image naming: `project/version-context-description.png` \ No newline at end of file +- Image naming: `project/version-context-description.png`