docs-v2/content/shared
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
..
influxdb3-cli Add new influxdb3 show system commands (#5812) 2025-01-30 15:19:48 -07:00
influxdb3-query-guides Add new influxdb3 write and query input methods (#5807) 2025-01-27 14:16:25 -07:00
influxdb3-sample-data Add CLI instructions for writing sample data (#5814) 2025-01-31 08:50:05 -07:00
influxdb3-visualize Visualize data for InfluxDB 3 Core and Enterprise (#5785) 2025-01-17 13:22:23 -07:00
influxdb3-write-guides InfluxDB 3 Core and Enterprise write guides (#5811) 2025-01-30 12:37:12 -07:00
influxql-v3-reference Add InfluxDB 3 query guides (#5798) 2025-01-23 10:18:45 -07:00
sql-reference Add InfluxDB 3 query guides (#5798) 2025-01-23 10:18:45 -07:00
v3-core-get-started Initial Kapa.ai chat integration. 2025-02-03 08:31:55 -06:00
v3-distributed-admin-custom-partitions InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
v3-enterprise-get-started Initial Kapa.ai chat integration. 2025-02-03 08:31:55 -06:00
README.md chore(v3): Migrate admin/custom-partitioning to shared content 2025-01-09 10:22:12 -06:00
_index.md chore(v3): Migrate admin/custom-partitioning to shared content 2025-01-09 10:22:12 -06:00
v3-line-protocol.md InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00

README.md

Shared content

This section is for content shared across multiple products and versions. The /shared/_index.md frontmatter, marks the /shared directory and its children as draft so they don't get rendered when the site is built, but the contents of each shared documented is included in pages that use the file as a source in their frontmatter.

Use shared content

  1. Create a new folder for the content in the content/shared/ directory.

  2. Copy the markdown files into the new folder.

  3. Remove the frontmatter from the markdown files in the shared directory. If the first line starts with a shortcode, add an HTML comment before the first line, otherwise hugo will err.

  4. In each of the files that use the shared content, add a source to the frontmatter that points to the shared markdown file—for example:

    source: /shared/influxql-v3-reference/regular-expressions.md
    
  5. In the doc body, remove the shared Markdown text and add a comment that points to the shared file, in case someone happens upon the page in the repo--for example, in /content/3/core/reference/influxql/regular-expressions.md, add the following: