docs-v2/content/shared
Jason Stirnaman d9224d82c0 WIP(3-api): Prelim write and query API reference with compatibility description 2025-01-12 20:56:55 -06:00
..
influxdb3-cli InfluxDB 3 Core CLI (#5750) 2025-01-12 14:31:59 -07:00
influxql-v3-reference Influxdb3 restructure (#5744) 2025-01-10 15:58:05 -07:00
sql-reference Consolidate SQL reference docs (#5712) 2024-12-16 13:08:14 -07:00
v3-api-reference/api WIP(3-api): Prelim write and query API reference with compatibility description 2025-01-12 20:56:55 -06:00
v3-distributed-admin-custom-partitions Influxdb3 restructure (#5744) 2025-01-10 15:58:05 -07: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

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: