Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/shared/influxdb3-get-started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ influxdb3 serve \
{{% /expand %}}
{{% expand "Docker with a mounted file system object store" %}}

To run the [Docker image](/influxdb3/version/install/#docker-image) and persist
To run the [Docker image](/influxdb3/version/install/#pull-the-docker-image) and persist
data to the local file system, mount a volume for the object store--for example,
provide the following options with your `docker run` command:

Expand Down
4 changes: 2 additions & 2 deletions content/shared/influxdb3-plugins/extended-plugin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The plugin API lets you:
- [Write data](#write-data)
- [Query data](#query-data)
- [Log messages for monitoring and debugging](#log-messages-for-monitoring-and-debugging)
- [Maintain state with the in-memory cache](#maintain-state-with-in-memory-cache)
- [Maintain state with the in-memory cache](#maintain-state-with-the-in-memory-cache)
- [Store and retrieve cached data](#store-and-retrieve-cached-data)
- [Use TTL appropriately](#use-ttl-appropriately)
- [Share data across plugins](#share-data-across-plugins)
Expand Down Expand Up @@ -221,7 +221,7 @@ The cache system offers two distinct namespaces:
- [Store and retrieve cached data](#store-and-retrieve-cached-data)
- [Store cached data with expiration](#store-cached-data-with-expiration)
- [Share data across plugins](#share-data-across-plugins)
- [Build a counter](#build-a-counter)
- [Build a counter](#building-a-counter)

### Store and retrieve cached data

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generated Content - Do Not Edit Directly

The plugin documentation files in this directory are **generated from source READMEs** in the [influxdata/influxdb3_plugins](https://github.com/influxdata/influxdb3_plugins) repository.

Check warning on line 3 in content/shared/influxdb3-plugins/plugins-library/official/CLAUDE.md

View workflow job for this annotation

GitHub Actions / Vale style check

InfluxDataDocs.Spelling

Did you really mean 'influxdata'?

## Workflow

Expand All @@ -14,6 +14,23 @@
2. Run `yarn sync-plugins` from the docs-v2 root to port changes
3. Commit changes in both repositories

## Cross-Plugin Links

Upstream READMEs link to other plugins with a GitHub-relative path, for
example `[influxdata/notifier plugin](../notifier/README.md)`. That path is
valid on GitHub but doesn't resolve on the built docs site (Hugo doesn't
publish `README.md` files). `port_to_docs.js`'s `convertRelativeLinks()`
rewrites these to the sibling plugin's docs-v2 page —
`/influxdb3/version/plugins/library/official/notifier/` — converting the
upstream folder's underscore_case to the docs-v2 hyphen-case slug. This
keeps readers on the docs site instead of bouncing to GitHub.

If you see a broken `../<plugin>/README.md`-style link in one of these
files, the sync script didn't run after the upstream link was added — don't
hand-fix only the generated file; re-run `yarn sync-plugins`, and if the
link still isn't rewritten, check `convertRelativeLinks()` in
`helper-scripts/influxdb3-plugins/port_to_docs.js` for a pattern gap.

## Documentation

See [helper-scripts/influxdb3-plugins/README.md](/helper-scripts/influxdb3-plugins/README.md) for the complete sync workflow documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
## Software Requirements

- **{{% product-name %}}**: with the Processing Engine enabled.
- **Notification Sender Plugin for {{% product-name %}}**: Required for sending notifications. See the [influxdata/notifier plugin](../notifier/README.md).
- **Notification Sender Plugin for {{% product-name %}}**: Required for sending notifications. See the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/).
- **Python packages**:
- `pandas` (for data processing)
- `requests` (for HTTP notifications)
Expand All @@ -116,7 +116,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
influxdb3 install package pandas
influxdb3 install package requests
```
3. Install the [influxdata/notifier plugin](../notifier/README.md) (required)
3. Install the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/) (required)

## Trigger setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
- **{{% product-name %}}**: with the Processing Engine enabled.
- **Python packages**:
- `requests` (for notification delivery)
- **Notification Sender Plugin** *(optional)*: Required if using the `senders` parameter. See the [influxdata/notifier plugin](../notifier/README.md).
- **Notification Sender Plugin** *(optional)*: Required if using the `senders` parameter. See the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/).

### Installation steps

Expand All @@ -115,7 +115,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
```bash
influxdb3 install package requests
```
3. *(Optional)* For notifications, install the [influxdata/notifier plugin](../notifier/README.md) and create an HTTP trigger for it.
3. *(Optional)* For notifications, install the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/) and create an HTTP trigger for it.

## Schema requirement

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
- `numpy` (for numerical operations)
- `requests` (for HTTP requests)
- `prophet` (for time series forecasting)
- **Notification Sender Plugin** *(optional)*: Required if using the `senders` parameter. See the [influxdata/notifier plugin](../notifier/README.md).
- **Notification Sender Plugin** *(optional)*: Required if using the `senders` parameter. See the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/).

### Installation steps

Expand All @@ -116,7 +116,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
influxdb3 install package requests
influxdb3 install package prophet
```
3. *(Optional)* For notifications, install the [influxdata/notifier plugin](../notifier/README.md) and create an HTTP trigger for it.
3. *(Optional)* For notifications, install the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/) and create an HTTP trigger for it.

## Trigger setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For more information on using TOML configuration files, see the Using TOML Confi

### Channel-specific configuration

Notification channels require additional parameters based on the sender type (same as the [influxdata/notifier plugin](../notifier/README.md)).
Notification channels require additional parameters based on the sender type (same as the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/)).

## Schema requirement

Expand All @@ -72,7 +72,7 @@ The plugin assumes that the table schema is already defined in the database, as
## Software Requirements

- **{{% product-name %}}**: with the Processing Engine enabled.
- **Notification Sender Plugin for {{% product-name %}}**: Required for sending notifications. See the [influxdata/notifier plugin](../notifier/README.md).
- **Notification Sender Plugin for {{% product-name %}}**: Required for sending notifications. See the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/).
- **Python packages**:
- `requests` (for HTTP notifications)

Expand All @@ -92,7 +92,7 @@ The plugin assumes that the table schema is already defined in the database, as
```bash
influxdb3 install package requests
```
3. *Optional*: For notifications, install and configure the [influxdata/notifier plugin](../notifier/README.md)
3. *Optional*: For notifications, install and configure the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/)

## Trigger setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
- `adtk` (for anomaly detection)
- `pandas` (for data manipulation)
- `requests` (for HTTP notifications)
- **Notification Sender Plugin** *(optional)*: Required if using the `senders` parameter. See the [influxdata/notifier plugin](../notifier/README.md).
- **Notification Sender Plugin** *(optional)*: Required if using the `senders` parameter. See the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/).

### Installation steps

Expand All @@ -92,7 +92,7 @@ For more information on using TOML configuration files, see the Using TOML Confi
influxdb3 install package adtk
influxdb3 install package pandas
```
3. *(Optional)* For notifications, install the [influxdata/notifier plugin](../notifier/README.md) and create an HTTP trigger for it.
3. *(Optional)* For notifications, install the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/) and create an HTTP trigger for it.

## Trigger setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ For more information on using TOML configuration files, see the Using TOML Confi

### Channel-specific configuration

Notification channels require additional parameters based on the sender type (same as the [influxdata/notifier plugin](../notifier/README.md)).
Notification channels require additional parameters based on the sender type (same as the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/)).

## Schema requirement

Expand All @@ -71,7 +71,7 @@ The plugin assumes that the table schema is already defined in the database, as
## Software requirements

- **InfluxDB v3 Core/Enterprise**: with the Processing Engine enabled.
- **Notification Sender Plugin for {{% product-name %}}**: This plugin is required for sending notifications. See the [influxdata/notifier plugin](../notifier/README.md).
- **Notification Sender Plugin for {{% product-name %}}**: This plugin is required for sending notifications. See the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/).

## Installation steps

Expand All @@ -89,7 +89,7 @@ The plugin assumes that the table schema is already defined in the database, as
```bash
influxdb3 install package requests
```
3. **Optional**: For notifications, install and configure the [influxdata/notifier plugin](../notifier/README.md)
3. **Optional**: For notifications, install and configure the [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/)

## Trigger setup

Expand Down
5 changes: 4 additions & 1 deletion helper-scripts/influxdb3-plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,9 +275,12 @@ When porting content from `influxdb3_plugins` to `docs-v2`:

1. **Remove emoji metadata line** (already in plugin metadata)

2. **Convert relative links to GitHub URLs**:
2. **Convert relative links to GitHub URLs or sibling docs-v2 pages**:
- `[file.toml](file.toml)` → `[file.toml](https://github.com/influxdata/influxdb3_plugins/blob/master/influxdata/[plugin]/file.toml)`
- `/README.md` → `https://github.com/influxdata/influxdb3_plugins/blob/master/README.md`
- `../[plugin]/README.md` (a link to a *different* plugin's README) →
`/influxdb3/version/plugins/library/official/[plugin]/` (the sibling
plugin's docs-v2 page, with underscores converted to hyphens)

3. **Add product shortcodes**:
- Replace "InfluxDB 3" with `{{% product-name %}}`
Expand Down
10 changes: 10 additions & 0 deletions helper-scripts/influxdb3-plugins/port_to_docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,16 @@ function convertRelativeLinks(content, pluginName) {
const rootUrl =
'https://github.com/influxdata/influxdb3_plugins/blob/master/';

// Convert cross-plugin README links to the sibling plugin's docs-v2 page.
// e.g. [influxdata/notifier plugin](../notifier/README.md) ->
// [influxdata/notifier plugin](/influxdb3/version/plugins/library/official/notifier/)
// Upstream plugin folders use underscore_case; docs-v2 slugs use hyphens.
content = content.replace(
/\[([^\]]+)\]\(\.\.\/([a-z0-9_]+)\/README\.md\)/g,
(match, linkText, pluginDir) =>
`[${linkText}](/influxdb3/version/plugins/library/official/${pluginDir.replace(/_/g, '-')}/)`
);

// Convert relative README links (../../README.md, ../README.md, etc.)
content = content.replace(
/\[([^\]]+)\]\((\.\.\/)+README\.md\)/g,
Expand Down
Loading