Skip to content

Commit 56c173e

Browse files
authored
chore(instruction): content/shared instructions: (#6493)
* chore(instruction): content/shared instructions: * Apply suggestion from @jstirnaman
1 parent e3bfd39 commit 56c173e

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

content/shared/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
# Shared content
22

33
This section is for content shared across multiple products and versions.
4-
The `/shared/_index.md` frontmatter, marks the `/shared` directory and its
5-
children as draft so they
6-
don't get rendered when the site is built, but the contents of each shared
7-
documented is included in pages that use the file as a `source` in their
8-
frontmatter.
4+
The `/shared/_index.md` frontmatter marks the `/shared` directory (`/content/shared`) and its
5+
children as draft so they don't get rendered independently when the site is built.
6+
The content of each shared document is included and rendered in pages that reference the
7+
file as a `source` in their frontmatter.
98

109
## Use shared content
1110

12-
1. Create a new folder for the content in the `content/shared/` directory.
11+
1. Create a new folder for the content in the `/content/shared/` directory.
1312
2. Copy the markdown files into the new folder.
14-
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.
13+
3. 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.
1514
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:
1615

1716
```markdown
1817
source: /shared/influxql-v3-reference/regular-expressions.md
1918
```
2019

21-
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:
20+
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/influxdb3/core/reference/influxql/regular-expressions.md`, add the following:
2221

2322
<!--
24-
The content of this page is at /content/shared/influxql-v3-reference/regular-expressions.md
23+
//SOURCE - /content/shared/influxql-v3-reference/regular-expressions.md
2524
-->
25+
26+
`//SOURCE` is a comment anchor (recognized by the Comment Anchors editor extension)
27+
to make the file path clickable.

0 commit comments

Comments
 (0)