Commit Graph

180 Commits (api-docs-uplift)

Author SHA1 Message Date
Jason Stirnaman 8035366677
refactor: replace URL-parsing in shortcodes with cascade product data (#6883)
* 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.
2026-02-27 09:46:57 -06:00
Copilot ba28e124b1
Add Documentation MCP server pages to chronograf, kapacitor, flux, and explorer (#6833)
* Initial plan

* feat: add Documentation MCP server pages to chronograf, kapacitor, flux, and explorer

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix: update MCP page descriptions to include product names

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix: resolve product-name shortcode for v1/v0 versioned products

The shortcode previously only checked the second URL path segment to
identify products, which works for InfluxDB 3 (/influxdb3/core/) but
fails for older products where the second segment is a version number
(/chronograf/v1/, /flux/v0/).

Add namespace extraction (first path segment) and conditional logic to
look up products by namespace when the version is v1 or v0. This fixes
empty product names in meta descriptions for Chronograf, Telegraf,
Kapacitor, Flux, and InfluxDB Enterprise v1.

* feat: relocate v2/cloud MCP pages and add alt_links for cross-product navigation

- Move MCP server pages from reference/ to tools/ for InfluxDB v2 and Cloud
- Add alt_links frontmatter to all MCP pages for cross-product navigation
- Use product-name shortcode in descriptions for consistency
- Convert code-placeholders shortcode to fenced code block attributes
- Update shared content to use version-agnostic URLs

* Add multi-assistant installation instructions for documentation MCP server (#6836)

* Initial plan

* feat(mcp): add installation instructions for multiple AI assistants

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* refactor(mcp): replace Cline and Windsurf with GitHub Copilot and OpenCode

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2026-02-18 14:20:26 -06:00
Jason Stirnaman 36cfabae9c fix: broken links
- Flux links in Kapacitor and others: flux/v0.x/ -> flux/v0/
- influxdb/v2%2E0/ -> influxdb/v2/
2025-06-04 17:05:46 -05:00
Jason Stirnaman 1654d3c4f3
Merge branch 'master' into core-enterprise-api-ref 2025-03-04 16:36:46 -06:00
antonmeyer fe09b06fcb
Update hour.md with example for local time (#5873)
* Update hour.md with example for local time

Update hour.md with example for local time

* Update content/flux/v0/stdlib/date/hour.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-03-04 10:04:02 -07:00
Jason Stirnaman 4403dd9a18 fix: LInks and headings. Replace `latest` with `v2`. Specify OSS v2 in headings. Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866, Closes Flux docs: replace `/influxdb/latest` with `/influxdb/v2` #5864. Linting cleanup, removing terminal prompt from examples 2025-02-27 17:50:16 -06:00
Scott Anderson 72c5295eed
InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760)
* WIP monolith docs

* WIP monolith

* updated alpha shortcode

* template updates for v3 and pro

* SQL & InfluxQL reference docs for Pro and OSS v3 (#5718)

* point to shared influxql source files

* add sql and influxql references to pro and oss v3 docs

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* ported changes to distributed influxql refs

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Influxdb3 restructure (#5744)

* WIP monolith naming restructure

* rebuild homepage

* updated broken home links

* stabs in the dark

* fixed duplicate-oss shortcode

* move clustered and cloud-dedicated

* clean-up serverless cruft

* add distributed product redirects

* standarize productPathData

* switch back to findRE for productPathData

* remove debugging code

* move cloud dedicated content

* new product dropdown

* Jstirnaman/influxdb3 restructure (#5743)

* LDAPS and LDAP Client Certificate Docs

Add documentation via LDAP sample configuration for LDAPS and LDAP client certificates. These are new features in the yet-to-be released Enterprise 1.11.7

* Update bucket-schema.md

ndjson.org goes to some sort of sports betting site.

https://jsonlines.org/ is probably a better site.

* fix(partitioning): improve clarity and consistency in partitioning, apply suggestions from @reidkaufmann

* update shared links to use ambiguous version

* WIP monolith docs

* template updates for v3 and pro

* move clustered and cloud-dedicated

* switch back to findRE for productPathData

* move cloud dedicated content

* chore(influxdb3): port cloud-dedicated URLs from recent commit

* chore(influxdb3/clustered): fix and update links

* removed merge cruft

---------

Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: Daniel Lo <wilburlo@gmail.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: Daniel Lo <wilburlo@gmail.com>

* added and styled alpha banner, updated producted selector styles and js

* updated alpha link styles

* updated discord link text

* updated alpha message

* fix page title

* Initial Files

* Initial Files

* InfluxDB 3 Enterprise CLI docs (#5745)

* WIP influxdb3 cli

* fix page title

* influxdb3 enterprise cli

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* fix(js): initialize CodePlaceholder on content loaded, small refactor toward component pattern.

* updated URL modal for core and enterprise

* remove testing code on install page

* InfuxDB 3 Enterprise configuration options (#5749)

* fix page title

* add enterprise 3 configuration options

* revert command updates to avoid conflicts

* updated config option name

* CLI updates, reorg, and photos

* updated host-id option to writer-id

* InfluxDB 3 Core CLI (#5750)

* WIP make influxdb3 docs shared

* finish making influxdb3 enterprise cli shared

* add influxdb3 core cli docs

* update config option name

* updated host-id to writer-id

* updated a few more host-id options to writer-id

* InfluxDB 3 Core configuration options (#5752)

* added missing enterprise config options

* add influxdb3 core config options, update enterprise options

* minor fixes in core config options

* update search integration data (#5753)

* Add shared v3 line protocol doc to Core and Enterprise (#5754)

* add shared v3 line protocol doc to core and enterprise

* Update content/shared/v3-line-protocol.md

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* feat: update getting started guides

* Update content/influxdb3/core/_index.md

* Update content/influxdb3/core/_index.md

* update use of 3.0 and v3 to just 3

* add basic download/install instructions (#5756)

* chore(monolith): port Enterprise and Core get-started guides to shared for reuse as /index and /get-started

* fix(monolith): reapply previous description change

* Jts/update Get started for monolith (#5759)

* fix(monolith): get-started cleanup (spelling, style, APIs)
- Finished Enterprise for now, not ported to Core.

* fix(monolith): python sample columns

* fix(monolith): Ports edits to Core, misc. fixes

* update alpha message

* add state to product dropdown items

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: Daniel Lo <wilburlo@gmail.com>
Co-authored-by: Peter Barnett <peterbarnett@Peters-MacBook-Pro.local>
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
Co-authored-by: Paul Dix <paul@pauldix.net>
2025-01-13 07:21:11 -07:00
Ben Tasker c578abb998
docs: note that `option location` does not change the timezone used in `_time` (#5702)
* docs: note that `option location` does not change the timezone used in results

* Update content/flux/v0/spec/options.md

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

* Update content/flux/v0/stdlib/timezone/location.md

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

* Update content/flux/v0/stdlib/timezone/fixed.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>
2024-12-05 10:27:33 -07:00
B Tasker 92b95a9495
feat: add example 2024-10-02 15:29:12 +01:00
B Tasker 531afe7b6b
fix: influxdb.cardinality() can't accept an integer as start 2024-10-02 15:27:21 +01:00
B Tasker a5e4992195
docs: tweak wording 2024-10-02 15:19:51 +01:00
B Tasker 9549bacbb8
fix: adjust examples to do what the headers suggest 2024-10-02 14:29:21 +01:00
B Tasker 8948cd5486
docs: make description less ambiguous about what the function does 2024-10-02 14:28:29 +01:00
Jason Stirnaman 3b6a5fa74f fix(flux): Write, Query, and Prometheus menu name
- Replaces `menu: flux_0_x` with the correct menu attributes in frontmatter.
- These have apparently been broken like this for some time.
2024-08-02 09:26:06 -05:00
Scott Anderson b496dff5b5
Flux 0.195.1 (#5493)
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2024-06-11 15:14:37 -06:00
Scott Anderson 54de71013d
Add future of flux page and notifications (#5484)
* add future of flux page, update future of flux notification, add exclude functionality to notifications

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* updated formatting and tense

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2024-05-30 08:46:13 -06:00
Jason Stirnaman 5e2f1f2773 fix(flux): typo. Closes #5421 2024-05-09 11:41:01 -05:00
Scott Anderson 4e75e9a906 hotfix: fix flux caption rendering 2024-04-08 16:01:02 -06:00
Andreas Deininger 476a73e95e
Fixing typos (#5315)
* Fix typos

* Bump hugo to latest version v0.122.0

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-02-05 09:51:51 -07:00
Scott Anderson edcd8e3695 Flux 0.194.5 2023-11-29 09:33:39 -07:00
Andreas Deininger c9488e3465
Fixing typos (#5242)
* Fixing typos

* Update content/enterprise_influxdb/v1/flux/guides/rate.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-11-27 09:32:55 -07:00
Scott Anderson 13b5ff06dc hotfix: update math.copysign examples, closes #5229 2023-11-13 11:34:27 -07:00
Scott Anderson 638c694de8
Enhance Flux functions lists (#5221)
* WIP flux function list

* fix isset error with icon shortcode

* Update content/flux/v0/spec/variables.md

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-07 13:56:49 -07:00
Scott Anderson 604d22989a hotfix: fix flux tag taxonomies and function filters 2023-11-06 17:08:22 -07:00
Scott Anderson 636f5ada45
V2 nav reorg (#5213)
* nest reference docs menu in v2 and cloud

* move migrate data into write data

* nest notebooks under tools

* nest templates under tools

* nest telegraf configs under tools

* cleanup weights and titles of tools sections

* reorg org and bucket management under admin

* add backup/restore to admin, clean up related links

* restructure security sections under admin

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated serverless cli docs to address pr feedback

* Update content/influxdb/cloud/admin/organizations/delete-org.md

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* port v2 install changes to new structure

* address pr feedback and ported missing content to serverless

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-06 15:53:12 -07:00
Scott Anderson fa399d9fb7
update release note date format and links (#5208) 2023-10-30 14:57:17 -06:00
Scott Anderson 72b8b4a19e hotfix: fix typo in flux regexp types doc, closes #5113 2023-10-25 12:53:29 -06:00
Scott Anderson fe55aa8610
added new and missing flux release notes (#5194) 2023-10-25 12:36:49 -06:00
Scott Anderson 9696bf15fe
removed references to defunct videos (#5163) 2023-10-03 12:05:30 -06:00
Scott Anderson 09d283ff56
Kapacitor 1.7 (#5151)
* Kapacitor 1.7 and reorg

* fixed references to kapacitor 1.6
2023-09-22 11:35:04 -06:00
Scott Anderson 35ad46c4c2
Version restructure (#5133)
* mass changes for version restructure

* fixed latest-patch and flux version generator

* updated hugo configs

* fixed flux frontmatter injector

* fixed flux frontmatter injector

* WIP api generator updates for version restructure (#5128)

* fixed telegraf plugin list

* removed latest shortcode

* fixed current-version

* fixed product dropdown crosslinking

* fixed alt links

* WIP fixing links

* fixed broken links

* updated api doc generation

* fixed additional resources

* added version redirects to edge.js

* fixed search placeholder

* fixed paged titles
2023-09-12 23:33:31 -06:00
Scott Anderson 471ee4561d
InfluxDB Clustered documentation (#5126)
* WIP base changes for clustered docs

* WIP clustered docs

* Add new influxdb/host shortcode and implement it in 3.0 docs (#5077)

* add new influxdb/host shortcode and implement it in 3.0 docs

* remove oss- cloud-only shortcodes from serverless

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated urls js to PR suggestion

* Updated JavaScript, templates, and styles for Clustered URLs (#5079)

* updated js, templates, and styles for clustered urls

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* restructure product dropdown template to be more extensible

* fixed more page template bugs

* fixed references to cloud in clustered

* updated docsearch templates

* added early access flagging and cta-link shortcode

* minor content updates in clustered

* updated staging config

* fixed typo in clustered description

* ported influxctl 2.0.1 to clustered

* ported get started changes to clustered

* ported 3.0 admin docs to clustered

* port null tag content to clustered

* ported influxctl note to clustered

* ported query reorg changes to clustered

* updated early access to limited availability, updated clustered landing content

* ported new content to clustered

* ported new content to clustered

* updated cta on clustered landing page

* Updated notifications and added InfluxDB Clustered announcement notification (#5125)

* updated notifications, added clustered announcement notification

* updated cta in clustered notification

* updated influxctl profile configs

* update clustered search attributes

* updated learn more link in clustered notification

* Apply suggestions from code review

* fixed typos

* fixed typos

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 06:21:47 -06:00
Jason Stirnaman 17ae494d2c
fix: spelling errors (#5061) 2023-07-31 16:59:33 -05:00
Jason Stirnaman 19927d5d28
4947 spelling fixes (#5058)
* fix(all): spelling error unisgnedLong spelling in glossary. #4947

- Fixes #4947.

* fix(flux): spelling
2023-07-27 18:37:07 -05:00
Arek Manoukian 81eb07d36e
Update sort.md (#4960) 2023-05-31 14:38:53 -05:00
Scott Anderson 274d4a0444
SQL updates and gap filling (#4911)
* ports upstream sql changes to docs, closes #4881

* WIP gapfill functions

* WIP gapfill docs

* gapfill function reference

* document how to fill gaps in data with sql, closes #4870

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated phrase of date_bin_gapfill, ported content to dedicated

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-04-28 08:22:21 -06:00
Scott Anderson f9df59881f hotfix: Flux 0.194.1 patch notes 2023-04-20 07:57:05 -06:00
Scott Anderson f57adc4118
Flux 0.194.0 (#4854)
* Flux 0.194.0

* fixed string comments
2023-04-06 11:37:25 -06:00
Sam 2e1539b925
Update string.md (#4655)
spacing issue in example

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-03-08 14:51:18 -07:00
Leonid Skorospelov d4926db4b9
Fix typo in aggregatewindow.md (#4678)
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-03-08 14:33:33 -07:00
Scott Anderson a0a15290d3
Flux 0.193.0 (#4769) 2023-02-24 10:31:13 -07:00
Scott Anderson 0c9bbd0654 hotfix: move results table from date.monthDay to date.month 2023-01-13 16:20:13 -07:00
Scott Anderson f311c76a84
Flux 0.192 (#4695)
* flux 0.192.0 release notes

* flux 0.192.0 stdlib updates
2023-01-09 16:15:08 -07:00
Scott Anderson 390f8d3df0
Flux dynamic type (#4656)
* WIP work with dynamic types

* WIP dynamic types

* added dynamic type description and removed draft

* updated dynamic type doc to address PR feedback
2022-12-02 10:01:31 -07:00
Scott Anderson 31c065673c
Flux 0.191.0 (#4641) 2022-11-16 14:42:08 -07:00
Scott Anderson 7f6cbda16c
Flux 0.190 (#4630)
* Flux 0.190.0 release notes

* Flux 0.190.0 stdlib changes
2022-11-09 16:10:57 -07:00
Scott Anderson 7fd469306b
Flux 0.189 (#4615)
* 0.188.0 flux spec updates

* 0.189.0 flux spec updates

* Flux 0.189.0 stdlib updates
2022-11-02 16:45:59 -06:00
Mattanja Kern 7e412193cf
Fixes repeated typo on all pages (ouput) (#4569)
Co-authored-by: Mattanja Kern <mattanja@kern.services>
2022-10-18 13:11:05 -06:00
Scott Anderson c3d1b63a3d
Flux 0.187 (#4566)
* Flux 0.187.0 release notes

* Flux 0.187.0 stdlib updates
2022-10-17 15:39:42 -06:00
Scott Anderson 7482b3260f
Flux 0.186 (#4551)
* Flux 0.186.0 release notes

* Flux 0.186.0 stdlib updates
2022-10-11 16:31:16 -06:00