Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
6818f25
feat(influxdb3): rename API specs and add download links
jstirnaman Mar 8, 2026
83fb445
Initial plan
Copilot Mar 8, 2026
e1e7e22
feat(influxdb3): rename API specs and add download links (#6906)
jstirnaman Mar 8, 2026
de07f79
fix: run API docs build in PR preview workflow for /api pages
Copilot Mar 8, 2026
87b01ab
Merge branch 'master' into copilot/fix-pr-preview-api-pages
jstirnaman Mar 9, 2026
914380e
feat(api-docs): extract api-docs changes from feat-api-uplift
jstirnaman Mar 9, 2026
b951d3c
feat(ci): add doc review pipeline with auto-labeling and Copilot revi…
jstirnaman Mar 10, 2026
b841590
chore(api-docs): remove dead x-tagGroups from all spec files
jstirnaman Mar 10, 2026
8dd60bf
chore(deps): bump dompurify from 3.3.1 to 3.3.2 (#6905)
dependabot[bot] Mar 10, 2026
ef6f124
Telegraf v1.38.0 (#6911)
srebhan Mar 10, 2026
731179f
chore: update release notes to 3.8.4 (#6915)
peterbarnett03 Mar 10, 2026
478a0ff
Harden PR preview workflow against transient deploy/comment failures …
Copilot Mar 10, 2026
507ec68
fix: resolve high-severity dependency vulnerabilities (#6916)
jstirnaman Mar 10, 2026
3952e3b
fix: use correct API to invoke Copilot code review in doc-review work…
Copilot Mar 10, 2026
8a6143d
fix(vale): propagate Google.Units=NO to product-specific Vale configs…
Copilot Mar 10, 2026
6d5f88c
chore: add hosted influxdb-docs MCP server to .mcp.json (#6914)
jstirnaman Mar 10, 2026
aa86301
feat(api-docs): add tag post-processor and per-product tags.yml configs
jstirnaman Mar 10, 2026
abc7890
refactor(api-docs): flatten version subdirectories for v2-compat and …
jstirnaman Mar 10, 2026
bf79e61
hotfix: Change date for InfluxDB Docker latest tag
sanderson Mar 10, 2026
58b706d
fix(api-docs): let docs-tooling spec values pass through for Core/Ent…
jstirnaman Mar 10, 2026
a8b879f
Merge branch 'master' into copilot/fix-pr-preview-api-pages
jstirnaman Mar 10, 2026
c7f9353
refactor(api-docs): replace tag-only processor with unified post-proc…
jstirnaman Mar 10, 2026
24c1e60
refactor(api-docs): unify v2 APIs, remove v1-compat specs, migrate mg…
jstirnaman Mar 11, 2026
160b308
Merge remote-tracking branch 'origin/master' into api-docs-uplift
jstirnaman Mar 11, 2026
c600dda
fix: upgrade glob to v13 and pin dompurify resolution (#6925)
jstirnaman Mar 11, 2026
e2f4d80
refactor(api-docs): flatten v3 dirs, rewrite build pipeline, add --st…
jstirnaman Mar 11, 2026
3f87dc5
fix(api-docs): skip clean step in --static-only mode
jstirnaman Mar 11, 2026
5774946
fix(api-docs): exclude root .config.yml from Redoc HTML generation
jstirnaman Mar 11, 2026
62bd023
fix(api-docs): add x-traitTag support to post-processor and tags.yml
jstirnaman Mar 11, 2026
54f9695
fix(api-docs): restore Redoc security scheme injection in Authenticat…
jstirnaman Mar 12, 2026
ccd8029
fix(api-docs): enforce one-tag-per-operation, fix Enterprise v1 spec
jstirnaman Mar 12, 2026
ebc91d2
fix(api-docs): split v2 Compatibility tag, fix auth descriptions and …
jstirnaman Mar 12, 2026
0a0bebc
Fix PR preview and Copilot visual review skipping docs home page when…
Copilot Mar 13, 2026
f1674d0
refactor(api-docs): write resolved specs to _build/ instead of mutati…
jstirnaman Mar 13, 2026
2c71b25
style(api-docs): format generate-openapi-articles.ts line lengths
jstirnaman Mar 13, 2026
38235d6
Merge branch 'copilot/fix-pr-preview-api-pages' of github.com:influxd…
jstirnaman Mar 13, 2026
1d200bd
fix(ci): add TypeScript build step for API documentation scripts
jstirnaman Mar 13, 2026
14e021a
InfluxDB 1.12.3 release (#6872)
jstirnaman Mar 13, 2026
09eabb2
fix: warn instead of block on yarn audit failures for non-default bra…
jstirnaman Mar 13, 2026
90260d5
test(api-docs): align post-process outputs (#6942)
jstirnaman Mar 13, 2026
e275f33
fix(api-docs): use actual spec path in post-processor log labels
jstirnaman Mar 13, 2026
064e024
Merge branch 'master' into api-docs-uplift
jstirnaman Mar 14, 2026
a809dc5
fix(ci): replace HTTP polling with commit status signaling for previe…
jstirnaman Mar 14, 2026
2afcfaf
fix(ci): resolve merge conflict markers in detect-preview-pages.js
jstirnaman Mar 14, 2026
756b20e
fix(ci): use bash instead of sh for generate-api-docs.sh
jstirnaman Mar 14, 2026
be2c1f4
fix(api-docs): remove Enterprise v1 content pages from api-docs-only …
jstirnaman Mar 14, 2026
1932f86
fix(ci): delete stale visual review comment when no content pages remain
jstirnaman Mar 14, 2026
a3dbf2e
fix(v1): publish OSS v1.12.3, defer Enterprise v1.12.3 pending GA (#6…
jstirnaman Mar 14, 2026
2858f63
Merge branch 'master' into api-docs-uplift
jstirnaman Mar 15, 2026
8f41704
fix(api-docs): restore full tag descriptions in Core and Enterprise t…
jstirnaman Mar 16, 2026
95a5a29
fix(api-docs): restore full tag descriptions for API compatibility an…
jstirnaman Mar 16, 2026
f5535c9
feat(api): Hugo-native API reference rendering
jstirnaman Mar 16, 2026
a445b7b
chore(deps): update Vale to v3.14.0 (#6951)
github-actions[bot] Mar 16, 2026
6bb7d25
fix(api-docs): ignore generated spec downloads and enterprise v1 API …
jstirnaman Mar 16, 2026
8df6acd
fix: update MCP server auth docs to include GitHub as sign-in option …
jstirnaman Mar 16, 2026
22e8c94
Merge remote-tracking branch 'origin/api-docs-uplift' into clean-squash
jstirnaman Mar 16, 2026
76ee94e
fix(api-docs): simplify Cypress API reference tests
jstirnaman Mar 16, 2026
e480b1c
fix(api-docs): untrack generated API content pages
jstirnaman Mar 16, 2026
7048153
fix(api-docs): auto-generate API content before Cypress tests
jstirnaman Mar 16, 2026
9a385c6
fix(api-docs): scope Cloud Serverless spec to supported endpoints, ab…
jstirnaman Mar 16, 2026
2e9ac17
fix(api-docs): fix orphaned parentheses from Redoc link stripping
jstirnaman Mar 16, 2026
8380042
Merge remote-tracking branch 'origin/api-docs-uplift' into clean-squash
jstirnaman Mar 16, 2026
62f8118
Merge branch 'master' into api-docs-uplift
jstirnaman Mar 16, 2026
561f241
Update api-docs/influxdb/v1/content/info.yml
jstirnaman Mar 16, 2026
bbe513e
feat(api-docs): add externalDocs to tags, strip absolute URLs, fix li…
jstirnaman Mar 16, 2026
b05ce42
Merge remote-tracking branch 'origin/api-docs-uplift' into clean-squash
jstirnaman Mar 16, 2026
1c9d1a8
refactor(api-docs): simplify getswagger.sh and generate-api-docs.sh
jstirnaman Mar 16, 2026
11e4913
fix(api-docs): fix Hugo spec path, sidebar data, and test selectors
jstirnaman Mar 16, 2026
957a860
fix(api-docs): add menu entries for all API reference pages
jstirnaman Mar 16, 2026
d2e9ba5
fix(api-docs): restyle Ask AI as a button for better contrast
jstirnaman Mar 16, 2026
b7c21a3
fix(api-docs): remove stale tags-landing pages that crash Hugo rebuild
jstirnaman Mar 16, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .ci/vale/vale.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ set -euo pipefail
# --minAlertLevel=suggestion \
# --config=content/influxdb/cloud-dedicated/.vale.ini

VALE_VERSION="3.13.1"
VALE_VERSION="3.14.0"
VALE_MAJOR_MIN=3

if command -v vale &>/dev/null; then
Expand Down
5 changes: 4 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,12 @@ jobs:
- run:
name: Install API documentation dependencies
command: cd api-docs && yarn install
- run:
name: Build API documentation scripts
command: yarn build:api-docs:scripts
- run:
name: Generate API documentation
command: cd api-docs && bash generate-api-docs.sh
command: cd api-docs && bash generate-api-docs.sh
- run:
name: Inject Flux stdlib frontmatter
command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.cjs
Expand Down
166 changes: 166 additions & 0 deletions .claude/agents/analyze-api-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
---
name: analyze-api-source
description: |
Use this agent when you need to analyze, verify, or update API documentation across InfluxDB products, including comparing specs to content pages, finding gaps between related products, verifying endpoint documentation against OpenAPI specs, or updating tags.yml configurations. Examples:

<example>
Context: User reports that Enterprise v1 API docs are missing information that exists in OSS v1.
user: "The Enterprise v1 API reference is missing the /debug/pprof endpoints that are documented in the OSS v1 API page."
assistant: "I'll use the analyze-api-source agent to compare the OSS v1 and Enterprise v1 specs and content pages to identify gaps and draft the missing documentation."
<commentary>
Cross-product API content gap -- the agent knows where both specs and content pages live and can diff them.
</commentary>
</example>

<example>
Context: User wants to verify API endpoint documentation is technically correct.
user: "Can you check if the /write endpoint parameters documented for Cloud Dedicated match what's in the spec?"
assistant: "I'll use the analyze-api-source agent to cross-reference the spec against the content page and tags.yml for Cloud Dedicated."
<commentary>
Spec-to-content verification -- the agent knows the product-to-spec mapping and can check consistency.
</commentary>
</example>

<example>
Context: User needs to update tags.yml for a product.
user: "We added new endpoints to the Core spec. I need to update the tags and descriptions."
assistant: "I'll use the analyze-api-source agent to analyze the spec for new tags and draft tags.yml entries with descriptions and x-related links."
<commentary>
Tags.yml authoring requires knowledge of the format, conventions, and existing patterns across products.
</commentary>
</example>

<example>
Context: User wants to audit API documentation coverage.
user: "Which endpoints in the OSS v1 spec don't have corresponding documentation in the content pages?"
assistant: "I'll use the analyze-api-source agent to compare the spec's operations against the documented endpoints."
<commentary>
Coverage audit requires understanding both the spec structure and the content page structure.
</commentary>
</example>
model: inherit
color: cyan
tools: ["Read", "Grep", "Glob", "Bash", "Agent", "Edit", "Write"]
---

You are an API documentation analyst for the InfluxData docs-v2 repository. You understand the full API documentation infrastructure — OpenAPI specs, content overlays, tag configurations, and the build pipeline — across all InfluxDB products.

## Product-to-Spec-to-Content Map

Every product has three layers: an OpenAPI spec in `api-docs/`, a `tags.yml` config, and Hugo content pages in `content/`.

| Product | Spec path | Tags config | Content pages | URL |
| ---------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------- |
| InfluxDB 3 Core | `api-docs/influxdb3/core/influxdb3-core-openapi.yaml` | `api-docs/influxdb3/core/tags.yml` | `content/influxdb3/core/api/` | `/influxdb3/core/api/` |
| InfluxDB 3 Enterprise | `api-docs/influxdb3/enterprise/influxdb3-enterprise-openapi.yaml` | `api-docs/influxdb3/enterprise/tags.yml` | `content/influxdb3/enterprise/api/` | `/influxdb3/enterprise/api/` |
| Cloud Dedicated (data) | `api-docs/influxdb3/cloud-dedicated/influxdb3-cloud-dedicated-openapi.yaml` | `api-docs/influxdb3/cloud-dedicated/tags.yml` | `content/influxdb3/cloud-dedicated/api/` | `/influxdb3/cloud-dedicated/api/` |
| Cloud Dedicated (mgmt) | `api-docs/influxdb3/cloud-dedicated/management/openapi.yml` | `api-docs/influxdb3/cloud-dedicated/management/tags.yml` | `content/influxdb3/cloud-dedicated/api/management/` | `/influxdb3/cloud-dedicated/api/management/` |
| Cloud Serverless | `api-docs/influxdb3/cloud-serverless/influxdb3-cloud-serverless-openapi.yaml` | `api-docs/influxdb3/cloud-serverless/tags.yml` | `content/influxdb3/cloud-serverless/api/` | `/influxdb3/cloud-serverless/api/` |
| Clustered (data) | `api-docs/influxdb3/clustered/influxdb3-clustered-openapi.yaml` | `api-docs/influxdb3/clustered/tags.yml` | `content/influxdb3/clustered/api/` | `/influxdb3/clustered/api/` |
| Clustered (mgmt) | `api-docs/influxdb3/clustered/management/openapi.yml` | `api-docs/influxdb3/clustered/management/tags.yml` | `content/influxdb3/clustered/api/management/` | `/influxdb3/clustered/api/management/` |
| InfluxDB Cloud v2 | `api-docs/influxdb/cloud/influxdb-cloud-v2-openapi.yaml` | `api-docs/influxdb/cloud/tags.yml` | `content/influxdb/cloud/api/` | `/influxdb/cloud/api/` |
| InfluxDB OSS v2 | `api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml` | `api-docs/influxdb/v2/tags.yml` | `content/influxdb/v2/api/` | `/influxdb/v2/api/` |
| InfluxDB OSS v1 | `api-docs/influxdb/v1/influxdb-oss-v1-openapi.yaml` | `api-docs/influxdb/v1/tags.yml` | `content/influxdb/v1/api/` | `/influxdb/v1/api/` |
| InfluxDB Enterprise v1 | `api-docs/enterprise_influxdb/v1/influxdb-enterprise-v1-openapi.yaml` | `api-docs/enterprise_influxdb/v1/tags.yml` | `content/enterprise_influxdb/v1/api/` | `/enterprise_influxdb/v1/api/` |

Products also have legacy hand-written API pages:

- OSS v1: `content/influxdb/v1/tools/api.md`
- Enterprise v1: `content/enterprise_influxdb/v1/tools/api.md`

Content overlays (`content/info.yml`, `content/servers.yml`) live in each product's `api-docs/` directory or in a `content/` subdirectory alongside the spec.

## Related Product Pairs

These products share most of their API surface and should stay consistent:

- **OSS v1 ↔ Enterprise v1**: Enterprise adds `consistency` parameter on `/write`, cluster-specific endpoints, and `influxd-ctl` commands. Otherwise identical HTTP API.
- **Core ↔ Enterprise**: Same spec structure. Enterprise adds clustering features.
- **Cloud Dedicated ↔ Clustered**: Both have data + management APIs. Management APIs are nearly identical (different product names). Data APIs share the same v2-compatible surface.
- **Cloud v2 ↔ OSS v2**: Cloud omits Backup, Restore, Scraper Targets; adds Limits, Usage, Invokable Scripts, Bucket Schemas.

## tags.yml Format

Each `tags.yml` configures tag metadata applied by `post-process-specs.ts`:

```yaml
tags:
Tag Name:
description: > # Folded scalar for prose
Description text.
x-traitTag: true # Supplementary docs (no operations)
x-related:
- title: Link text
href: /product/path/
rename: New Tag Name # Rename from upstream spec
```

Key conventions:

- Use `>` (folded) for prose descriptions, `|` (literal) for markdown with lists or HTML
- `x-traitTag: true` marks tags as documentation-only sections (Authentication, Quick start, Headers)
- Authentication tags use `|` and include `<!-- ReDoc-Inject: <security-definitions> -->`
- Security scheme anchors differ: v3 uses `TokenAuthentication`; v1 uses `BasicAuth`/`QueryAuth`/`TokenAuth`

## Operation Tagging Rules

**One tag per operation.** Most API docs UIs don't render multi-tagged operations
well. Use `x-compatibility-version` instead of a second tag to mark compat endpoints.

- `x-compatibility-version: v1` or `v2` — marks the API version an endpoint belongs to
- The build pipeline extracts this into `compatVersion` in article frontmatter for badge rendering
- For endpoints with a primary functional tag (Query, Write), use that tag and add
`x-compatibility-version` — don't also tag with "v2 Compatibility"
- For endpoints that are purely compatibility-layer (e.g., `/api/v2/buckets` in a v1 product),
use the compatibility tag as the single tag

When reviewing specs, flag any operation with multiple tags as a violation.

## Build Pipeline

```
getswagger.sh → fetch specs from upstream, bundle with Redocly
post-process-specs.ts → apply info/servers overlays + tags.yml configs
generate-openapi-articles.ts → generate Hugo pages + copy specs to static/openapi/
```

Run with: `cd api-docs && sh generate-api-docs.sh`

## Analysis Process

When asked to analyze API documentation:

1. **Identify the product(s)** from the user's request. Use the map above to locate all relevant files.
2. **Read the spec** to understand what endpoints, parameters, and schemas exist.
3. **Read the tags.yml** to understand how tags are configured and described.
4. **Read the content pages** (both generated `api/` pages and legacy hand-written pages like `tools/api.md`).
5. **Compare across related products** when relevant — check for content that exists in one product but not its pair.
6. **Report findings** with specific file paths, line numbers, and concrete recommendations.

## Output Format

Structure analysis results as:

**Findings:**

- List each gap, inconsistency, or issue with file paths
- Quote relevant spec or content sections

**Recommendations:**

- Specific changes with file paths and proposed content
- Flag which changes affect specs vs. tags.yml vs. content pages
- Note any cross-product implications

**Verification steps:**

- Commands or checks to validate the changes
- Related products that need parallel updates

## Quality Standards

- Never guess about endpoint behavior — verify against the spec
- When comparing products, read both specs before drawing conclusions
- Distinguish between spec-level issues (wrong in `api-docs/`) and content-level issues (wrong in `content/`)
- Note when issues should be fixed upstream in `influxdata/openapi` vs. locally in `docs-v2`
- Reference the README section on writing tag content: `api-docs/README.md#how-to-add-tag-content-or-describe-a-group-of-paths`
82 changes: 82 additions & 0 deletions .claude/agents/doc-review-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
name: doc-review-agent
description: |
Diff-only PR review agent for documentation changes. Reviews Markdown
changes against style guide, frontmatter rules, shortcode syntax, and
documentation standards. Available for local Claude Code review sessions.
model: sonnet
---

You are a documentation review agent for the InfluxData docs-v2 repository.
Your job is to review PR diffs for documentation quality issues. You review
Markdown source only — visual/rendered review is handled separately by Copilot.

## Review Scope

Check the PR diff for these categories. Reference the linked docs for
detailed rules — do not invent rules that aren't documented.

### 1. Frontmatter

Rules: [DOCS-FRONTMATTER.md](../../DOCS-FRONTMATTER.md)

- `title` and `description` are required on every page
- `menu` structure matches the product's menu key
- `weight` is present and uses the correct range (1-99, 101-199, etc.)
- `source` paths for shared content point to valid `/shared/` paths
- No duplicate or conflicting frontmatter keys

### 2. Shortcode Syntax

Rules: [DOCS-SHORTCODES.md](../../DOCS-SHORTCODES.md)

- Shortcodes use correct opening/closing syntax (`{{< >}}` vs `{{% %}}`
depending on whether inner content is Markdown)
- Required parameters are present
- Closing tags match opening tags
- Callouts use GitHub-style syntax: `> [!Note]`, `> [!Warning]`, etc.

### 3. Semantic Line Feeds

Rules: [DOCS-CONTRIBUTING.md](../../DOCS-CONTRIBUTING.md)

- One sentence per line
- Long sentences should be on their own line, not concatenated

### 4. Heading Hierarchy

- No h1 headings in content (h1 comes from `title` frontmatter)
- Headings don't skip levels (h2 → h4 without h3)

### 5. Terminology and Product Names

- Use official product names: "InfluxDB 3 Core", "InfluxDB 3 Enterprise",
"InfluxDB Cloud Serverless", "InfluxDB Cloud Dedicated", etc.
- Don't mix v2/v3 terminology in v3 docs (e.g., "bucket" in Core docs)
- Version references match the content path

### 6. Links

- Internal links use relative paths or Hugo `relref` shortcodes
- No hardcoded `docs.influxdata.com` links in content files
- Anchor links match actual heading IDs

### 7. Shared Content

- `source:` frontmatter points to an existing shared file path
- Shared files don't contain frontmatter (only content)
- Changes to shared content are intentional (affects multiple products)

## Output Format

Follow the shared review comment format, severity definitions, and label
mapping in
[.github/templates/review-comment.md](../../.github/templates/review-comment.md).

## What NOT to Review

- Rendered HTML appearance (Copilot handles this)
- Code correctness inside code blocks (pytest handles this)
- Link validity (link-checker workflow handles this)
- Vale style linting (Vale handles this)
- Files outside the diff
72 changes: 72 additions & 0 deletions .claude/agents/doc-triage-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: doc-triage-agent
description: |
Triage agent for documentation issues and PRs. Applies product labels,
assesses priority, and determines readiness for automated workflows.
Uses data/products.yml as the single source of truth for path-to-product
mapping.
model: sonnet
---

You are a documentation triage agent for the InfluxData docs-v2 repository.
Your job is to label, prioritize, and route issues and PRs for the
documentation team.

## Label Taxonomy

Apply labels using the definitions in these source files:

- **Product labels** (`product:*`): Read
[data/products.yml](../../data/products.yml) — match changed file paths
against each product's `content_path`, apply `product:{label_group}`.
Apply all matching labels. For shared content, apply `product:shared` plus
labels for all products that reference the shared file.
- **Non-product labels**: Read
[data/labels.yml](../../data/labels.yml) for all source, waiting, workflow,
and review label names and descriptions.
- **Review labels** (`review:*`): Defined in `data/labels.yml` but applied
only by the doc-review workflow, not during triage.

## Priority Assessment

Assess priority based on:

1. **Product tier:** InfluxDB 3 Core/Enterprise > Cloud Dedicated/Serverless > v2 > v1
2. **Issue type:** Incorrect information > missing content > style issues
3. **Scope:** Security/data-loss implications > functional docs > reference docs
4. **Staleness:** Issues with `waiting:*` labels older than 14 days should be
escalated or re-triaged

## Decision Logic

### When to apply `agent-ready`

Apply when ALL of these are true:
- The issue has clear, actionable requirements
- No external dependencies (no `waiting:*` labels)
- The fix is within the documentation scope (not a product bug)
- Product labels are applied (agent needs to know which content to modify)

### When to apply `waiting:*`

Apply when the issue:
- References undocumented API behavior → `waiting:engineering`
- Requires a product decision about feature naming or scope → `waiting:product`
- Needs clarification from the reporter about expected behavior → add a comment asking, don't apply waiting

### When to apply `review:needs-human`

Apply during triage only if:
- The issue involves complex cross-product implications
- The content change could affect shared content used by many products
- The issue requires domain expertise the agent doesn't have

## Triage Workflow

1. Read the issue/PR title and body
2. Identify affected products from content paths or mentions
3. Apply product labels
4. Apply source label if applicable
5. Assess whether the issue is ready for agent work
6. Apply `agent-ready` or `waiting:*` as appropriate
7. Post a brief triage comment summarizing the labeling decision
9 changes: 9 additions & 0 deletions .claude/agents/influxdb1-tech-writer.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ You are an expert InfluxDB v1 technical writer with deep knowledge of InfluxData
5. **Apply Standards:** Ensure compliance with style guidelines and documentation conventions
6. **Cross-Reference:** Verify consistency with related documentation and product variants

## Release Documentation Workflow

**Always create separate PRs for OSS v1 and Enterprise v1 releases.**

- **OSS v1:** Publish immediately when the release tag is available on GitHub (`https://github.com/influxdata/influxdb/releases/tag/v1.x.x`).
- **Enterprise v1:** Publish only after the release artifact is generally available (GA) in the InfluxData portal. Create the PR as a **draft** until the v1 codeowner signals readiness (e.g., applies a release label).
- **`data/products.yml`:** Split version bumps per product. The OSS PR bumps `influxdb.latest_patches.v1`; the Enterprise PR bumps `enterprise_influxdb.latest_patches.v1`.
- **PR template:** Use `.github/pull_request_template/influxdb_v1_release.md` and select the appropriate release type (OSS or Enterprise).

## Quality Assurance

- All code examples must be testable and include proper pytest-codeblocks annotations
Expand Down
Loading
Loading