Skip to content

Commit 8065516

Browse files
committed
Merge branch 'master' of github.com:influxdata/docs-v2 into docs/v3/processing-engine
2 parents 50c7116 + ce04b19 commit 8065516

File tree

1,258 files changed

+47361
-45334
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,258 files changed

+47361
-45334
lines changed

.github/copilot-instructions.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,33 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
88

99
- **Product version data**: `/data/products.yml`
1010
- **Products**:
11-
- InfluxDB OSS 1.x
12-
- Documentation source path: `/content/influxdb/v1`
13-
- Code repository: https://github.com/influxdata/influxdb
14-
- InfluxDB OSS 2.x
15-
- Documentation source path: `/content/influxdb/v2`
16-
- Code repository: https://github.com/influxdata/influxdb
1711
- InfluxDB 3 Core
1812
- Documentation source path: `/content/influxdb3/core`
1913
- Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_core
20-
- InfluxDB Enterprise v1 (1.x)
21-
- Documentation source path: `/content/influxdb/enterprise_influxdb`
22-
- Code repository: https://github.com/influxdata/influxdb
23-
- InfluxDB Cloud v2 (TSM)
24-
- Documentation source path: `/content/influxdb/cloud`
25-
- Code repository: https://github.com/influxdata/idpe
26-
- InfluxDB 3 Cloud Dedicated
14+
- InfluxDB 3 Enterprise
15+
- Documentation source path: `/content/influxdb3/enterprise`
16+
- Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_enterprise
17+
- InfluxDB Cloud Dedicated
2718
- Documentation source path: `/content/influxdb3/cloud-dedicated`
2819
- Code repository: https://github.com/influxdata/influxdb
29-
- InfluxDB 3 Cloud Serverless
20+
- InfluxDB Cloud Serverless
3021
- Documentation source path: `/content/influxdb3/cloud-serverless`
3122
- Code repository: https://github.com/influxdata/idpe
32-
- InfluxDB 3 Clustered
23+
- InfluxDB Cloud v2 (TSM)
24+
- Documentation source path: `/content/influxdb/cloud`
25+
- Code repository: https://github.com/influxdata/idpe
26+
- InfluxDB Clustered
3327
- Documentation source path: `/content/influxdb3/clustered`
3428
- Code repository: https://github.com/influxdata/influxdb
29+
- InfluxDB Enterprise v1 (1.x)
30+
- Documentation source path: `/content/influxdb/enterprise_influxdb`
31+
- Code repository: https://github.com/influxdata/influxdb
32+
- InfluxDB OSS 1.x
33+
- Documentation source path: `/content/influxdb/v1`
34+
- Code repository: https://github.com/influxdata/influxdb
35+
- InfluxDB OSS 2.x
36+
- Documentation source path: `/content/influxdb/v2`
37+
- Code repository: https://github.com/influxdata/influxdb
3538
- Telegraf
3639
- Documentation source path: `/content/telegraf/v1`
3740
- Code repository: https://github.com/influxdata/telegraf

CONTRIBUTING.md

Lines changed: 73 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,7 @@ append: # Append markdown content to an article (especially powerful with cascad
367367
content: # Content to append to article
368368
metadata: [] # List of metadata messages to include under the page h1
369369
updated_in: # Product and version the referenced feature was updated in (displayed as a unique metadata)
370+
source: # Specify a file to pull page content from (typically in /content/shared/)
370371
```
371372

372373
### Title usage
@@ -454,27 +455,22 @@ v2: /influxdb/v2.0/get-started/
454455
Use the `prepend` and `append` frontmatter to add content to the top or bottom of a page.
455456
Each has the following fields:
456457

457-
- **block:** _(Optional)_ block style to wrap content in (note, warn, cloud, or enterprise)
458-
- **content:** _**(Required)**_ markdown content to add.
459-
460458
```yaml
461-
append:
462-
block: note
463-
content: |
464-
#### This is example markdown content
465-
This is just an example note block that gets appended to the article.
459+
append: |
460+
> [!Note]
461+
> #### This is example markdown content
462+
> This is just an example note block that gets appended to the article.
466463
```
467464

468465
Use this frontmatter with [cascade](#cascade) to add the same content to
469466
all children pages as well.
470467

471468
```yaml
472469
cascade:
473-
append:
474-
block: note
475-
content: |
476-
#### This is example markdown content
477-
This is just an example note block that gets appended to the article.
470+
append: |
471+
> [!Note]
472+
> #### This is example markdown content
473+
> This is just an example note block that gets appended to the article.
478474
```
479475

480476
### Cascade
@@ -494,6 +490,15 @@ cascade:
494490
those frontmatter keys. Frontmatter defined on the page overrides frontmatter
495491
"cascaded" from a parent.
496492

493+
## Use shared content in a page
494+
495+
Use the `source` frontmatter to specify a shared file to use to populate the
496+
page content. Shared files are typically stored in the `/content/shared` directory.
497+
498+
When building shared content, use the `show-in` and `hide-in` shortcodes to show
499+
or hide blocks of content based on the current InfluxDB product/version.
500+
For more information, see [show-in](#show-in) and [hide-in](#hide-in).
501+
497502
## Shortcodes
498503

499504
### Notes and warnings
@@ -529,16 +534,6 @@ Display the short version name (part of the key used in `products.yml`) from the
529534
{{% product-key %}}
530535
```
531536

532-
### Enterprise Content
533-
534-
For sections content that relate specifically to InfluxDB Enterprise, use the `{{% enterprise %}}` shortcode.
535-
536-
```md
537-
{{% enterprise %}}
538-
Insert enterprise-specific markdown content here.
539-
{{% /enterprise %}}
540-
```
541-
542537
#### Enterprise name
543538

544539
The name used to refer to InfluxData's enterprise offering is subject to change.
@@ -565,76 +560,6 @@ InfluxDB Enterprise.
565560
Find more info [here][{{< enterprise-link >}}]
566561
```
567562

568-
### InfluxDB Cloud Content
569-
570-
For sections of content that relate specifically to InfluxDB Cloud, use the `{{% cloud %}}` shortcode.
571-
572-
```md
573-
{{% cloud %}}
574-
Insert cloud-specific markdown content here.
575-
{{% /cloud %}}
576-
```
577-
578-
#### InfluxDB Cloud name
579-
580-
The name used to refer to InfluxData's cloud offering is subject to change.
581-
To facilitate easy updates in the future, use the `cloud-name` short-code when
582-
referencing the cloud product.
583-
This shortcode accepts a `"short"` parameter which uses the "short-name".
584-
585-
```
586-
This is content that references {{< cloud-name >}}.
587-
This is content that references {{< cloud-name "short" >}}.
588-
```
589-
590-
Product names are stored in `data/products.yml`.
591-
592-
#### InfluxDB Cloud link
593-
594-
References to InfluxDB Cloud are often accompanied with a link to a page where
595-
visitors can get more information.
596-
This link is subject to change.
597-
Use the `cloud-link` shortcode when including links to more information about
598-
InfluxDB Cloud.
599-
600-
```
601-
Find more info [here][{{< cloud-link >}}]
602-
```
603-
604-
### Latest links
605-
606-
Each of the InfluxData projects have different "latest" versions.
607-
Use the `{{< latest >}}` shortcode to populate link paths with the latest version
608-
for the specified project.
609-
610-
```md
611-
[Link to latest Telegraf](/{{< latest "telegraf" >}}/path/to/doc/)
612-
```
613-
614-
To constrain the latest link to a major version, include a second argument with
615-
the major version:
616-
617-
```md
618-
[Link to latest InfluxDB 1.x](/{{< latest "influxdb" "v1" >}}/path/to/doc/)]
619-
```
620-
621-
`{{< latest "telegraf" >}}` is replaced with `telegraf/v1.15` (or whatever the latest version is).
622-
`{{< latest "influxdb" "v1" >}}` is replaced with `influxdb/v1.8` (or whatever the latest v1.x version is).
623-
624-
Use the following for project names:
625-
626-
- influxdb
627-
- telegraf
628-
- chronograf
629-
- kapacitor
630-
- enterprise_influxdb
631-
632-
**Note**: Include a leading slash before the latest shortcode and a trailing slash after in all link paths:
633-
634-
```md
635-
/{{< latest "telegraf" >}}/
636-
```
637-
638563
### Latest patch version
639564

640565
Use the `{{< latest-patch >}}` shortcode to add the latest patch version of a product.
@@ -1501,7 +1426,53 @@ This is necessary to get the first sentence/paragraph to render correctly.
15011426
{{% /cloud-only %}}
15021427
```
15031428

1504-
#### All-Caps
1429+
### Show or hide content blocks in shared content
1430+
1431+
The `source` frontmatter lets you source page content from another file and is
1432+
used to share content across InfluxDB products. Within the shared content, you
1433+
can use the `show-in` and `hide-in` shortcodes to conditionally show or hide
1434+
content blocks based on the InfluxDB "version." Valid "versions" include:
1435+
1436+
- v2
1437+
- cloud
1438+
- cloud-serverless
1439+
- cloud-dedicated
1440+
- clustered
1441+
- core
1442+
- enterprise
1443+
1444+
#### show-in
1445+
1446+
The `show-in` shortcode accepts a comma-delimited string of InfluxDB "versions"
1447+
to show the content block in. The version is the second level of the page
1448+
path--for example: `/influxdb/<version>/...`.
1449+
1450+
```md
1451+
{{% show-in "core,enterprise" %}}
1452+
1453+
This content will appear in pages in the InfluxDB 3 Core and InfluxDB 3 Enterprise
1454+
documentation, but not any other InfluxDB documentation this content is shared in.
1455+
1456+
{{% /show-in %}}
1457+
```
1458+
1459+
#### hide-in
1460+
1461+
The `hide-in` shortcode accepts a comma-delimited string of InfluxDB "versions"
1462+
to hide the content block in. The version is the second level of the page
1463+
path--for example: `/influxdb/<version>/...`.
1464+
1465+
```md
1466+
{{% hide-in "core,enterprise" %}}
1467+
1468+
This content will not appear in pages in the InfluxDB 3 Core and InfluxDB 3
1469+
Enterprise documentation, but will in all other InfluxDB documentation this
1470+
content is shared in.
1471+
1472+
{{% /hide-in %}}
1473+
```
1474+
1475+
### All-Caps
15051476

15061477
Clockface v3 introduces many buttons with text formatted as all-caps.
15071478
Use the `{{< caps >}}` shortcode to format text to match those buttons.
@@ -1510,7 +1481,7 @@ Use the `{{< caps >}}` shortcode to format text to match those buttons.
15101481
Click {{< caps >}}Add Data{{< /caps >}}
15111482
```
15121483

1513-
#### Code callouts
1484+
### Code callouts
15141485

15151486
Use the `{{< code-callout >}}` shortcode to highlight and emphasize a specific
15161487
piece of code (for example, a variable, placeholder, or value) in a code block.
@@ -1527,7 +1498,7 @@ http://localhost:8086/orgs/03a2bbf46249a000/...
15271498
{{< /code-callout >}}
15281499
````
15291500

1530-
#### InfluxDB University banners
1501+
### InfluxDB University banners
15311502

15321503
Use the `{{< influxdbu >}}` shortcode to add an InfluxDB University banner that
15331504
points to the InfluxDB University site or a specific course.
@@ -1546,15 +1517,15 @@ the content of the banner.
15461517
the course" link="https://university.influxdata.com/" >}}
15471518
```
15481519

1549-
##### Course templates
1520+
#### Course templates
15501521

15511522
Use one of the following course templates:
15521523

15531524
- influxdb-101
15541525
- telegraf-102
15551526
- flux-103
15561527

1557-
##### Custom banner content
1528+
#### Custom banner content
15581529

15591530
Use the following shortcode parameters to customize the content of the InfluxDB
15601531
University banner:
@@ -1650,81 +1621,18 @@ Supported argument values:
16501621

16511622
- oss
16521623
- cloud
1653-
- cloud-tsm
16541624
- cloud-serverless
1655-
- serverless
16561625
- cloud-dedicated
1657-
- dedicated
16581626
- clustered
1627+
- core
1628+
- enterprise
16591629

16601630
```
1661-
{{< host/influxdb >}}
1631+
{{< influxdb/host >}}
16621632

1663-
{{< host/influxdb "serverless" >}}
1633+
{{< influxdb/host "serverless" >}}
16641634
```
16651635

1666-
## New Versions of InfluxDB
1667-
1668-
Version bumps occur regularly in the documentation.
1669-
Each minor version has its own directory with unique content.
1670-
Patch versions within a minor version are updated in place.
1671-
1672-
To add a new minor version, go through the steps below.
1673-
_This example assumes v2.0 is the most recent version and v2.1 is the new version._
1674-
1675-
1. Ensure your `master` branch is up to date:
1676-
1677-
```sh
1678-
git checkout master
1679-
git pull
1680-
```
1681-
1682-
2. Create a new branch for the new minor version:
1683-
1684-
```sh
1685-
git checkout -b influxdb-2.1
1686-
```
1687-
1688-
3. Duplicate the most recent version's content directory:
1689-
1690-
```sh
1691-
# From the root of the project
1692-
cp content/influxdb/v2.0 content/influxdb/v2.1
1693-
```
1694-
1695-
4. Find and replace all instances of the old version number with the new version
1696-
**(only within the new version directory)**.
1697-
Be sure to find and replace both the following forms of the version number:
1698-
1699-
```
1700-
v2.0 -> v2.1
1701-
v2_0 -> v2_1
1702-
```
1703-
1704-
5. Add the new product and version tag taxonomy to the `config.toml` in the root of the project.
1705-
1706-
```toml
1707-
[taxonomies]
1708-
"influxdb/v2.0/tag" = "influxdb/v2.0/tags"
1709-
"influxdb/v2.1/tag" = "influxdb/v2.1/tags"
1710-
```
1711-
1712-
6. Update the `latest_version` in `data/products.yml`:
1713-
1714-
```yaml
1715-
latest_version: v2.1
1716-
```
1717-
1718-
7. Copy the InfluxDB `swagger.yml` specific to the new version into the
1719-
`/api-docs/v<version-number>/` directory.
1720-
1721-
8. Commit the changes and push the new branch to GitHub.
1722-
1723-
These changes lay the foundation for the new version.
1724-
All other changes specific to the new version should be merged into this branch.
1725-
Once the necessary changes are in place and the new version is released,
1726-
merge the new branch into `master`.
1727-
17281636
## InfluxDB API documentation
17291637

17301638
InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full

content/influxdb/cloud/admin/buckets/delete-bucket.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ menu:
99
weight: 203
1010
aliases:
1111
- /influxdb/cloud/organizations/buckets/delete-bucket/
12+
source: /shared/influxdb-v2/admin/buckets/delete-bucket.md
1213
---
1314

14-
{{< duplicate-oss >}}
15+
<!-- The content of this file is at
16+
// SOURCE content/shared/influxdb-v2/admin/buckets/delete-bucket.md-->

content/influxdb/cloud/admin/tokens/create-token.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ alt_links:
1313
cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/create-token
1414
cloud-dedicated: /influxdb3/cloud-dedicated/admin/tokens/database/create
1515
clustered: /influxdb3/clustered/admin/tokens/database/create
16+
source: /shared/influxdb-v2/admin/tokens/create-token.md
1617
---
1718

18-
{{< duplicate-oss >}}
19+
<!-- The content of this file is at
20+
// SOURCE content/shared/influxdb-v2/admin/tokens/create-token.md-->

0 commit comments

Comments
 (0)