Jts/api uplift

.ci/vale/styles/InfluxDB3-Core/Branding.yml

@@ -0,0 +1,11 @@
+extends: substitution
+message: Did you mean '%s' instead of '%s'
+level: warning
+ignorecase: false 
+# swap maps tokens in form of bad: good
+  # NOTE: The left-hand (bad) side can match the right-hand (good) side;
+  # Vale ignores alerts that match the intended form.
+swap:
+  'cloud-serverless|cloud-dedicated|clustered': core
+  'Cloud Serverless|Cloud Dedicated|Clustered': Core
+  'API token': database token

.ci/vale/styles/InfluxDB3-Core/v3Schema.yml

@@ -0,0 +1,10 @@
+extends: substitution
+message: Did you mean '%s' instead of '%s'
+level: warning
+ignorecase: false 
+# swap maps tokens in form of bad: good
+  # NOTE: The left-hand (bad) side can match the right-hand (good) side;
+  # Vale ignores alerts that match the intended form.
+swap:
+  '(?i)bucket': database
+  '(?i)measurement': table

.circleci/config.yml

@@ -25,10 +25,10 @@ jobs:
           command: yarn install
       - run:
           name: Install API documentation dependencies
-          command: cd api-docs && yarn install
+          command: cd api-build-scripts && yarn install
       - run:
           name: Generate API documentation
-          command: cd api-docs && bash generate-api-docs.sh      
+          command: cd api-build-scripts && bash generate-api-docs.sh      
       - run:
           name: Inject Flux stdlib frontmatter
           command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.js

.frontmatter-schema.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Title of the page"
+    },
+    "description": {
+      "type": "string",
+      "description": "Page description that supports multi-line text"
+    },
+    "menu": {
+      "type": "object",
+      "properties": {
+        "influxdb3_core": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Menu item name"
+            }
+          },
+          "required": ["name"]
+        }
+      }
+    },
+    "weight": {
+      "type": "integer",
+      "description": "Order weight for menu items",
+      "minimum": 0
+    },
+    "source": {
+      "type": "string",
+      "description": "Path to source content file",
+      "pattern": "^/shared/.+\\.md$"
+    }
+  },
+  "required": ["title", "description", "menu", "weight"]
+}

.gitignore

@@ -9,7 +9,9 @@ node_modules
 /resources
 .hugo_build.lock
 /content/influxdb/*/api/**/*.html
-/api-docs/redoc-static.html*
+/build-scripts/api-reference/redoc-static.html*
+/data/api*
+/content/influxdb/*/api/**
 .vscode/*
 .idea
 **/config.toml

.husky/_/build

@@ -48,6 +48,9 @@ call_lefthook()
     elif command -v mint >/dev/null 2>&1
     then
       mint run csjones/lefthook-plugin "$@"
+    elif command -v npx >/dev/null 2>&1
+    then
+      npx lefthook "$@"
     else
       echo "Can't find lefthook in PATH"
     fi

.husky/_/pre-commit

@@ -48,6 +48,9 @@ call_lefthook()
     elif command -v mint >/dev/null 2>&1
     then
       mint run csjones/lefthook-plugin "$@"
+    elif command -v npx >/dev/null 2>&1
+    then
+      npx lefthook "$@"
     else
       echo "Can't find lefthook in PATH"
     fi

.husky/_/pre-push

@@ -48,6 +48,9 @@ call_lefthook()
     elif command -v mint >/dev/null 2>&1
     then
       mint run csjones/lefthook-plugin "$@"
+    elif command -v npx >/dev/null 2>&1
+    then
+      npx lefthook "$@"
     else
       echo "Can't find lefthook in PATH"
     fi

.husky/_/prepare-commit-msg

@@ -48,6 +48,9 @@ call_lefthook()
     elif command -v mint >/dev/null 2>&1
     then
       mint run csjones/lefthook-plugin "$@"
