Commit Graph

50 Commits (create-your-own-docs-tutorial)

Author SHA1 Message Date
Jason Stirnaman 56b459659d
Jts agentsmd (#6486)
* feat(docs): add content scaffolding system with AI-powered analysis

Add yarn docs:create command for intelligent content scaffolding:

- Phase 1: Script analyzes draft and repository structure
- Phase 2: Claude command generates file structure and frontmatter
- Phase 3: Script creates files from proposal

New files:
- scripts/docs-create.js: Main orchestration script
- scripts/lib/content-scaffolding.js: Core scaffolding logic
- scripts/lib/file-operations.js: File I/O utilities
- .claude/commands/scaffold-content.md: Claude analysis command

Features:
- Intelligent product detection (Core, Enterprise, Cloud, etc.)
- Generates complete frontmatter
- Dry-run and interactive confirmation modes

Usage:
  yarn docs:create --from path/to/draft.md
  /scaffold-content
  yarn docs:create --execute

* chore(scripts): docs:create and docs:edit scripts for content creation and editing
2025-10-28 07:20:13 -05:00
Jason Stirnaman 20562d5bb6
Automate plugin documentation sync workflow between influxdb3_plugins and docs-v2 (#6329)
* 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>
2025-10-20 17:18:34 -05:00
Jason Stirnaman e93e78be0a feat(influxdb): Version detector shortcode triggers a modal
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.
2025-09-30 19:01:21 -05:00
dependabot[bot] 2b7aa74814
chore(deps): bump axios from 1.11.0 to 1.12.0
Bumps [axios](https://github.com/axios/axios) from 1.11.0 to 1.12.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v1.11.0...v1.12.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-version: 1.12.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-12 21:50:51 +00:00
dependabot[bot] 73bb35d4de
chore(deps): bump mermaid from 11.9.0 to 11.10.0
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 11.9.0 to 11.10.0.
- [Release notes](https://github.com/mermaid-js/mermaid/releases)
- [Commits](https://github.com/mermaid-js/mermaid/compare/mermaid@11.9.0...mermaid@11.10.0)

---
updated-dependencies:
- dependency-name: mermaid
  dependency-version: 11.10.0
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-20 14:42:57 +00:00
Jason Stirnaman 3f4ad5fb37 chore(scripts): redo cli audit script:
Moved to new tooling repo.
Removed package scripts for now.

Script Gets commands from source code and grep docs for commands- replaces the CLI audit script- searches tagged repo branch source code for CLI commands- searches docs content the commands- allows including and excluding "categories" of docs paths to search
2025-08-19 09:59:31 -05:00
Jason Stirnaman a8578bb0af chore(ci): Removes old Cypress link checker test code 2025-08-18 10:51:57 -05:00
dependabot[bot] 57f52ed863
chore(deps): bump axios from 1.10.0 to 1.11.0
Bumps [axios](https://github.com/axios/axios) from 1.10.0 to 1.11.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v1.10.0...v1.11.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-version: 1.11.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-07-25 16:55:42 +00:00
Jason Stirnaman fb743d70e3 chore(qol): Restructure CONTRIBUTING.md and improve agent instructions:
- control what content gets processed by adding the
  appropriate tags in CONTRIBUTING.md--for example:\

  - <!-- agent:instruct: essential --> - Keep all content
  - <!-- agent:instruct: condense --> - Summarize to key points
  - <!-- agent:instruct: remove --> - Skip entirely

- rename and move script to helper-scripts
2025-07-09 15:39:51 -05:00
Jason Stirnaman c74060210b chore(ci): Audit documentation for changes to influxdb3 CLI. Configures a GitHub release workflow to generate release notes and run the audit documentation script. 2025-07-07 12:13:36 -05:00
Jason Stirnaman 4973026adf Merge pull request #6079 from influxdata/chore-js-refactor-footer-scripts-modules
Chore: JavaScript: refactor footer scripts modules
2025-06-09 14:40:37 -05:00
Jason Stirnaman f819f48de9
Revert "Chore: JavaScript: refactor footer scripts modules" 2025-06-05 09:46:37 -05:00
Jason Stirnaman 95ab1a1430 chore(js): Remove unnecessary JS module config, remove redundant index.js 2025-06-02 15:14:45 -05:00
Jason Stirnaman 5da0442727 chore(qol): Build custom CoPilot instructions from CONTRIBUTING.md:
- Add a script and pre-commit command to generate a CoPilot instructions file  from CONTRIBUTING.md guidelines.
- Add custom instructions for CoPilot to help with influxdb3 placeholders
2025-05-27 10:33:12 -05:00
Jason Stirnaman 1dce052e56 fix(JS): Rename CommonJS scripts to .cjs extension, keep type: module as the project default. Update and fix ESLint configuration.
- Renames JavaScript files in flux-build-scripts and api-docs/openapi/plugins to .cjs file extension to declare them as CommonJS module syntax.
2025-05-19 11:34:42 -05:00
Jason Stirnaman da767f5228 chore(test): e2e test improvements:
- Link checker should report the first broken link
- Link checker should only test external links if the domains are in the allowed list
- If test subjects don't start with 'content/', treat them as URL paths and don't send them to map-files-to-urls.js.
2025-05-19 09:55:06 -05:00
Jason Stirnaman 4cfff239f3 End-to-end testing, CI script, and JavaScript QoL improvements:
- **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
2025-05-19 09:50:33 -05:00
Jason Stirnaman 9755033970 chore(ci): closes #5887 Improve and automate pre-commit link-checking 2025-03-13 14:24:36 -05:00
Jason Stirnaman 38c9b6d5ef fix(clustered): set up clustered for air-gapped environments, add instructions for copying and installing the kubit CLI image to the environment, and for Helm, copy the kubit operator images. Closes https://github.com/influxdata/DAR/issues/484 2025-03-11 12:38:33 -05:00
Jason Stirnaman 0b7b73b8f7 fix(ci): Remove Nightwatch dependency 2025-02-25 17:09:32 -06:00
Jason Stirnaman 4314589c07 feat(v3): WIP: Revise API specs for Core and Enterprise
- 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
2025-02-25 17:08:05 -06:00
meelahme 9084233a0c enforced serialize-javascript@^6.0.2 via resolutions 2025-02-19 14:32:00 -08:00
Jason Stirnaman b5cda5ce15 hotfix(api): update header back link for new product structure 2025-02-19 16:06:25 -06:00
Jason Stirnaman 3abf1c506d chore: resolve conflicts 2025-02-14 09:39:44 -06:00
Jason Stirnaman cd3ad9e0a1 chore: Update and resolve yarn.lock 2025-02-12 13:52:06 -06:00
Jason Stirnaman 9947c72495 chore(e2e): Add Cypress for link checking and end-to-end tests. Fix broken links revealed by tests.
- Adds Cypress and a few basic tests for the global topnav, the home page, and link-checking.
- For link-checking, pass a comma-delimited list of URLs in an exported cypress_test_subjects environment variable. For examples, see the convenience commands in package.json
2025-02-12 13:48:30 -06:00
Jason Stirnaman c173edce68 Initial Kapa.ai chat integration.
Continue refactoring JavaScript into a component pattern and ESM.
Replaces some jQuery with native DOM API.

chore(ai): reference documentation and instructions for training AI

chore(ai): implement Kapa AI chat widget
- Move script tag to HTML template to make it obvious.
- Cleanup javascript to make it more component-like
- Set Kapa attributes, support setting userid

chore(js): add JS dependencies, previously referenced in script tags, to package.json for JS builds.

fix(api): indents

chore(js): package Mermaid diagram library

chore(js): refactor JS for AIChat and Theme as examples of using the component pattern for HTML/CSS/JS

chore(js): Use the new local-storage API in refactored module code and in code not yet ported. Cleanup syntax in local-storage and make functions available from window.LocalStorageAPI.

fix(js): theme.js name-change

chore(js): fix ai-chat.js file name

fix(js): refactor:
- componentNames are snakecase in HTML
- replace DOM selection method and jQuery eventhandler assignment
- remove old theme.js references

chore(ai): configure chat window overlay, size, and position:
- removes overlay and scroll lock
- positions chat to the right and bottom
- expands sample question width to 12 cols

chore(ai): edit disclaimer

fix(ai): size and position

chore(js): make ai-chat specific to configuration and and setting userid (for testing and future use).

fix(js): copy referrerHost variable to v3-wayfinding instead of relying on influxdb-url to assign it.

chore(ai): add a footer div at page bottom to contain modal triggers for custom-time and ask-ai. Still needs some CSS help. Moves tooltip text from CSS to HTML data attribute.

chore(ai): dynamically load AI script tag after DOMContentLoaded to avoid race conditions. Call initialization from the modal trigger module and pass the show trigger function to the onload handler.

fix(ai): fix modal triggers to viewport

fix(modal-triggers): stack the triggers into a single column.

restyle footer widgets

updated time selector modal to use correct storage term

minor style update

WIP(ai-chat): get product data

chore(js): Factor out pageContext module from influxdb-url.js

chore(js): Refactor helpers.js out of inflluxdb-url.js

WIP: refactor influxdburl - minimal changes for module conversions

feat(ai): Custom AI chat example questions product and version.
Ask AI example questions:
- Adds support for customizing example Ask AI questions per product or version.
- Configure questions in site `data/products.yml`; otherwise, it uses default questions from `ask-ai.js`

Context, page, and product data:
- Adds sample URLs for remaining versions in influxdb_urls
- `page-context.js` consolidates and exports constants for page context (protocol, host, path, referrer) and path-to-data mappings for product and influxdb_url site data

Module refactor:
- Refactors some JavaScript into ES6 modules, and refactors some of those further into a Component pattern--just vanilla JS and no shadow DOM stuff. The Component pattern that uses data attributes to "bind" JavaScript modules with CSS and HTML is a popular approach in modern web development. This pattern enhances modularity, reusability, and maintainability by associating behavior (JavaScript), structure (HTML), and style (CSS) through the use of data attributes.
- `assets/main.js` is the entrypoint
- Passes pageParams from the Hugo page to modules that import `@params`.
- Moves most external dependencies out of `script` tags and into package.json to be managed with `yarn`.
- Adds `eslint`.
- For modules that aren't yet components, wraps execution statements inside an `initialize()` function and calls the function from `main.js` on `DOMContentLoaded`.
- For components, if the page contains the `data-component="<component-name>"`, the matching element is passed to the component function on `DOMContentLoaded`.
- I tried to avoid changing logic where it wasn't necessary.

Update DOC_GPT_PROFILE.md

customize ai chat modal styles

fix(influxdb-url): Rename to cloud_dedicated in influxdb_urls.yml, remove newly added placeholder URL and use the extant default, refactor
- Rename  to  in influxdb_urls.yml
- Fix influxdb-url.js and data provision in local-storage.js to use the new name, mapping it to  to retain the existing local storage key

chore(api-lib): Use local-storage import instead of window global

chore(js): cleanup

fix(js): Ensure feature-callout initializes on page load

fix(theme): Load preferred theme before making the page visible. Execute a predefined function by specifying the function name in data-theme-callback

fix(search-toggle): Restores toggling the search field when sidebar is collapsed. Moves the event handler to a new search-button component

fix(ai): Fix custom attribute assignment. Rename property to ai_example_questions

Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive). Fix TOC links.
Fixes #5781

fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content

fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly  plugin module path.

hotfix: fix hlevel bug in children shortcode

Remove underline from custom time widget

add color to custom time widget styling
2025-02-12 13:48:29 -06:00
Jason Stirnaman ef106dd3a1 chore(e2e): Add Cypress for link checking and end-to-end tests. Fix broken links revealed by tests.
- Adds Cypress and a few basic tests for the global topnav, the home page, and link-checking.
- For link-checking, pass a comma-delimited list of URLs in an exported cypress_test_subjects environment variable. For examples, see the convenience commands in package.json
2025-02-03 17:52:04 -06:00
Jason Stirnaman f9f81ae8f9 Initial Kapa.ai chat integration.
Continue refactoring JavaScript into a component pattern and ESM.
Replaces some jQuery with native DOM API.

chore(ai): reference documentation and instructions for training AI

chore(ai): implement Kapa AI chat widget
- Move script tag to HTML template to make it obvious.
- Cleanup javascript to make it more component-like
- Set Kapa attributes, support setting userid

chore(js): add JS dependencies, previously referenced in script tags, to package.json for JS builds.

fix(api): indents

chore(js): package Mermaid diagram library

chore(js): refactor JS for AIChat and Theme as examples of using the component pattern for HTML/CSS/JS

chore(js): Use the new local-storage API in refactored module code and in code not yet ported. Cleanup syntax in local-storage and make functions available from window.LocalStorageAPI.

fix(js): theme.js name-change

chore(js): fix ai-chat.js file name

fix(js): refactor:
- componentNames are snakecase in HTML
- replace DOM selection method and jQuery eventhandler assignment
- remove old theme.js references

chore(ai): configure chat window overlay, size, and position:
- removes overlay and scroll lock
- positions chat to the right and bottom
- expands sample question width to 12 cols

chore(ai): edit disclaimer

fix(ai): size and position

chore(js): make ai-chat specific to configuration and and setting userid (for testing and future use).

fix(js): copy referrerHost variable to v3-wayfinding instead of relying on influxdb-url to assign it.

chore(ai): add a footer div at page bottom to contain modal triggers for custom-time and ask-ai. Still needs some CSS help. Moves tooltip text from CSS to HTML data attribute.

chore(ai): dynamically load AI script tag after DOMContentLoaded to avoid race conditions. Call initialization from the modal trigger module and pass the show trigger function to the onload handler.

fix(ai): fix modal triggers to viewport

fix(modal-triggers): stack the triggers into a single column.

restyle footer widgets

updated time selector modal to use correct storage term

minor style update

WIP(ai-chat): get product data

chore(js): Factor out pageContext module from influxdb-url.js

chore(js): Refactor helpers.js out of inflluxdb-url.js

WIP: refactor influxdburl - minimal changes for module conversions

feat(ai): Custom AI chat example questions product and version.
Ask AI example questions:
- Adds support for customizing example Ask AI questions per product or version.
- Configure questions in site `data/products.yml`; otherwise, it uses default questions from `ask-ai.js`

Context, page, and product data:
- Adds sample URLs for remaining versions in influxdb_urls
- `page-context.js` consolidates and exports constants for page context (protocol, host, path, referrer) and path-to-data mappings for product and influxdb_url site data

Module refactor:
- Refactors some JavaScript into ES6 modules, and refactors some of those further into a Component pattern--just vanilla JS and no shadow DOM stuff. The Component pattern that uses data attributes to "bind" JavaScript modules with CSS and HTML is a popular approach in modern web development. This pattern enhances modularity, reusability, and maintainability by associating behavior (JavaScript), structure (HTML), and style (CSS) through the use of data attributes.
- `assets/main.js` is the entrypoint
- Passes pageParams from the Hugo page to modules that import `@params`.
- Moves most external dependencies out of `script` tags and into package.json to be managed with `yarn`.
- Adds `eslint`.
- For modules that aren't yet components, wraps execution statements inside an `initialize()` function and calls the function from `main.js` on `DOMContentLoaded`.
- For components, if the page contains the `data-component="<component-name>"`, the matching element is passed to the component function on `DOMContentLoaded`.
- I tried to avoid changing logic where it wasn't necessary.

Update DOC_GPT_PROFILE.md

customize ai chat modal styles

fix(influxdb-url): Rename to cloud_dedicated in influxdb_urls.yml, remove newly added placeholder URL and use the extant default, refactor
- Rename  to  in influxdb_urls.yml
- Fix influxdb-url.js and data provision in local-storage.js to use the new name, mapping it to  to retain the existing local storage key

chore(api-lib): Use local-storage import instead of window global

chore(js): cleanup

fix(js): Ensure feature-callout initializes on page load

fix(theme): Load preferred theme before making the page visible. Execute a predefined function by specifying the function name in data-theme-callback

fix(search-toggle): Restores toggling the search field when sidebar is collapsed. Moves the event handler to a new search-button component

fix(ai): Fix custom attribute assignment. Rename property to ai_example_questions

Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive). Fix TOC links.
Fixes #5781

fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content

fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly  plugin module path.

hotfix: fix hlevel bug in children shortcode

Remove underline from custom time widget

add color to custom time widget styling
2025-02-03 08:31:55 -06:00
Jason Stirnaman 946b7a1f83 chore(ci): Update axios for security patch. 2024-08-20 14:28:58 -05:00
Jason Stirnaman 37a7a7c6e7 chore(ci): Improve pre-commit hook, test harness, and linter
- 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.
2024-07-23 15:08:28 -05:00
Jason Stirnaman 922e48182a chore(ci): Improve Vale style linting:
- Run Vale in a Docker container by running ./.ci/vale/vale.sh <args>
- Define vale lint scripts in package.json. Lint added and changed files for products.
- Define error-level vale linting in the lint-staged configuration for staged files.
- Improve product-specific nomenclature checks (e.g. database vs bucket)
- Simplify vocab terms and allowed words lists.
- Fixes content errors revealed by vale.
2024-06-26 08:52:21 -05:00
Jason Stirnaman 9d542dd8d6 fix: write-data section: consistent page titles, database and table nomenclature in dedicated and clustered 2024-06-25 11:51:26 -05:00
Jason Stirnaman 5c74f013a1 chore(ci): Improve CI lint and test runners
- 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.
2024-06-21 18:41:07 -05:00
Jason Stirnaman 0209891e9c fix(ci): Set vale's minAlertLevel to error for commits 2024-05-29 18:06:18 -05:00
Jason Stirnaman 078df59a38 fix(ci): Vale format and custom vocabularies
- Revert vale JSON output to line output so that husky appropriately fails the commit.
- Update custom vocab terms
- Add Vale to BasedOnStyles to enable the custom vocabs--they need access to Vale's **Avoid** action.
2024-05-29 17:42:31 -05:00
Jason Stirnaman 8f95a26d36 chore: Remove quotes from vale command flag values 2024-05-29 17:09:03 -05:00
Jason Stirnaman 2e9d94fc90 chore(ci): configure lint-staged to run vale with custom vocabs
- Configures lint-staged to run vale on staged files and use a custom config with custom vocab for specific directories.
- .md files in other directories use the project-level .vale.ini
- Adds the write-good package for style checking
2024-05-29 16:46:51 -05:00
Jason Stirnaman 12b1583b68 chore: add test data and improve test runner:
- Pulls python client lib and CLI from Github repo instead of package repo so we can test the latest release. Specifies the last release tag.
- Adds CSV and JSON home sensor data samples to /static/downloads.
- Test image build bind mounts /static/downloads into /usr/src/app/test/tmp/data. Allows code samples to reference sample data as `./data/[file]`.
- Moves run-tests.sh to setup directory.
- Dockerfile cleanup. Add jq for inspection/troubleshooting.
2024-05-29 13:31:31 -05:00
Jason Stirnaman db059f99b0
Strategies to improve query performance: operations, number and size … (#5215)
* Strategies to improve query performance: operations, number and size of parquet files
Fixes #5108

- Add query performance strategies to optimize-queries

* Apply suggestions from code review

* Apply suggestions from code review

* Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* chore(v3): WIP query perf
Fixes #5108

* chore(v3): WIP: Query performance

* chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems.

* WIP: optimize queries - how to read a query plan, operators

* WIP: Read a query plan example 2

* WIP: moved how to read a query plan to its own page.

* WIP(v3): operators

* chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN

* chore(v3): WIP read a query plan - explain tree format and reorganize

* WIP: query plan

- Adds Query Plan reference
- Completes Analyze a Query Plan, pending cleanup, continue at :471
- Added image from Nga's blog
- Updates EXPLAIN doc
- TODO: Create public docs for
https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md

* chore(spelling): Vale config changes

- Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually.
- Move InfluxData spelling ignore list into the style.
- Reorganize custom (product) spelling lists to comply with Vale 3.x
- Add InfluxDB v3 terms

* chore(spelling): Vale config changes

- Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually.
- Move InfluxData spelling ignore list into the style.
- Reorganize custom (product) spelling lists to comply with Vale 3.x
- Add InfluxDB v3 terms

* chore(v3): Reorg of query troubleshooting and optimizing docs

- Adds query-data/troubleshoot-and-optimize
- Splits optimize docs into troubleshoot and optimize docs
- Moves Flight response doc to flight-responses.md

* chore: Fixes broken links, typos, missing content, etc.

- Fixes various errors and style violations reported by Vale.
- Fixes broken links and missing content in glossaries.
- Fixes missing and extraneous whitespace.

* Apply suggestions from code review

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md

* chore(clustered): Query plan: Apply review suggestions

Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com>

* feature(v3): Analyze a query plan:

- Apply code formatting to plan implementor names
- Simplify some points
- Add links

* add query plan html diagram (#5365)

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): finish the EXPLAIN descriptions and examples

* chore(tests): Setup a python venv in test containers

* fix(ci): Vale vocab

* fix(v3): Punctuation typo

* chore(ci): Update README

* fix(v3): Apply review suggestions and capitalization

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): Add note to optimize page and revise troubleshoot

* fix(v3): optimize-queries link

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 18:40:38 -05:00
dependabot[bot] b892ddf32b
chore(deps): bump axios from 0.27.2 to 1.6.0 (#5227)
Bumps [axios](https://github.com/axios/axios) from 0.27.2 to 1.6.0.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v0.27.2...v1.6.0)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-11-13 09:15:41 -07:00
dependabot[bot] c62b7cc992
chore(deps-dev): bump postcss from 8.4.23 to 8.4.31 (#5168)
Bumps [postcss](https://github.com/postcss/postcss) from 8.4.23 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.4.23...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-11 09:11:36 -05:00
Scott Anderson 0e55403af9
SQL aggregate functions (#4748)
* fix iox ui details (#4660)

* fixed left nav for iox

* updated nav order

* one more nav fix

* added sql data types doc to iox

* removed, need to create separate branch

* IOx get started (#4676)

* WIP iox get started

* WIP iox get started

* WIP iox get started

* WIP iox get-started

* WIP get-started docs

* iox get started setup

* added custom times and datepicker to iox getting started

* finished sample data date picker

* WIP get started querying

* wrapped up new getting started content

* fixed unclosed shortcode

* fixed js bug, updated get started to address PR feedback

* removed influxdbu banner from iox-get-started

* fixed typos

* Migrate data to IOx (#4704)

* WIP iox get started

* WIP iox get started

* WIP iox get started

* WIP iox get-started

* WIP get-started docs

* iox get started setup

* added custom times and datepicker to iox getting started

* finished sample data date picker

* WIP get started querying

* wrapped up new getting started content

* fixed unclosed shortcode

* fixed js bug, updated get started to address PR feedback

* removed influxdbu banner from iox-get-started

* add tsm to iox migration guide

* WIP 1.x iox migration

* WIP iox migration guides

* iox migration landing page content

* updated migration docs to address PR feedback

* one last PR feedback update

* added sql reference for review

* moved reference to sql folder

* removed file

* Schema recommendations for IOx (#4701)

* WIP iox get started

* WIP iox get started

* WIP iox get started

* WIP iox get-started

* WIP get-started docs

* iox get started setup

* added custom times and datepicker to iox getting started

* finished sample data date picker

* WIP get started querying

* wrapped up new getting started content

* fixed unclosed shortcode

* fixed js bug, updated get started to address PR feedback

* removed influxdbu banner from iox-get-started

* schema design recommendations

* add heading color styles

* fixed typos and formatting

* fixed typos

* fixed line protocol descrepencies

* fixed typo

* IOx landing page and notification (#4717)

* updated cloud iox landing page

* added state of the docs notification, removed addition resources from nav

* updated iox page titles

* updated duplicate oss and product data

* add order by doc (#4710)

* add order by doc

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added select doc (#4708)

* added select doc

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* having clause (#4713)

* added having clause

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added sql-data-types branch and corresponding doc (#4700)

* added sql-data-types branch and corresponding doc

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* added interval

* fixed formatting

* more format fixes

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* add limit doc (#4711)

* add limit doc

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added group by (#4721)

* added group by

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* IOx SQL query guides (#4720)

* WIP basic sql query guide

* WIP query guides

* WIP query docs, updated query format

* fleshed out sql aggregate query doc

* updated aggregate query guide, added explore schema guide

* fixed getting started link

* IOx Grafana and Superset documentation (#4723)

* iox grafana and superset documentation

* updates to the superset and grafana docs

* chore(grafana): Rework the documentation for a release instead of from source. (#4724)

* chore(grafana): Rework the documentation for a release instead of from source.

* chore: Typo.

* chore: v0.1.0 will be the first release.

* updates to address PR feedback

* a few minor updates to the grafana doc

* another minor update to grafana

* fixed grafana archive name

---------

Co-authored-by: Brett Buddin <brett@buddin.org>

* rearranged docs

* fix order by description

* updated more sql reference doc descriptions

* Add SQL selector functions (#4725)

* WIP selector functions

* WIP selector fns

* wrapped up sql selector functions

* relocated function docs

* add iox regions doc

* add messaging to guide users to the correct docs (#4728)

* minor changes

* added Flux reference

* updated algolia tagging

* add delete information to iox docs (#4727)

* fixed typos

* Add write content to the IOx docs (#4729)

* ported telegraf write docs to iox

* write content and updated reference

* updated node deps

* added link to selectors reference

* WIP aggregate functions

* WIP aggregate functions

* added approx aggregate functions

* added related links and page navs

---------

Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Brett Buddin <brett@buddin.org>
2023-02-07 08:44:41 -07:00
Scott Anderson 6870368b6e updated yarn file 2023-01-31 13:09:04 -07:00
Scott Anderson 3071b80a11
IOx documentation (#4730)
* fix iox ui details (#4660)

* fixed left nav for iox

* updated nav order

* one more nav fix

* added sql data types doc to iox

* removed, need to create separate branch

* IOx get started (#4676)

* WIP iox get started

* WIP iox get started

* WIP iox get started

* WIP iox get-started

* WIP get-started docs

* iox get started setup

* added custom times and datepicker to iox getting started

* finished sample data date picker

* WIP get started querying

* wrapped up new getting started content

* fixed unclosed shortcode

* fixed js bug, updated get started to address PR feedback

* removed influxdbu banner from iox-get-started

* fixed typos

* Migrate data to IOx (#4704)

* WIP iox get started

* WIP iox get started

* WIP iox get started

* WIP iox get-started

* WIP get-started docs

* iox get started setup

* added custom times and datepicker to iox getting started

* finished sample data date picker

* WIP get started querying

* wrapped up new getting started content

* fixed unclosed shortcode

* fixed js bug, updated get started to address PR feedback

* removed influxdbu banner from iox-get-started

* add tsm to iox migration guide

* WIP 1.x iox migration

* WIP iox migration guides

* iox migration landing page content

* updated migration docs to address PR feedback

* one last PR feedback update

* added sql reference for review

* moved reference to sql folder

* removed file

* Schema recommendations for IOx (#4701)

* WIP iox get started

* WIP iox get started

* WIP iox get started

* WIP iox get-started

* WIP get-started docs

* iox get started setup

* added custom times and datepicker to iox getting started

* finished sample data date picker

* WIP get started querying

* wrapped up new getting started content

* fixed unclosed shortcode

* fixed js bug, updated get started to address PR feedback

* removed influxdbu banner from iox-get-started

* schema design recommendations

* add heading color styles

* fixed typos and formatting

* fixed typos

* fixed line protocol descrepencies

* fixed typo

* IOx landing page and notification (#4717)

* updated cloud iox landing page

* added state of the docs notification, removed addition resources from nav

* updated iox page titles

* updated duplicate oss and product data

* add order by doc (#4710)

* add order by doc

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/order-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added select doc (#4708)

* added select doc

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/select.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* having clause (#4713)

* added having clause

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/having.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added sql-data-types branch and corresponding doc (#4700)

* added sql-data-types branch and corresponding doc

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* Update content/influxdb/cloud-iox/sql-data-types.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* added interval

* fixed formatting

* more format fixes

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* add limit doc (#4711)

* add limit doc

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/limit.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added group by (#4721)

* added group by

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-iox/group-by.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* IOx SQL query guides (#4720)

* WIP basic sql query guide

* WIP query guides

* WIP query docs, updated query format

* fleshed out sql aggregate query doc

* updated aggregate query guide, added explore schema guide

* fixed getting started link

* IOx Grafana and Superset documentation (#4723)

* iox grafana and superset documentation

* updates to the superset and grafana docs

* chore(grafana): Rework the documentation for a release instead of from source. (#4724)

* chore(grafana): Rework the documentation for a release instead of from source.

* chore: Typo.

* chore: v0.1.0 will be the first release.

* updates to address PR feedback

* a few minor updates to the grafana doc

* another minor update to grafana

* fixed grafana archive name

---------

Co-authored-by: Brett Buddin <brett@buddin.org>

* rearranged docs

* fix order by description

* updated more sql reference doc descriptions

* Add SQL selector functions (#4725)

* WIP selector functions

* WIP selector fns

* wrapped up sql selector functions

* relocated function docs

* add iox regions doc

* add messaging to guide users to the correct docs (#4728)

* minor changes

* added Flux reference

* updated algolia tagging

* add delete information to iox docs (#4727)

* fixed typos

* Add write content to the IOx docs (#4729)

* ported telegraf write docs to iox

* write content and updated reference

* updated node deps

* added link to selectors reference

---------

Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Brett Buddin <brett@buddin.org>
2023-01-31 11:07:26 -07:00
Scott Anderson 5ce0d1ec47
Show what versions of InfluxDB Flux functions are supported in (#4219)
* automatically build flux version data file

* rendered modals on each stdlib page

* polish on flux-influxdb version support

* reverted modified frontmatter

* added new page that shows what flux versions are packaged with each InfluxDB version

* added comment to js file

* updated to address PR feedback

* moved flux build scripts into their own directory

* updated inject-flux-frontmatter script to work in subdirectory

* updated flux-versions script to work in nested directory

* fixed bug in flux-versions script
2022-07-19 15:14:10 -06:00
Jason Stirnaman 72c31b5d12
Chore/upgrade hugo (#4164)
* fix: Upgrade Hugo and CSS dependencies to fix code samples

Upgrade to latest version of hugo-extended.
Upgrade to latest compatible version of PostCSS.
Fixes syntax highlighting for JavaScript code samples.

* chore: add openapi elements and reimplement Regex to replace shortcode.
2022-06-28 16:17:05 -05:00
Scott Anderson 909980c765
Auto-generated Flux docs (#4158)
* WIP testing autogen

* WIP autogen docs, added contributors parital

* updated stdlib

* WIP autogen

* Inject Flux stdlib frontmatter script (#4157)

* added frontmatter injection script and frontmatter data file

* regenerated stdlib

* finalize frontmatter injection script

* add frontmatter injection to CI build

* remove debug line from frontmatter script

* fresh docs generate

* fresh generate
2022-06-23 16:21:58 -06:00
Jason Stirnaman 14514539e7
chore: upgrade Hugo-extended and PostCSS-CLI to latest versions. Fixes security vulnerabilities. (#3750) 2022-02-03 15:57:06 -06:00
Jason Stirnaman f13e34de6d
Install dependencies as project dependencies from NPM repo (#2476)
* Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474)

* Replaced global hugo and yarn installs with project-level yarn install.

* Replaced npm package.lock with yarn.lock (#2474).

* enhancement: update README with instructions for installing NODE.JS dependencies. (#2474)

* updated api doc generator script to use npx

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update README.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update package.json

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix: indentation. (#2476)

* update: Added separate dependencies list for api-docs.
- Moved redoc-cli to a separate package.json in api-docs. Excluded
api-docs/node_modules from generate-api-docs.sh.
- Updated redoc-cli argument sequence to agree with their docs.
- Updated READMEs.
- Fixed typos.

* update: add api-docs > yarn install to .circleci

* Added language and consistency to code block. Specify where to run the command.

Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2021-05-24 12:11:01 -05:00