docs-v2/content/shared
Peter Barnett 007a5f9d7d chore: undoing some other items 2025-01-13 14:02:29 -05:00
..
influxdb3-cli InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
influxql-v3-reference InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
sql-reference Consolidate SQL reference docs (#5712) 2024-12-16 13:08:14 -07:00
v3-core-get-started chore: Removing circular links and removing duplicate title 2025-01-13 14:00:13 -05:00
v3-distributed-admin-custom-partitions InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
v3-enterprise-get-started chore: undoing some other items 2025-01-13 14:02:29 -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 InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07: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: