* chore: add .worktrees to gitignore
* refactor: replace URL-parsing in shortcodes with cascade product data
Replace duplicated URL-parsing logic across 28 shortcodes with Hugo's
cascade frontmatter. Each product section's _index.md now cascades
`product` (data key) and `version` (URL segment) to all descendants.
Key changes:
- Add cascade frontmatter to 15 product _index.md files
- Create layouts/partials/product/get-data.html shared partial
- Refactor 28 shortcodes to use the partial instead of parsing URLs
- Add version_label, limits, and distributed_architecture metadata
to data/products.yml to eliminate hardcoded dicts in shortcodes
- Fix lefthook lint-markdown-instructions glob format (YAML array)
- Fix pre-existing Vale exclamation point errors in cloud and v2
* fix: prevent remark-lint from escaping Hugo template syntax in shortcodes
Lefthook's glob option only triggers whether a command runs — it does
not filter {staged_files}. This caused remark-lint to process .md
shortcode files in layouts/, escaping underscores, brackets, and
parentheses that are valid Hugo template syntax.
Add layouts/ exclusion to the existing content/ filter in the
lint-markdown-instructions run command. Also fix the 3 shortcode files
that were damaged by remark-lint in the previous commit.
* test: add E2E tests for cascade product shortcodes
Add Cypress tests validating all refactored shortcodes across 14
product/version combos (82 tests). Test expectations are derived
from products.yml at runtime via cy.task('getData').
Fix the product links test to iterate actual home page links
instead of all products.yml entries.
Create _test/shortcodes.md pages in each product section
exercising product-name, product-key, current-version,
influxdb/host, and InfluxDB3-specific shortcodes.
* test: expand E2E coverage to 27 of 28 cascade shortcodes
Add shortcode invocations to all 14 test pages and corresponding
Cypress assertions for version lookups, namespace URLs, product
name text, placeholder_host, version visibility, CTA links, and
site-level data.
Add shortcodes-real-pages.cy.js for 6 shortcodes that require real
page context (cli/mapped, children, flux/list-all-functions,
telegraf/plugins, html-diagram/sso-auth-flow, cli/influxd-flags).
Suppress Vale on test pages — they contain only shortcode syntax,
not prose.
163 tests total, all passing.
* refactor(test): rename _test dirs to __tests__ and add noindex
Rename test page directories from _test to __tests__ to align with
JS testing conventions. Add noindex: true to all 14 test page
frontmatter to prevent search engine indexing in production.
Update Cypress URL pattern to match new paths.
- Add data/article_data/ to .gitignore
- Integrate generate-openapi-articles into generate-api-docs.sh
- Remove tracked article_data files (now generated at build time)
This avoids large data file diffs in PRs and ensures article data
stays in sync with OpenAPI specs.
Add API nav items as children of "InfluxDB HTTP API" menu item:
- New api-menu-items.html partial generates nav from data/articles.yml
- Modified nested-menu.html to inject API nav for API parent menu item
- Updated api_nav_groups.yml to add url for Administration group
- Created Administration landing pages for Core and Enterprise
- Updated .gitignore to allow hand-crafted API conceptual pages
The Administration page uses layout: list and isConceptual: true to render
content directly without RapiDoc wrapper.
Replace legacy API documentation approach with modern Scalar-based rendering:
## Architecture Changes
- Add renderer abstraction (`layouts/partials/api/`) supporting Scalar and RapiDoc
- Create `api` layout type for API reference pages (single.html, list.html)
- Configure renderer via `site.Params.apiRenderer` (default: scalar)
## OpenAPI Processing Pipeline (TypeScript)
- `api-docs/scripts/generate-openapi-articles.ts` - Main generation script
- `api-docs/scripts/openapi-paths-to-hugo-data/` - OpenAPI to Hugo data converter
- Generates per-endpoint path fragments for AI agent access
- Creates Hugo content pages with `type: api` frontmatter
## AI Agent Accessibility
- Full specs at `/openapi/influxdb-{product}.yml` and `.json`
- Per-endpoint fragments at `/openapi/influxdb-{product}/paths/`
- `<link rel="alternate">` tags in HTML for machine discovery
## Scalar Features
- Dark/light theme support synchronized with site theme
- InfluxData brand colors
- Responsive layout
- Download link for OpenAPI spec
## Products Supported
- cloud-v2, oss-v2
- influxdb3-core, influxdb3-enterprise
- cloud-dedicated, cloud-serverless, clustered
Usage: node api-docs/scripts/dist/generate-openapi-articles.js [product]
* feat(llms): LLM-friendly Markdown, ChatGPT and Claude links.
This enables LLM-friendly documentation for entire sections,
allowing users to copy complete documentation sections with a single click.
Lambda@Edge now generates .md files on-demand with:
- Evaluated Hugo shortcodes
- Proper YAML frontmatter with product metadata
- Clean markdown without UI elements
- Section aggregation (parent + children in single file)
The llms.txt files are now generated automatically during build from
content structure and product metadata in data/products.yml, eliminating
the need for hardcoded files and ensuring maintainability.
**Testing**:
- Automated markdown generation in test setup via cy.exec()
- Implement dynamic content validation that extracts HTML content and
verifies it appears in markdown version
**Documentation**:
Documents LLM-friendly markdown generation
**Details**:
Add gzip decompression for S3 HTML files in Lambda markdown generator
HTML files stored in S3 are gzip-compressed but the Lambda was attempting
to parse compressed data as UTF-8, causing JSDOM to fail to find article
elements. This resulted in 404 errors for .md and .section.md requests.
- Add zlib gunzip decompression in s3-utils.js fetchHtmlFromS3()
- Detect gzip via ContentEncoding header or magic bytes (0x1f 0x8b)
- Add configurable DEBUG constant for verbose logging
- Add debug logging for buffer sizes and decompression in both files
The decompression adds ~1-5ms per request but is necessary to parse
HTML correctly. CloudFront caching minimizes Lambda invocations.
Await async markdown conversion functions
The convertToMarkdown and convertSectionToMarkdown functions are async
but weren't being awaited, causing the Lambda to return a Promise object
instead of a string. This resulted in CloudFront validation errors:
"The body is not a string, is not an object, or exceeds the maximum size"
**Troubleshooting**:
- Set DEBUG for troubleshooting in lambda
* feat(llms): Add build-time LLM-friendly Markdown generation
Implements static Markdown generation during Hugo build.
**Key Features:**
- Two-phase generation: HTML→MD (memory-bounded), MD→sections (fast)
- Automatic redirect detection via file size check (skips Hugo aliases)
- Product detection using compiled TypeScript product-mappings module
- Token estimation for LLM context planning (4 chars/token heuristic)
- YAML serialization with description sanitization
**Performance:**
- ~105 seconds for 5,000 pages + 500 sections
- ~300MB peak memory (safe for 2GB CircleCI environment)
- 23 files/sec conversion rate with controlled concurrency
**Configuration Parameters:**
- MIN_HTML_SIZE_BYTES (default: 1024) - Skip files below threshold
- CHARS_PER_TOKEN (default: 4) - Token estimation ratio
- Concurrency: 10 workers (CI), 20 workers (local)
**Output:**
- Single pages: public/*/index.md (with frontmatter + content)
- Section bundles: public/*/index.section.md (aggregated child pages)
**Files Changed:**
- scripts/build-llm-markdown.js (new) - Main build script
- scripts/lib/markdown-converter.cjs (renamed from .js) - Core conversion
- scripts/html-to-markdown.js - Updated import path
- package.json - Updated exports for .cjs module
Related: Replaces Lambda@Edge on-demand generation (5s response time)
with build-time static generation for production deployment.
feat(deploy): Add staging deployment workflow and update CI
Integrates LLM markdown generation into deployment workflows with
a complete staging deployment solution.
**CircleCI Updates:**
- Switch from legacy html-to-markdown.js to optimized build:md
- 2x performance improvement (105s vs 200s+ for 5000 pages)
- Better memory management (300MB vs variable)
- Enables section bundle generation (index.section.md files)
**Staging Deployment:**
- New scripts/deploy-staging.sh for local staging deploys
- Complete workflow: Hugo build → markdown gen → S3 upload
- Environment variable driven configuration
- Optional step skipping for faster iteration
- CloudFront cache invalidation support
**NPM Scripts:**
- Added deploy:staging command for convenience
- Wraps deploy-staging.sh script
**Documentation:**
- Updated DOCS-DEPLOYING.md with comprehensive guide
- Merged staging/production workflows with Lambda@Edge docs
- Build-time generation now primary, Lambda@Edge fallback
- Troubleshooting section with common issues
- Environment variable reference
- Performance metrics and optimization tips
**Benefits:**
- Manual staging validation before production
- Consistent markdown generation across environments
- Faster CI builds with optimized script
- Better error handling and progress reporting
- Section aggregation for improved LLM context
**Usage:**
```bash
export STAGING_BUCKET="test2.docs.influxdata.com"
export AWS_REGION="us-east-1"
export STAGING_CF_DISTRIBUTION_ID="E1XXXXXXXXXX"
yarn deploy:staging
```
Related: Completes build-time markdown generation implementation
refactor: Remove Lambda@Edge implementation
Build-time markdown generation has replaced Lambda@Edge on-demand
generation as the primary method. Removed Lambda code and updated
documentation to focus on build-time generation and testing.
Removed:
- deploy/llm-markdown/ directory (Lambda@Edge code)
- Lambda@Edge section from DOCS-DEPLOYING.md
Added:
- Testing and Validation section in DOCS-DEPLOYING.md
- Focus on build-time generation workflow
* feat: Add Rust HTML-to-Markdown prototype
Implements core markdown-converter.cjs functions in Rust for performance comparison.
Performance results:
- Rust: ~257 files/sec (10× faster)
- JavaScript: ~25 files/sec average
Recommendation: Keep JavaScript for now, implement incremental builds first.
Rust migration provides 10× speedup but requires 3-4 weeks integration effort.
Files:
- Cargo.toml: Rust dependencies (html2md, scraper, serde_yaml, clap)
- src/main.rs: Core conversion logic + CLI benchmark tool
- benchmark-comparison.js: Side-by-side performance testing
- README.md: Comprehensive findings and recommendations
* fix(ui): improve dropdown positioning on viewport resize
- Ensure dropdown stays within viewport bounds (min 8px padding)
- Reposition dropdown on window resize and scroll events
- Clean up event listeners when dropdown closes
* chore(deps): add remark and unified packages for markdown processing
Add remark-parse, remark-frontmatter, remark-gfm, and unified for
enhanced markdown processing capabilities.
* fix(edge): add return to prevent trailing-slash redirect for valid extensions
Without the return statement, the Lambda@Edge function would continue
executing after the callback, eventually hitting the trailing-slash
redirect logic. This caused .md files to redirect to URLs with trailing
slashes, which returned 404 from S3.
* fix(md): add built-in product mappings and full URL support
- Add URL_PATTERN_MAP and PRODUCT_NAME_MAP constants directly in the
CommonJS module (ESM product-mappings.js cannot be require()'d)
- Update generateFrontmatter() to accept baseUrl parameter and construct
full URLs for the frontmatter url field
- Update generateSectionFrontmatter() similarly for section pages
- Update all call sites to pass baseUrl parameter
This fixes empty product fields and relative URLs in generated markdown
frontmatter when served via Lambda@Edge.
* feat(md): add environment flag for base URL control
Add -e, --env flag to html-to-markdown.js to control the base URL
in generated markdown frontmatter. This matches Hugo's -e flag behavior
and allows generating markdown with staging or production URLs.
Also update build-llm-markdown.js with similar environment support.
* feat(md): add Rust markdown converter and improve validation
- Add Rust-based HTML-to-Markdown converter with NAPI-RS bindings
- Update Cypress markdown validation tests
- Update deploy-staging.sh with force upload flag
* deploy-staging.sh:
- Defaults STAGING_URL to https://test2.docs.influxdata.com
if not set
- Exports it so yarn build:md -e staging can use it
- Displays it in the summary
* Delete scripts/prototypes/rust-markdown/benchmark-comparison.js
* Delete scripts/prototypes directory
* fix(llms): Include full URL for section page Markdown and list of child pages
* feat(llms): clarify format selector text for AI use case
Update button and dropdown text to make the AI/LLM purpose clearer:
- Button: "Copy page for AI" / "Copy section for AI"
- Sublabel: "Clean Markdown optimized for AI assistants"
- Section sublabel: "{N} pages combined as clean Markdown for AI assistants"
Cypress tests updated and passing (13/13).
---------
Co-authored-by: Scott Anderson <scott@influxdata.com>
* feat(plugins): add automated plugin documentation sync workflow
- Add GitHub Actions workflow for syncing plugin docs from influxdb3_plugins
- Create issue template for triggering sync requests
- Add Node.js transformation script (port_to_docs.js) with ES modules
- Add mapping configuration (docs_mapping.yaml) for all official plugins
- Add npm scripts for plugin sync operations
- Include comprehensive documentation in helper-scripts/influxdb3-plugins/README.md
The workflow provides:
- Issue-triggered automation with no cross-repo secrets required
- Validation of source READMEs against template requirements
- Content transformation with Hugo shortcodes and GitHub URLs
- Screenshot generation for visual validation
- Automatic PR creation with detailed change summaries
* Updated source paths in docs_mapping.yaml to use ./influxdb3_plugins/ instead of ../influxdb3_plugins/ to match what the
GitHub Actions workflow expects when it clones the
repository:
1. GitHub Actions workflow clones to ./influxdb3_plugins/
2. docs_mapping.yaml references
./influxdb3_plugins/influxdata/[plugin]/README.md
3. Local development can manually clone the repo to the same
location for testing
Tupdated all the source paths in
docs_mapping.yaml to use ./influxdb3_plugins/ instead of
../influxdb3_plugins/. This now matches exactly what the
GitHub Actions workflow expects when it clones the
repository.
The paths are now consistent:
1. GitHub Actions workflow clones to ./influxdb3_plugins/
2. docs_mapping.yaml references
./influxdb3_plugins/influxdata/[plugin]/README.md
3. Local development can manually clone the repo to the same
location for testing
This resolves the inconsistency and makes the automation
more reliable. For local development, developers would
just need to run:
git clone
https://github.com/influxdata/influxdb3_plugins.git
From the docs-v2 root directory, and then they can use the
same paths that the automation uses.
* Updated source paths in docs_mapping.yaml to use ./influxdb3_plugins/ instead of ../influxdb3_plugins/ to match what the
GitHub Actions workflow expects when it clones the
repository:
1. GitHub Actions workflow clones to ./influxdb3_plugins/
2. docs_mapping.yaml references
./influxdb3_plugins/influxdata/[plugin]/README.md
3. Local development can manually clone the repo to the same
location for testing
Tupdated all the source paths in
docs_mapping.yaml to use ./influxdb3_plugins/ instead of
../influxdb3_plugins/. This now matches exactly what the
GitHub Actions workflow expects when it clones the
repository.
The paths are now consistent:
1. GitHub Actions workflow clones to ./influxdb3_plugins/
2. docs_mapping.yaml references
./influxdb3_plugins/influxdata/[plugin]/README.md
3. Local development can manually clone the repo to the same
location for testing
This resolves the inconsistency and makes the automation
more reliable. For local development, developers would
just need to run:
git clone
https://github.com/influxdata/influxdb3_plugins.git
From the docs-v2 root directory, and then they can use the
same paths that the automation uses.
* Jmercer/plugin sync test (#6468)
* fix: update workflow branch references from master to main
* fix: update issue template branch references from master to main
- Update sync-plugin-docs.yml description (line 40)
- Update placeholder from 'master' to 'main' (line 41)
- Update default value from 'master' to 'main' (line 42)
- Add influxdb3_plugins/ to .gitignore
- Ensures template matches influxdb3_plugins default branch
* Update .gitignore
---------
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
* Update docs_mapping.yaml
* Apply suggestion from @Copilot
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Apply suggestion from @jstirnaman
* Apply suggestion from @jstirnaman
* Apply suggestion from @jstirnaman
* Apply suggestion from @jstirnaman
* Use <docs-root>/.ext/influxdb3_plugins for the source path
---------
Co-authored-by: Jameelah Mercer <36314199+MeelahMe@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Creates an interactive InfluxDB version detector component in TypeScript and a shortcode that generates a button to trigger
the version detector modal.
The shortcode takes a parameter that displays a predefined set of links for results.
- Support URL pattern matching and ping header analysis
- Add questionnaire-based product identification logic
- Adds the shortcode in a note in /influxdb3/core/visualize-data/grafana/
- Set up TypeScript configuration for the project
- Configure automatic TypeScript compilation in pre-commit hooks
- Add to Grafana documentation pages
- Remove last remnants of old Cypress link checker
- Add Cypress tests, but many are still broken
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Update layouts/shortcodes/influxdb-version-detector.html
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Update assets/js/influxdb-version-detector.ts
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Update assets/styles/components/_influxdb-version-detector.scss
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Fixes:
- Fix Hugo template to include product names in detector config
- Change elimination scores from -100 to -1000 for proper filtering
- Add scoring logic for generic "InfluxDB" product (OSS v2.x)
- Exclude generic "InfluxDB" from results (too vague)
- Add comprehensive test scenario checklist to Cypress tests
- Free license now correctly excludes Enterprise, Clustered, Dedicated
- Self-hosted now correctly excludes all Cloud products
- SQL language now correctly excludes v1 and v2 products
- Results now show only specific products (OSS 1.x, OSS 2.x, etc.)
Changes:
- When users answer "I'm not sure" to all questions, show a helpful
message directing them to the reference table instead of showing
a weak ranking with low confidence.
- Detect when all questionnaire answers are "unknown"
- Display custom message explaining lack of information
- Auto-expand reference table for easy product identification
- Hide ranked results when insufficient information provided
- Make product names clickable in the quick reference table to allow
users to quickly navigate to product documentation after identifying
their InfluxDB version.
chore(ci): Replaced PR link validation workflow with new workflow from docs-tooling/link-checker/.github-workflows-link-check.yml
chore: organize .gitignore
test: add content to trigger link-checker workflow
This small change tests the pr-link-check.yml workflow
feat: update link-checker workflow and documentation
- Add production config with corrected User-Agent placement
- Remove old link validation actions (replaced by link-checker)
fix: update link-checker workflow configuration
- Update Node.js version to 20 for dependency compatibility
feat: use pre-built link-checker binary from docs-tooling releases
- Replace building from source with downloading from releases
- Use GitHub API to get latest release and binary
- Maintain same artifact structure for downstream job
fix: improve change detection in pr-link-check workflow
- Use GitHub API for reliable PR file detection
- Add debug output to show all changed files
- Fix conditional logic for when jobs should run
docs: update TESTING.md with binary distribution and automated GitHub Actions integration
- Document pre-built binary download as recommended installation method
- Explain automated PR link checking workflow for docs-v2
- Replace manual GitHub Actions example with automated integration details
- Remove exaggerated language and specify actual exclusion types
fix(ci): download link-checker binary from docs-v2 releases
- Change binary source from private docs-tooling to public docs-v2 releases
- Fixes GitHub Actions permission issues accessing private repos
- Binary is now stored as a release asset on docs-v2 itself
test: add test file with valid links to verify workflow passes
test: remove temporary test file for link checker workflow
The test file was only needed to verify the workflow functionality
and should not be part of the documentation.
docs: update TESTING.md to document docs-v2 binary distribution
- Change primary installation method to download from docs-v2 releases
- Explain that binary distribution enables reliable GitHub Actions access
- Update automated workflow description to reflect docs-v2 release usage
- Maintain build-from-source as alternative option
refactor(ci): combine workflow into single job for cleaner PR display
- Merge detect-changes, build-site, and download-link-checker into single job
- All setup steps now run conditionally within one job
- Cleaner PR display shows only 'Check links in affected files'
- Maintains all functionality with improved UX
fix(ci): exclude problematic URLs from link checking
- Add reddit.com exclusions (blocks bots)
- Add support.influxdata.com exclusion (SSL certificate issues in CI)
- Prevents false positive failures in automated link checking
- Build resources if not cached
- Ensure node_modules dependencies are available for asset processing
- Be more precise in the template when building assets in production mode and avoid conflicts with SCSS and CSS processing.
- Ignore node_modules when loading source maps
- Add .vscode/launch.json with debugging configuration for localhost:1313. In VSCode, go to Run and select the site to launch Chrome, connect to Developer Tools, and start debugging.
- **Environment variable formatting** - Updated environment variable configuration from array format to object format to comply with Lefthook schema validation requirements.
- **Unified link testing** - Consolidated multiple product-specific link testing commands into a single `e2e-links` command that processes all staged Markdown and HTML files across content directories.
- **Package script integration** - Modified commands to use centralized yarn scripts instead of direct execution, improving maintainability and consistency.
- **Source information extraction** - Enhanced to correctly extract and report source information from frontmatter.
- **URL and source mapping** - Improved handling of URL to source path mapping for better reporting.
- **Ignored anchor links configuration** - Added proper exclusion of behavior-triggering anchor links (like tab navigation) to prevent false positives.
- **Request options correction** - Fixed Cypress request options to ensure `failOnStatusCode` is properly set when `retryOnStatusCodeFailure` is enabled.
- **Improved error reporting** - Enhanced error reporting with more context about broken links.
- **New test scripts added** - Added centralized testing scripts for link checking and codeblock validation.
- **Product-specific test commands** - Added commands for each product version (InfluxDB v2, v3 Core, Enterprise, Cloud, etc.).
- **API docs testing** - Added specialized commands for testing API documentation links.
- **Comprehensive test runners** - Added commands to run all tests of a specific type (`test:links:all`, `test:codeblocks:all`).
- Fix Docker build command and update CONTRIBUTING.
chore(js): JavaScript QoL improvements:
- Refactor main.js with a componentRegistry object and clear initialization of components and globals
- Add a standard index.js with all necessary exports.
- Update javascript.html to use the index.js
- Remove jQuery script tag from header javascript.html (remains in footer)
- Update package file to improve module discovery.
- Improve Hugo and ESLint config for module discovery and ES6 syntax
- Adds InfluxDB 3 Core API reference
- Updates scripts
- Removes non-valid info.summary field from specs, replaces with description in metadata
- Simplifies frontmatter generation for HTML template
- Reorg of file structure to mirror the content structure.
- Moves OSS v2 into v2/v2/ref.yml to follow the same pattern as others
- Replaces isDefault API config field with specific aliases.
- Misc. fixes.
- Remove generated HTML files.
- Adds basic support for core and enterprise in getswagger.sh
- Adds custom OpenAPI info for Core and Enterprise
- Validates as OpenAPI 3.0 (using Spectral)
- operationId
- tags
- Revises use of Legacy, v2
- TODO: need to check and validate in UI, adjust tags if nec.
- Add and remove components
- Update parameters
- Add examples
- Add tests for Core
- Pre-commit hook:
- Redo test harness so commands can run in parallel
- Cleanup Vale command args
- Replace lint-staged and husky with Lefthook.
- Pre-push hook:
- Scan for package vulnerabilities
- Tests
- Run tests on demand, in parallel, or debugged using docker compose up, run, exec, etc.
- Each test container (service) runs the prepare-content script before running tests.
- Return to using Python instead of Docker to provide environment variables so they don't get exposed in Docker inspect.
- Bind mount influxctl config.toml and .env.test files
- Bind mount scripts for faster builds while iterating on test scripts.
- Vale:
- Override Acronyms style def--ignore acronym if it's linked.
- Reconfigures prettier linting.
- Adds .editorconfig to help with consistent editor settings
- Refactors test runs:
- Removes test configuration from compose.yaml (not suited for this use case).
- Splits test runner into test content setup and pytest that can be run separately or together (and with other test runners in the future).
- Configuration is in Dockerfiles and command line (`.lintstagedrc.mjs`)
- Updates CONTRIBUTING.md
- Updates client library write examples in cloud-dedicated and clustered.
* - Add tutorial that guides a developer through building a simplified IoT
center app with client libraries.
- device registration and authorization.
- write and query--explain batch writes with the JS client library.
* - feat: queries and visualizations with Giraffe library. queryToTable, Giraffe table.
* feat(api-guide): revise intro, auth, example headings.
* feat(api-guide): describe resources. describe auth and API tokens.
- API basics
* fix: influxdb and iot center setup
* fix: update registration steps to include the new INFLUX_BUCKET_AUTH flow.
* feat(api-guides): Add client library example to fetch routes.
- install, links.
- replace use of getIoTAuthorizations with query from getDevices.
- breakdown create device API requests.
- initial commit of API guide using Next.js with Influx client libraries. Project source at https://github.com/jstirnaman/nextjs-iot-starter.
- explain the flow to register a device. Remove unused example code. TODO: document the setup and UI.
- Add UI code samples. Revise headings. Explain API purpose.
- UI component fixes and refactor. Input field takes a device ID, queries, and re-renders the list with results. Registration button submits device ID for a new authorization.
* feat(api-guide): add iot-starter guide index page, fix errors
- add the iot-starter directory and index page
- fix tag errors and links.
* feat: IoT starter navigation.
* feat(api-guide): nav and intros.
* wip: rearrange, move full examples to top of section and link to explainers.
* chore: Shared intro shortcode for iot-starter tutorials.
* fix: intros, navigation, and config instruction
- Add intro shortcode for tutorials to share.
- Organize navigation for language-specific tutorials (would prefer to unify as much as possible).
- Update environment variable config instruction.
* Feature/api guide python client (#4023)
* adding placeholders into code
* create_device not tested yet
* everything working except flux query and filter query
* fix: replace download button with spec link. (#4013)
- Closes#3810 - Remove download button and add a link to the spec source in Github.
* Enterprise 1.9.7 release notes (#4007)
* added not under flux updates
* updates based on feedback
* changed release notes date
* added requested update
* added detail about script builder (#3995)
* added detail about script builder
* Update content/chronograf/v1.9/guides/querying-data.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix: async writes and deletes (#4015)
- Correct handling of writes and deletes in cloud vs. oss (async vs. sync).
- Cleanup redundancy in Troubleshooting.
- Closes https://github.com/influxdata/DAR/issues/291
Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
* Collect user feedback per page and restructure modals (#4014)
* WIP feedback forms
* WIP complete feedback lifecycles
* finalize page feedback interactions
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Revert "Enterprise 1.9.7 release notes (#4007)" (#4017)
This reverts commit c6f4a99d72.
* hotfix: fix cli homebrew package name, closes#4022
* docs: add python iot guide
* fix: remove .idea files
* fix: remove .idea files and package-lock
* fix: initial batch of fixes
* fix: finished PR changes
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/api-guide/iot-starter/python.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/api-guide/iot-starter/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Delete _index.md
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MBP.lan>
* chore: replace UI code with GH links, fix navigation.
* feat: API client library tutorials
- Cleanup py and js tutorials.
- JS is still WIP.
- Fix nav.
* fix: Revise Node.js tutorial.
* fix: Revise Python tutorial.
* fix: Remove last bullet since Node.js tutorial isn't that far yet.
* Update content/influxdb/v2.2/api-guide/tutorials/client-library-starter/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/api-guide/tutorials/client-library-starter/nodejs.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* wip: Install and run the UI.
* docs: fix instructions and move UI docs to iot-api-ui README.
* fix: Update JS and Py tutorials with common UI.
* fix: Update code samples in nodejs and python IoT starter tutorials.
* fix: fixup.
* fix: Cleanup code tabs.
* fix: update toc
* fix: iot-starter
Fix examples.
Cleanup.
* fix: python restart
* fix: Cleanup.
* chore: add repo links
* Add cloud, fix frontmatter.
* fix: Remove links to sections.
Co-authored-by: sunbryely-influxdata <101659702+sunbryely-influxdata@users.noreply.github.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MBP.lan>
* feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233).
* feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters.
* feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet.
* feat: rename example function for simplicity since there's no GET for now.
* feat: add find_and_update example (#2547).
* feat: add update example. Clarify, expand invoke example. Add links. (#2547)
* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix: remove accidental commit of generated redoc-static.html
* feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml.
* fix: replace /functions with /scripts
* feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml
* feat: invocable scripts (#2547)
* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* feat: new section for params (#2547).
* fix: swagger server url (#2547)
* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* feat: remove jq and function where there's no clear need.
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Security & auth
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* split content for notification endpoints
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* removed product tags from nav and articles
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Security & auth
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* split content for notification endpoints
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* removed product tags from nav and articles
* New URL switcher (#1720)
* restructured url modal
* rearchitected the url switcher functionality
* add influxdb preference management to url switcher
* create separate pages for querying data
* update weight
* Update flux-repl.md
* Update influx-query.md
* edits f Scott
* move content from explore-metrics to data-explorer
* edits; delete explore-metrics
* edits
* delete file
* remove duplicate content
* add InfluxQLquery examples
* Remove references to "security script"
* draft updates for Band Plot vis
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Security & auth
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* split content for notification endpoints
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* removed product tags from nav and articles
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* split content for notification endpoints
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* New URL switcher (#1720)
* restructured url modal
* rearchitected the url switcher functionality
* add influxdb preference management to url switcher
* URL validation on custom URL (#1763)
* added url validation to custom url form, resolves#1739
* removed placeholder message from custom url form
* updated styles for url selector modal
* Move restore command to `influx` cli, update flags
* Update table for backup
* Remove RC information, update paths for restore, change `backup-path` flag to `input`
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Security & auth
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* split content for notification endpoints
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* removed product tags from nav and articles
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* New URL switcher (#1720)
* restructured url modal
* rearchitected the url switcher functionality
* add influxdb preference management to url switcher
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* WIP separate cloud docs, duplicate content shortcode
* WIP cloud-separation
* WIP separate cloud
* duplicated oss into cloud and am making updates
* moved cloud updates to cloud
* reimplemented duplicate-oss shortcode
* separate Cloud and OSS content in Tools & integ...
* Split OSS and Cloud content for Manage org
* Split OSS and Cloud - Manage Orgs add'l updates
* various updates, primarily in oss and cloud reference
* Move InfluxQL doc to Cloud
- Remove the "Query with InfluxQL" page from OSS docs
- Re-incorporate changes made in https://github.com/influxdata/docs-v2/pull/1506
* URL validation on custom URL (#1763)
* added url validation to custom url form, resolves#1739
* removed placeholder message from custom url form
* updated styles for url selector modal
* WIP updating InfluxDB OSS naming throughout
* updated canonical shortcode for oss vs cloud, updated 2.0 version numbers on homepage
* updated swagger file to rc4 for 2.0 and cloud
* fixed canonical partial
* Update multi-user Cloud docs
Also adds a heading the note on permissions.
Closes#1764
* Fix table for backup flags
* Update input flag, remove TSI references
* Address PR feedback
* Remove product tag
* Fix DBRP mapping examples (#1776)
* updated dbrp mapping examples in influxql query guide, closes#1774
* removed unnecessarily escaped newline from dbrp mapping example
* add draft rc4 and GA RNs
* cloud and oss name updates
* emphasis production ready
* update curl example
* duplicate oss pages in cloud
* Address PR feedback
* added new aws us east region, resolves#1777 (#1782)
* Add steps for script editor
* Add cloud version
* moved and updated upgrade guides (#1783)
* Fix typos
* update upgrade links
* edits
* Clarify 1m cardinality is initial limit only
* fix typo
* fix date
* Add note on `_internal` database to v1-to-v2 upgrade guide
Closes#1775.
* Update influxdb.md
* fixed broken links throughout cloud docs
* fixed broken links in 2.0 oss
* Address PR feedback
* remove window pushdowns
* updated oss pushdown list
* Add instructions for verifying InfluxDB 2.0 download
* updated latest versions in edge.js
* added flux-0.94.0 to flux release notes (#1790)
* update date and add Flux .94.0 link
* delete broken link to image
* remove auto refresh; not currently in UI
* add duplicate-oss tag to Cloud execute-queries
* highlight diff between Flux and InfluxQL example
* delete extra header
* Generate v1 compatibility API docs (#1789)
* updated swagger generation to generate v1 compat api docs
* restructured api docs
* updated restore flags table
* updated infludb binary urls in oss and cloud
* Address PR feedback
* Make contact support a mailto link
* Add --log-level flag to `influxd upgrade`
Closes#1795
* add release note about api/v2/delete
* update delete data note for 2.0
* edit
* Fix URLs and filenames in OSS 2.0 Get Started
* update version for GA
* Add color to Flux example for Flux documentation (addresses #1724 )
* Change versions to 2.0.1 in GS
* Replace 2.0.0 with 2.0.1
* Revert Docker updates to 2.0.0
* Add release notes for 2.0.0
* edits; add known issue
* clarify DB is 1.x
* updated influxdb versions in cloud and oss getting started
* updated influxdb oss urls doc
* remove rc and upd upgrade link in back up data
* Edit `influxd upgrade` docs (#1798)
* Edit `influxd upgrade` guide
Major revision of existing docs.
Add "Before you begin: important considerations" section.
* Address PR feedback
* Edit backup instructions
* More work on kap
* Rm comment
* Rm sentence
* Add note on Docker
* Edit intro
* Edit link
* Work on PR feedback
* Continue PR feedback
* More PR feedback
* More edits
* more edits
* Edits
* more edits
* rm word
* updates to address PR feedback for the upgrade guide
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Kelly <kelly@influxdata.com>
Co-authored-by: pierwill <pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Jason Stirnaman
Jason Stirnaman
Scott Anderson
Scott Anderson
Gunnar Aasen