docs-v2/content/shared
Scott Anderson 1522e734b9
Update shared content usage in v2 docs and more (#5953)
* replaced all oss- and cloud-only shortcodes

* removed duplicate oss calls and replaced with shared source

* base changes for shared v2 content

* restored shared grafana content

* removed frontmatter from shared v2 content

* WIP fixing lists with show-in shortcode

* fix lists that use show-in shortcode

* updated all v2 files to remove duplicate-oss and use source sharing

* update prepend and append frontmatter to just use string input

* fixed broken menu keys
2025-04-02 15:54:32 -06:00
..
influxdb-v2 Update shared content usage in v2 docs and more (#5953) 2025-04-02 15:54:32 -06:00
influxdb3-admin Base updates for beta (#5893) 2025-03-16 22:44:39 -05:00
influxdb3-api-reference fix: LInks and headings. Replace `latest` with `v2`. Specify OSS v2 in headings. Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866, Closes Flux docs: replace `/influxdb/latest` with `/influxdb/v2` #5864. Linting cleanup, removing terminal prompt from examples 2025-02-27 17:50:16 -06:00
influxdb3-cli update influxdb3 option list formats, closes #5937 (#5938) 2025-03-28 08:16:13 -06:00
influxdb3-internals-reference Apply suggestions from code review 2025-03-20 16:55:48 -05:00
influxdb3-query-guides suggestion fixes 2025-03-20 10:05:51 -05:00
influxdb3-sample-data Base updates for beta (#5893) 2025-03-16 22:44:39 -05:00
influxdb3-visualize Update Grafana token instructions for Core and Entperprise (#5910) 2025-03-18 15:14:41 -06:00
influxdb3-write-guides Base updates for beta (#5893) 2025-03-16 22:44:39 -05:00
influxql-v3-reference Add InfluxDB 3 query guides (#5798) 2025-01-23 10:18:45 -07:00
sql-reference Updates SQL reference (#5886) 2025-03-12 09:21:42 -06:00
v3-core-enterprise-release-notes Apply suggestions from code review 2025-04-02 13:11:02 -05:00
v3-core-get-started Merge branch 'master' into docs/v3/write-steps 2025-03-24 11:22:04 -05:00
v3-core-plugins updating source path in example 2025-03-28 15:59:21 -07:00
v3-distributed-admin-custom-partitions updated all notes and warnings in influxdb3 to use gh alert syntax (#5890) 2025-03-13 17:02:04 -06:00
v3-enterprise-get-started chore(influxdb3): Get started: make examples consistent, fix formatting, remove http protocol from --http-bind options. 2025-03-21 17:51:34 -05:00
README.md chore(v3): Migrate admin/custom-partitioning to shared content 2025-01-09 10:22:12 -06:00
_index.md chore(v3): Migrate admin/custom-partitioning to shared content 2025-01-09 10:22:12 -06:00
v3-line-protocol.md updated all notes and warnings in influxdb3 to use gh alert syntax (#5890) 2025-03-13 17:02:04 -06:00

README.md

Shared content

This section is for content shared across multiple products and versions. The /shared/_index.md frontmatter, marks the /shared directory and its children as draft so they don't get rendered when the site is built, but the contents of each shared documented is included in pages that use the file as a source in their frontmatter.

Use shared content

  1. Create a new folder for the content in the content/shared/ directory.

  2. Copy the markdown files into the new folder.

  3. Remove the frontmatter from the markdown files in the shared directory. If the first line starts with a shortcode, add an HTML comment before the first line, otherwise hugo will err.

  4. In each of the files that use the shared content, add a source to the frontmatter that points to the shared markdown file—for example:

    source: /shared/influxql-v3-reference/regular-expressions.md
    
  5. In the doc body, remove the shared Markdown text and add a comment that points to the shared file, in case someone happens upon the page in the repo--for example, in /content/3/core/reference/influxql/regular-expressions.md, add the following: