56c173ec33
* chore(instruction): content/shared instructions: * Apply suggestion from @jstirnaman |
||
|---|---|---|
| .. | ||
| influxctl | ||
| influxdb-client-libraries-reference | ||
| influxdb-v2 | ||
| influxdb3 | ||
| influxdb3-admin | ||
| influxdb3-api-reference | ||
| influxdb3-cli | ||
| influxdb3-get-started | ||
| influxdb3-internals | ||
| influxdb3-internals-reference | ||
| influxdb3-plugins | ||
| influxdb3-query-guides | ||
| influxdb3-reference | ||
| influxdb3-sample-data | ||
| influxdb3-visualize | ||
| influxdb3-write-guides | ||
| influxql-v3-reference | ||
| sql-reference | ||
| v3-core-enterprise-release-notes | ||
| v3-distributed-admin-custom-partitions | ||
| v3-distributed-internals-reference | ||
| v3-process-data/visualize | ||
| README.md | ||
| _index.md | ||
| v3-line-protocol.md | ||
README.md
Shared content
This section is for content shared across multiple products and versions.
The /shared/_index.md frontmatter marks the /shared directory (/content/shared) and its
children as draft so they don't get rendered independently when the site is built.
The content of each shared document is included and rendered in pages that reference the
file as a source in their frontmatter.
Use shared content
-
Create a new folder for the content in the
/content/shared/directory. -
Copy the markdown files into the new folder.
-
Remove any 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.
-
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 -
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/influxdb3/core/reference/influxql/regular-expressions.md, add the following:
//SOURCE is a comment anchor (recognized by the Comment Anchors editor extension)
to make the file path clickable.