d242c25e1c
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> |
||
|---|---|---|
| .. | ||
| influxdb3-cli | ||
| influxql-v3-reference | ||
| sql-reference | ||
| v3-core-get-started | ||
| v3-distributed-admin-custom-partitions | ||
| v3-enterprise-get-started | ||
| 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 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
-
Create a new folder for the content in the
content/shared/directory. -
Copy the markdown files into the new folder.
-
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.
-
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/3/core/reference/influxql/regular-expressions.md, add the following: