docs-v2/content/shared
meelahme 9b76d8b5d2 docs: improve structure and clarity of in-memory cache and logging guidance 2025-05-09 13:42:31 -07:00
..
influxctl Release influxctl v2.10.0 (#5959) 2025-04-04 11:57:06 -06:00
influxdb-client-libraries-reference chore(monolith): Core and Enterprise: Add client library references, revise recommendations 2025-04-09 19:53:48 -05:00
influxdb-v2 chore(vsflux): Remove Flux VSCode pages, add notice that vsflux is removed from Marketplace extensions, and vsflux and flux-lsp are archived 2025-04-17 13:58:33 -05:00
influxdb3-admin Apply suggestions from code review 2025-04-28 10:29:16 -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 chore(influxdb3): Tokens: Guides and references for list and create admin and resource tokens. 2025-04-28 00:16:53 -05:00
influxdb3-internals-reference hotfix(3-ent): Closes #6042 - Restore auth content 2025-05-06 12:09:29 -05:00
influxdb3-query-guides suggestion fixes 2025-03-20 10:05:51 -05:00
influxdb3-reference chore(influxdb3): Reconcile shared glossary page with Serverless 2025-04-15 15:16:35 -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 fix(influxdb3): unresolved product-name shortcode in frontmatter title, broken links to non-existent Core and Enterprise compatibility guides, alias api/v1 and api/v2 paths as api/v3. 2025-05-01 11:17:10 -05:00
influxql-v3-reference
sql-reference Updates SQL reference (#5886) 2025-03-12 09:21:42 -06:00
v3-core-enterprise-release-notes Update content/shared/v3-core-enterprise-release-notes/_index.md 2025-05-06 13:55:19 -05:00
v3-core-get-started fix(influxdb3): system tokens for endpoints, not databases (Closes #6021) 2025-04-27 23:58:04 -05:00
v3-core-plugins Update content/shared/v3-core-plugins/_index.md 2025-05-09 12:47:45 -07:00
v3-distributed-admin-custom-partitions Apply suggestions from code review 2025-05-09 10:22:47 -05:00
v3-enterprise-get-started Remove "rw" name for system token 2025-04-28 10:48:01 -07:00
README.md
_index.md
extended-plugin-api.md docs: improve structure and clarity of in-memory cache and logging guidance 2025-05-09 13:42:31 -07:00
influxdb3-processing-engine.md Update content/shared/influxdb3-processing-engine.md 2025-04-23 17:00:04 -07: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: