Added initial cloud files#7338
Conversation
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>
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>
|
@copilot resolve the merge conflicts in this pull request |
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
| {{ $influxdbCloud := dict "influxdb/cloud" (slice $.Site.Data.products.influxdb_cloud.name "cloud") }} | ||
| {{ $influxdb3Core := dict "influxdb3/core" (slice $.Site.Data.products.influxdb3_core.name "core") }} | ||
| {{ $influxdb3Enterprise := dict "influxdb3/enterprise" (slice $.Site.Data.products.influxdb3_enterprise.name "enterprise") }} | ||
| {{ $influxdb3Cloud := dict "influxdb3/cloud" (slice $.Site.Data.products.influxdb3_cloud.name "cloud") }} | ||
| {{ $influxdb3Explorer := dict "influxdb3/explorer" (slice $.Site.Data.products.influxdb3_explorer.name "explorer") }} |
…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>
|
📦 PR Preview — Preview Bot
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
Replace the admin-token-from-support flow with the self-service OAuth device-code login (influxdb3 auth login --oauth), which is the customer auth path for InfluxDB 3 Cloud. The initial admin token is an internal operator flow and is removed from customer docs. - Get your instance (host URL only) -> connect -> log in via auth login --oauth (credentials cached in ~/.influxdb3/credentials.json; do not set INFLUXDB3_AUTH_TOKEN for interactive use) -> verify with show databases. - Keep database-token creation for applications; note that creating tokens requires admin privileges. - Note that a new database can take a few seconds to appear in show databases. - Preserve the #configure-the-influxdb3-cli and #set-your-token-for-authorization anchors for existing inbound links. Co-authored with Claude
|
The Get started landing page ( I opened #7388 against this branch ( Follow-up noted in that PR: the page also duplicates the shared Data model prose and drops the shared Tools table. Deduping by sourcing the shared file (with |
jstirnaman
left a comment
There was a problem hiding this comment.
Overall, looks great! Mostly style nits and a couple of small PRs for substantial changes. I'll start work soon on the InfluxDB 3 info. arch. redesign.
| Enterprise. Built on InfluxDB 3, it delivers high write and query performance | ||
| with a diskless architecture that scales horizontally without the operational | ||
| overhead of managing your own infrastructure. InfluxDB 3 Cloud is the | ||
| recommended destination for InfluxDB Cloud Dedicated customers. |
There was a problem hiding this comment.
Add a when/why they're destined?
There was a problem hiding this comment.
Yikes,good catch i think i wrote this a while ago,that whole line needs to go.
| > Interested in trying InfluxDB 3 Cloud? | ||
| > Learn more and request access on the | ||
| > [InfluxDB 3 Cloud product page](https://www.influxdata.com/products/influxdb3-cloud/). |
There was a problem hiding this comment.
| > Interested in trying InfluxDB 3 Cloud? | |
| > Learn more and request access on the | |
| > [InfluxDB 3 Cloud product page](https://www.influxdata.com/products/influxdb3-cloud/). | |
| > Interested in trying InfluxDB 3 Cloud? | |
| > See the | |
| > [InfluxDB 3 Cloud product page](https://www.influxdata.com/products/influxdb3-cloud/) | |
| > to request access. |
| ## Create a database | ||
|
|
||
| Use the | ||
| [`influxdb3 create database` command](/influxdb3/cloud/reference/cli/influxdb3/) |
There was a problem hiding this comment.
TODO: update this URL when reference content is added
| The command returns the token string. | ||
| Store the token string in a safe place. | ||
| **This is the only time the token string is available in plain text.** | ||
| Applications can authenticate with the token by setting the | ||
| `INFLUXDB3_AUTH_TOKEN` environment variable or passing the `--token` option. |
There was a problem hiding this comment.
Use the standard "Store your token securely" callout, matching setup.md.
| The command returns the token string. | |
| Store the token string in a safe place. | |
| **This is the only time the token string is available in plain text.** | |
| Applications can authenticate with the token by setting the | |
| `INFLUXDB3_AUTH_TOKEN` environment variable or passing the `--token` option. | |
| The command returns the token string. | |
| > [!Important] | |
| > #### Store your token securely | |
| > | |
| > InfluxDB displays the token string only when you create it. | |
| > Store your token securely—you cannot retrieve it from the database later. | |
| Applications can authenticate with the token by setting the | |
| `INFLUXDB3_AUTH_TOKEN` environment variable or passing the `--token` option. |
| - [Perform an ungrouped aggregation](#perform-an-ungrouped-aggregation) | ||
| - [Group and aggregate data](#group-and-aggregate-data) | ||
| - [Downsample data by applying interval-based aggregates](#downsample-data-by-applying-interval-based-aggregates) | ||
| - [Query rows based on aggregate values](#query-rows-based-on-aggregate-values) |
| present, and .Summary can error on pages whose auto-summary truncates | ||
| mid-shortcode (leaving a malformed shortcode token). */ -}} | ||
| {{- $description := .Description -}} | ||
| {{- if not $description -}} |
jstirnaman
left a comment
There was a problem hiding this comment.
Overall, looks great! Mostly style nits and a couple of small PRs for substantial changes. I'll start work soon on the InfluxDB 3 info. arch. redesign.
Some of these suggestions Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
Thanks for the review and the additional PRs @jstirnaman ! Some of your comments have inspired some more phrasing changes, i'll add a small PR against this branch today to make those. Also user groups will get a page under users with 3.11 for sure. |
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/