+    elif command -v npx >/dev/null 2>&1
+    then
+      npx lefthook "$@"
     else
       echo "Can't find lefthook in PATH"
     fi

.vscode/settings.json

@@ -1,4 +1,17 @@
 {
-    "vale.valeCLI.config": " \"${workspaceFolder}/.vale.ini\"",
+    "commentAnchors.tags.anchors": 
+      { "SOURCE": {
+        "scope": "file",
+        "behavior": "link",
+        "iconColor": "#FF0000",
+        "highlightColor": "#FF0000",
+        "style": "bold"
+      }},
+    "commentAnchors.workspace.matchFiles": "**/*.{md,ini,json,yaml,yml}",
+    "commentAnchors.workspace.enabled": true,
+    "yaml.schemas": {
+        "./.frontmatter-schema.json": "${workspaceFolder}/content/**/*.md"
+    },
+    "vale.valeCLI.config": "${workspaceFolder}/.vale.ini",
     "vale.valeCLI.minAlertLevel": "warning",
 }

CONTRIBUTING.md

@@ -46,9 +46,10 @@ To install dependencies listed in package.json:
 4. Install the Yarn package manager and run `yarn` to install project dependencies.
 
 `package.json` contains dependencies for linting and running Git hooks.
+docs-v2 uses [Lefthook](https://github.com/evilmartians/lefthook) to configure and manage pre-commit hooks for linting and testing Markdown content.
+
+Other dependencies used in the project:
 
-- **[husky](https://github.com/typicode/husky)**: manages Git hooks, including the pre-commit hook for linting and testing
-- **[lint-staged](https://github.com/lint-staged/lint-staged)**: passes staged files to commands
 - **[prettier](https://prettier.io/docs/en/)**: formats code, including Markdown, according to style rules for consistency
 
 ### Install Docker
@@ -65,13 +66,24 @@ The tests defined in `compose.yaml` use the dependencies and execution
 environment from this image.
 
 ```bash
-docker build -t influxdata:docs-pytest -f Dockerfile.pytest .
+docker build -t influxdata/docs-pytest:latest -f Dockerfile.pytest .
 ```
 
 ### Run the documentation locally (optional)
 
 To run the documentation locally, follow the instructions provided in the README.
 
+### Install Visual Studio Code extensions
+
+If you use Microsoft Visual Studio (VS) Code, you can install extensions
+to help you navigate, check, and edit files.
+
+docs-v2 contains a `./.vscode/settings.json` that configures the following extensions:
+
+- Comment Anchors: recognizes tags (for example, `//SOURCE`) and makes links and filepaths clickable in comments.
+- Vale: shows linter errors and suggestions in the editor.
+- YAML Schemas: validates frontmatter attributes.
+
 ### Make your changes
 
 Make your suggested changes being sure to follow the [style and formatting guidelines](#style--formatting) outline below.
@@ -80,27 +92,25 @@ Make your suggested changes being sure to follow the [style and formatting guide
 
 ### Automatic pre-commit checks
 
-docs-v2 uses Husky to manage Git hook scripts.
-When you try to commit your changes (for example, `git commit`), Git runs
-scripts configured in `.husky/pre-commit`, including linting and tests for your **staged** files.
+docs-v2 uses Lefthook to manage Git hooks, such as pre-commit hooks that lint Markdown and test code blocks.
+When you try to commit changes (`git commit`), Git runs
+the commands configured in `lefthook.yml` which pass your **staged** files to Vale, Prettier, and Pytest (in a Docker container).
 
 ### Skip pre-commit hooks
 
 **We strongly recommend running linting and tests**, but you can skip them
 (and avoid installing dependencies)
-by including the `HUSKY=0` environment variable or the `--no-verify` flag with
+by including the `LEFTHOOK=0` environment variable or the `--no-verify` flag with
 your commit--for example:
 
 ```sh
 git commit -m "<COMMIT_MESSAGE>" --no-verify
 ```
 
 ```sh
-HUSKY=0 git commit
+LEFTHOOK=0 git commit
 ```
 
-For more options, see the [Husky documentation](https://typicode.github.io/husky/how-to.html#skipping-git-hooks).
-
 ### Set up test scripts and credentials
 
 To set up your docs-v2 instance to run tests locally, do the following:
@@ -331,7 +341,7 @@ Push your changes up to your forked repository, then [create a new pull request]
 
 Most docs-v2 documentation content uses [Markdown](https://en.wikipedia.org/wiki/Markdown).
 
-_Some parts of the documentation, such as `./api-docs`, contain Markdown within YAML and rely on additional tooling._
+_Some parts of the documentation, such as `./api-build-scripts`, contain Markdown within YAML and rely on additional tooling._
 
 ### Semantic line feeds
 
@@ -1752,7 +1762,7 @@ _This example assumes v2.0 is the most recent version and v2.1 is the new versio
    ```
 
 7. Copy the InfluxDB `swagger.yml` specific to the new version into the
-   `/api-docs/v<version-number>/` directory.
+   `/api-build-scripts/v<version-number>/` directory.
 
 8. Commit the changes and push the new branch to GitHub.
 
@@ -1767,4 +1777,4 @@ InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full
 InfluxDB API documentation when documentation is deployed.
 Redoc generates HTML documentation using the InfluxDB `swagger.yml`.
 For more information about generating InfluxDB API documentation, see the
-[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-docs#readme).
+[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-build-scripts#readme).

Dockerfile.pytest

@@ -32,7 +32,13 @@ RUN apt-get update && apt-get upgrade -y && apt-get install -y \
   python3-venv \
   rsync \
   telegraf \
-  wget
+  wget \
+  yq
+
+# Install InfluxDB 3 Core
+RUN curl -O https://www.influxdata.com/d/install_influxdb3.sh \
+&& chmod +x install_influxdb3.sh \
+&& bash -c yes | ./install_influxdb3.sh
 
 RUN ln -s /usr/bin/python3 /usr/bin/python
 

README.md

@@ -40,7 +40,7 @@ including our GPG key, can be found at https://www.influxdata.com/how-to-report-
 
        _**Note:** The most recent version of Hugo tested with this documentation is **0.123.8**._
 
-3. To generate the API docs, see [api-docs/README.md](api-docs/README.md).
+3. To generate the API docs, see [api-build-scripts/README.md](api-build-scripts/README.md).
 
 4.  **Start the Hugo server**
 

ai/gpt/instructions/doc.md

@@ -0,0 +1,46 @@
+Doc writes technical software documentation for InfluxData. The public web site is https://docs.influxdata.com and the source repository is https://github.com/influxdata/docs-v2.
+Documentation provides step-by-step guides and reference documentation for InfluxDB and associated clients (CLIs, client libraries (SDKs), and Telegraf (https://docs.influxdata.com/telegraf/v1/)), and the legacy v1 components Kapacitor and Chronograf.
+
+When a user asks a question and doesn't include a product from the list below, ask them which product in the list they are using, along with the version and query language:
+
+InfluxDB OSS 1.x (v1)
+  - Documentation: https://docs.influxdata.com/influxdb/v1/
+  - Query languages: v1.8+ supports InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v1 client libraries
+InfluxDB Enterprise (v1)
+  - Documentation: https://docs.influxdata.com/enterprise_influxdb/v1/
+  - Query languages: v1.8+ supports InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v1 client libraries
+InfluxDB OSS 2.x (v2)
+  - Documentation: https://docs.influxdata.com/influxdb/v2/
+  - Query languages: InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v2 client libraries
+InfluxDB Cloud (v2, multi-tenant)
+  - Documentation: https://docs.influxdata.com/influxdb/cloud/
+  - Query languages: InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v2 client libraries
+InfluxDB Clustered (v3, 3.0, self-managed distributed)
+  - Documentation: https://docs.influxdata.com/influxdb/clustered/
+  - Query languages: SQL and InfluxQL
+  - Clients: Telegraf, influxctl CLI, v3 client libraries
+InfluxDB Cloud Dedicated (3.0, v3, InfluxData-managed single tenant)
+  - Documentation: https://docs.influxdata.com/influxdb/cloud-dedicated/
+  - Query languages: SQL and InfluxQL
+  - Clients: Telegraf, influxctl CLI, v3 client libraries
+InfluxDB Cloud Serverless (v3, 3.0, InfluxData-managed multi-tenant)
+  - Documentation: https://docs.influxdata.com/influxdb/clustered/
+  - Query languages: SQL and InfluxQL
+  - Clients: Telegraf, influx CLI, v3 client libraries
+
+If I ask about a REST API or SDK (client library) and don't specify a product, ask which product.
+For API client libraries, refer to the documentation and to the source repositories in https://github.com/InfluxCommunity for the version-specific client library.
+
+When writing documentation, always use Google Developer Documentation style guidelines and Markdown format. 
+If writing REST API reference documentation follow YouTube Data API style and Google Developer Documentation style guidelines.
+
+The project uses the Hugo static site generator to build the documentation.
+The site uses JavaScript and jQuery.
+For information about linting, tests (using pytests for codeblocks), shortcode <shortcode_name>, refer to https://github.com/influxdata/docs-v2/blob/master/README.md and https://github.com/influxdata/docs-v2/blob/master/CONTRIBUTING.md.
+If something in CONTRIBUTING.md needs clarification, then give me the suggested revision for CONTRIBUTING.md in Markdown.
+
+The community forum is https://community.influxdata.com/ and should not be used as a primary source of information, but might contain useful suggestions or solutions to specific problems from users.

ai/workflows/ask-product.md

@@ -0,0 +1,30 @@
+When a user asks a question and doesn't include a product from the list below, ask them which product in the list they are using, along with the version and query language:
+
+InfluxDB OSS 1.x (v1)
+  - Documentation: https://docs.influxdata.com/influxdb/v1/
+  - Query languages: v1.8+ supports InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v1 client libraries
+InfluxDB Enterprise (v1)
+  - Documentation: https://docs.influxdata.com/enterprise_influxdb/v1/
+  - Query languages: v1.8+ supports InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v1 client libraries
+InfluxDB OSS 2.x (v2)
+  - Documentation: https://docs.influxdata.com/influxdb/v2/
+  - Query languages: InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v2 client libraries
+InfluxDB Cloud (v2, multi-tenant)
+  - Documentation: https://docs.influxdata.com/influxdb/cloud/
+  - Query languages: InfluxQL and Flux
+  - Clients: Telegraf, influx CLI, v2 client libraries
+InfluxDB Clustered (v3, 3.0, self-managed distributed)
+  - Documentation: https://docs.influxdata.com/influxdb/clustered/
+  - Query languages: SQL and InfluxQL
+  - Clients: Telegraf, influxctl CLI, v3 client libraries
+InfluxDB Cloud Dedicated (3.0, v3, InfluxData-managed single tenant)
+  - Documentation: https://docs.influxdata.com/influxdb/cloud-dedicated/
+  - Query languages: SQL and InfluxQL
+  - Clients: Telegraf, influxctl CLI, v3 client libraries
+InfluxDB Cloud Serverless (v3, 3.0, InfluxData-managed multi-tenant)
+  - Documentation: https://docs.influxdata.com/influxdb/clustered/
+  - Query languages: SQL and InfluxQL
+  - Clients: Telegraf, influx CLI, v3 client libraries

api-build-scripts/.spectral.yaml

@@ -0,0 +1 @@
+extends: ["spectral:oas", "spectral:asyncapi", "spectral:arazzo"]