Added initial cloud files#7338
Open
ritwika314 wants to merge 31 commits into
Open
Conversation
Contributor
Vale Style Check Results
Warnings (16)
✅ Check passed |
Add get-started, write-data, query-data, visualize-data, admin, and reference section landing pages for InfluxDB 3 Cloud, sourcing shared content following the Enterprise pattern. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces initial documentation scaffolding for the new InfluxDB 3 Cloud section, wires it into site navigation/title handling, and registers the product in the central products data so it can participate in shared templates and UI components.
Changes:
- Add
influxdb3_cloudproduct metadata todata/products.yml. - Add initial InfluxDB 3 Cloud content section stubs (landing page + key sub-sections), mostly sourcing shared content.
- Update the product selector and HTML
<title>logic to recognize/influxdb3/cloud/, and bump the Telegraf docs link in the platform reference.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| PLATFORM_REFERENCE.md | Updates the Telegraf documentation link to v1.39. |
| layouts/partials/topnav/product-selector.html | Adds InfluxDB 3 Cloud to the product selector data and UI list. |
| layouts/partials/header/title.html | Sets a distinct site title for InfluxDB 3 Cloud pages. |
| data/products.yml | Registers the new influxdb3_cloud product and associated metadata. |
| content/influxdb3/cloud/_index.md | Adds the InfluxDB 3 Cloud landing page, cascade settings, and early access callout. |
| content/influxdb3/cloud/admin/_index.md | Adds admin section stub sourcing shared admin content. |
| content/influxdb3/cloud/get-started/_index.md | Adds get-started section stub sourcing shared get-started content. |
| content/influxdb3/cloud/query-data/_index.md | Adds query section stub sourcing shared query-guide content. |
| content/influxdb3/cloud/reference/_index.md | Adds reference section stub with children listing. |
| content/influxdb3/cloud/visualize-data/_index.md | Adds visualize section index with children listing. |
| content/influxdb3/cloud/write-data/_index.md | Adds write-data section stub sourcing shared write-guide content. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Collaborator
Author
|
@copilot resolve the merge conflicts in this pull request |
Contributor
Resolved by merging |
Go's `default` evaluates both arguments, so `.Description | default .Summary` always computed .Summary, which can error on pages whose auto-summary truncates mid-shortcode (leaving a malformed shortcode token). Use an explicit conditional so .Summary is only accessed when .Description is unset. Co-authored with Claude
… docs - Add cloud-specific get-started setup (managed procurement, influxdb3 CLI token auth) and reuse shared write/query guides via 'cloud' conditionals - Incorporate enterprise query-data, databases, and tables into cloud admin - Add cloud manage-users section (adapted from Cloud Dedicated) - Add write-data client-libraries, influxdb3 CLI, and HTTP API guides - Add limits for influxdb3_cloud in products.yml (fixes influxdb3/limit crash) - Hide Explorer, compatibility APIs, optimize-queries, write-responses, and visualize-data for cloud; render the instance host instead of localhost - Scope the early-access callout to the landing and get-started pages Co-authored with Claude
…nformation page Resolve CI broken links on InfluxDB 3 Cloud pages by routing all not-yet-published cloud paths to a single request-information page that directs readers to InfluxData support. - Add content/influxdb3/cloud/request-information.md owning the 49 missing cloud paths as aliases (covers links from the token-link shortcode, raw HTML buttons, and shared markdown). Excluded from nav and child lists. - Fix shared influxql/troubleshoot.md: /enterprise_influxdb/v1/api/query/ -> /enterprise_influxdb/v1/api/ (the /query/ subpath is not a built page). - Remove a dangling TOC entry in shared influxql/aggregate-select.md that pointed to a section only present in the SQL version. Co-authored with Claude
… anchors The link checker's fragment validator follows meta-refresh redirects but ignores the lychee exclude config, so aliasing not-yet-published Cloud paths left their #fragment deep links broken. Add the referenced anchors to the redirect target so the checker resolves them there. - request-information.md: alias all not-yet-published Cloud reference/API paths and add hidden anchors for every referenced #fragment. The checker follows each alias redirect to this page and finds the anchor. Remove an anchor when its target page is published for Cloud. - production.lycherc.toml: exclude the v1 query API reference link (generated by a separate api-docs pipeline that does not run during the link-check job). Co-authored with Claude
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
Resolved the merge conflicts in two files:
|
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/influxdb3/cloud/admin/databases/create/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/databases/create/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/databases/delete/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/databases/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/databases/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/cloud/admin/databases/list/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/cloud/admin/tables/create/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/tables/delete/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/tables/delete/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/tables/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/tables/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/tables/list/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/tables/list/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/cloud/admin/tokens/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/users/admin-ui/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/cloud/admin/users/admin-ui/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/users/admin-ui/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/users/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Showing first 20 of 46 warnings. See the workflow run for full results.
Full details: workflow run summary and artifact. Last updated: 2026-07-15 23:05:00 UTC
Add the get-started step roadmap and a next-step nav to the Cloud
Get started landing page so readers can move into the guide from the
page body instead of relying on the Related sidebar.
- Add {{< children type="ordered-list" >}} to list the Set up, Write,
and Query steps.
- Add page-nav linking to the setup page.
Co-authored-by: ritwika314 <mim.ghosh@gmail.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
Collaborator
Author
|
@copilot resolve the merge conflicts in this pull request |
Contributor
Merged latest |
Add the missing operation/GetV1ExecuteQuery hidden anchor to request-information.md so the InfluxQL troubleshoot link resolves through the /influxdb3/cloud/api/query-data/ alias. Point the get-started setup retention period link at the aliased data-retention page. The Retention periods section on the databases page renders only for Core and Enterprise, so the #retention-periods fragment never existed for Cloud. Refs #7391 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Cloud runs the same InfluxDB 3 engine as Enterprise, so surface the Enterprise retention period content for Cloud instead of pointing the get-started setup link at the aliased data-retention page. - Revert the setup retention link back to the databases page fragment suggested in review, and render the Retention periods section for Cloud. - Render the table retention period section, CLI and API examples, and request body parameter for Cloud so the page is self-consistent. - Fix the databases page link to table retention, which pointed at #create-a-table-with-a-retention-period. That anchor doesn't exist; the heading renders as #retention-period. This link was broken for Enterprise too. - Alias the Cloud update/database CLI path and add the retention-period-precedence anchor for links in the newly shown content. Address review feedback: drop the Cloud Dedicated destination claim from the landing page description, and revise the CLI reference closing. Refs #7391 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
3 tasks
Align the screenshot TODO comment with the "Admin UI" term used throughout the page. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Cloud instance URLs use instance-id.enterprise.influxdb.io, not the
Cloud Dedicated cluster-id.a.influxdb.io form. Updating placeholder_host
corrects every {{< influxdb/host >}} render across the Cloud docs.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
4 tasks
Editing the file normalized stray CRLF line endings, leaving whitespace-only churn in the PR diff after the retention link change was reverted. Restore the original bytes so the file drops out of the diff. Co-Authored-By: Claude
Collaborator
Author
|
@jstirnaman pushed a few commits since your review, ready for another look whenever you get a chance.
Issues created:
|
- Remove dead latest-cli shortcode and its DOCS-SHORTCODES.md mention; latest-patch cli=true is the surviving equivalent (reads influxdb.latest_cli, still used by latest-patch.html). - Add check-v3-cli-version.sh: flags latest-patch cli=true in bundled-CLI content (Core/Enterprise/Cloud + shared influxdb3-*), where it renders the wrong v2 influx CLI version instead of the bundled influxdb3 CLI version. - Add influxdb3-cloud-lint mirroring enterprise-lint (root .vale.ini). - Document lefthook gobwas glob semantics in the lefthook.yml header.
The wayfinding modal keyed on the `cloud` version slug alone, so it fired on influxdb3/cloud pages and rendered InfluxDB Cloud (TSM) content. Both influxdb_cloud (TSM) and influxdb3_cloud declare the `cloud` version slug. Guard the modal on (product, version) so it only renders for the TSM / Serverless pair. Comment the matching `cloud3` alt_link workaround in the product selector.
The exclusion used the bare substring `enterprise_influxdb/v1/api`, which could mask genuine breakage on any /v1/api-* path. Anchor it to `/enterprise_influxdb/v1/api/` so it only excludes the pipeline-generated API reference pages. Update the comment: the shared query-guide link that originally motivated it was replaced in this PR.
- Convert tables/delete.md list_code_example to bare-name placeholders with
a {placeholders=...} attribute, matching create.md and databases/*.
- Add trailing newlines to five files (tables/*, parameterized-queries.md).
- Replace prose double-hyphens with em dashes in users/_index.md and the
shared setup-cloud.md.
Contributor
|
@ritwika314 I added some layout and shortcode fixes. I'd like to fix #7502 before publishing. Should be quick. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces documentation for InfluxDB 3 Cloud, including new sections on user, database, table, and token management. It adds guides for using the Admin UI and CLI/API for common administrative tasks, and updates the link checker configuration to accommodate generated API reference links.
Most of the content is reused from enterprise docs, hiding features where unavailable, and routing unimplemented docs/unavailable api references to
influxdb3/cloud/request-information.md. According to Claude this PR is touching existing with broken references, which is the rationale for changing.ci/link-checker/production.lycherc.toml.Major documentation additions:
InfluxDB 3 Cloud documentation landing page and structure:
content/influxdb3/cloud/_index.mdto introduce InfluxDB 3 Cloud, its features, and early access status.content/influxdb3/cloud/admin/_index.mdto provide an overview of administrative tasks.User and access management:
content/influxdb3/cloud/admin/users/_index.md) and detailed Admin UI instructions (content/influxdb3/cloud/admin/users/admin-ui.md). [1] [2]content/influxdb3/cloud/admin/tokens/_index.md).Database and table administration:
content/influxdb3/cloud/admin/databases/_index.md,create.md,list.md,delete.md). [1] [2] [3] [4]content/influxdb3/cloud/admin/tables/_index.md,create.md,list.md,delete.md). [1] [2] [3] [4]Build and configuration updates:
.ci/link-checker/production.lycherc.toml).Checklist
npx hugo --quiet)Suggested reviewers (click to expand)
Based on files changed, consider requesting review from:
InfluxDB 3
InfluxDB v2 / v1 / Enterprise v1
Other Products
Shared / Cross-Product
/content/shared/