Skip to content

Adding adequate CLI examples for creating triggers #6002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 41 commits into
base: master
Choose a base branch
from

Conversation

MeelahMe
Copy link
Contributor

Closes #5949

@MeelahMe MeelahMe linked an issue Apr 18, 2025 that may be closed by this pull request
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the CLI documentation for deleting databases to include clearer examples of valid database names.

  • Updated the DATABASE_NAME argument description to specify acceptable naming conventions.
Comments suppressed due to low confidence (1)

content/shared/influxdb3-cli/delete/database.md:14

  • [nitpick] Consider clarifying the naming convention by explicitly stating that while the first character must be alphanumeric, subsequent characters may include dashes and underscores. For example, add a note indicating that dashes and underscores cannot be used as the first character.
- **DATABASE_NAME**: The name of the database to delete. Valid database names are alphanumeric and start with a letter or number. Dashes (`-`) and underscores (`_`) are allowed.

Copy link
Contributor

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work - just be sure to test your examples against the latest versions.

@MeelahMe MeelahMe removed the request for review from sanderson April 18, 2025 22:26
MeelahMe and others added 2 commits April 18, 2025 15:33
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
@MeelahMe MeelahMe requested a review from Copilot April 21, 2025 20:39
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the CLI documentation to include comprehensive examples for creating triggers and related commands while removing outdated plugin references.

  • Removed old plugin documentation for delete and create commands.
  • Added example sections for the trigger, token, last_cache, and distinct_cache commands.
  • Updated reference files to reflect the removal of plugin docs.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
content/shared/influxdb3-cli/delete/plugin.md Removed outdated plugin deletion documentation
content/shared/influxdb3-cli/create/trigger.md Added CLI examples and removed the deprecated --plugin option
content/shared/influxdb3-cli/create/token.md Updated token command syntax and added admin token example
content/shared/influxdb3-cli/create/plugin.md Removed outdated plugin creation documentation
content/shared/influxdb3-cli/create/last_cache.md Added examples for creating a last value cache
content/shared/influxdb3-cli/create/distinct_cache.md Added examples for creating a distinct cache
content/influxdb3/core/reference/cli/influxdb3/delete/plugin.md Removed reference file for delete plugin documentation
content/influxdb3/core/reference/cli/influxdb3/create/plugin.md Removed reference file for create plugin documentation

@MeelahMe MeelahMe self-assigned this Apr 21, 2025
@MeelahMe MeelahMe marked this pull request as ready for review April 29, 2025 00:13
@MeelahMe MeelahMe marked this pull request as draft April 29, 2025 00:14
@MeelahMe MeelahMe force-pushed the 5949-add-api-reference-examples-to-influxdb3 branch from 792abc5 to d72eccd Compare April 30, 2025 22:33
@MeelahMe MeelahMe requested a review from Copilot May 1, 2025 01:36
@MeelahMe MeelahMe requested a review from Copilot May 1, 2025 05:50
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the CLI documentation by updating examples and usage instructions, as well as removing deprecated plugin command references.

  • Removed outdated plugin docs and enterprise references.
  • Enhanced the examples, prerequisites, and verification sections for database, trigger, token, table, last_cache, and distinct_cache commands.
  • Updated the syntax details and added extended examples to improve clarity and user guidance.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
content/shared/influxdb3-cli/delete/plugin.md Removed outdated command documentation.
content/shared/influxdb3-cli/delete/database.md Expanded the description of valid database names.
content/shared/influxdb3-cli/create/trigger.md Removed the --plugin option and added multiple trigger examples.
content/shared/influxdb3-cli/create/token.md Updated the usage and examples for token creation and usage.
content/shared/influxdb3-cli/create/table.md Added verification steps and an example for table creation.
content/shared/influxdb3-cli/create/plugin.md Removed outdated plugin command documentation.
content/shared/influxdb3-cli/create/last_cache.md Revised command syntax and augmented examples with prerequisites.
content/shared/influxdb3-cli/create/distinct_cache.md Expanded examples and fixed parameter references in cache creation.
content/shared/influxdb3-cli/create/_index.md Removed reference to the deprecated plugin command.
content/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin.md Removed outdated enterprise plugin deletion documentation.
content/influxdb3/enterprise/reference/cli/influxdb3/create/plugin.md Removed outdated enterprise plugin creation documentation.

MeelahMe and others added 2 commits April 30, 2025 22:50
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MeelahMe MeelahMe requested a review from jstirnaman May 1, 2025 05:52
@MeelahMe MeelahMe marked this pull request as ready for review May 1, 2025 06:08
@MeelahMe MeelahMe requested a review from Copilot May 1, 2025 06:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates and enhances the CLI documentation with additional examples and improved usage instructions, and removes deprecated plugin command references.

  • Removed outdated plugin create/delete documentation.
  • Added detailed examples and prerequisite sections for trigger, token, table, last_cache, and distinct_cache commands.
  • Updated CLI argument descriptions and usage syntax to improve clarity and consistency.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
content/shared/influxdb3-cli/delete/plugin.md Removed outdated plugin deletion documentation.
content/shared/influxdb3-cli/delete/database.md Enhanced DATABASE_NAME argument with validation criteria.
content/shared/influxdb3-cli/create/trigger.md Removed the --plugin option and added comprehensive examples.
content/shared/influxdb3-cli/create/token.md Updated usage syntax from to .
content/shared/influxdb3-cli/create/table.md Added a verification section to show table creation output.
content/shared/influxdb3-cli/create/plugin.md Removed obsolete plugin creation documentation.
content/shared/influxdb3-cli/create/last_cache.md Introduced prerequisites and expanded examples for last_cache.
content/shared/influxdb3-cli/create/distinct_cache.md Added prerequisites and detailed examples for distinct_cache.
content/shared/influxdb3-cli/create/_index.md Removed plugin entry from the create command index.
Enterprise and Core references Removed plugin docs to consolidate CLI documentation.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't finished reviewing yet.

@MeelahMe MeelahMe requested a review from Copilot May 15, 2025 19:31
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the CLI documentation by adding more detailed examples for creating triggers, databases, tokens, and various cache types while also removing deprecated plugin command documentation. Key changes include removal of plugin-related content, enhanced usage examples with clear placeholder guidance, and updated command syntax and option descriptions.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.

Show a summary per file
File Description
content/shared/influxdb3-cli/delete/plugin.md Removed outdated plugin deletion documentation
content/shared/influxdb3-cli/delete/database.md Enhanced description for database deletion command arguments
content/shared/influxdb3-cli/create/trigger.md Removed the plugin parameter and updated examples for trigger creation
content/shared/influxdb3-cli/create/token.md Updated the token command usage from to and added admin token examples
content/shared/influxdb3-cli/create/table.md Refined instructions and added verification examples for table creation
content/shared/influxdb3-cli/create/last_cache.md Expanded examples and prerequisites for creating a last value cache
content/shared/influxdb3-cli/create/distinct_cache.md Improved documentation with prerequisites and clear examples for distinct caches
content/shared/influxdb3-cli/create/database.md Updated database creation instructions and examples for improved clarity
content/shared/influxdb3-cli/create/_index.md Removed plugin command reference from the index
content/influxdb3/enterprise/reference/cli/*plugin.md Removed plugin documentation in enterprise and core reference sections
content/influxdb3/clustered/admin/tokens/database/revoke 2.md Added new documentation for revoking a database token in clustered environments
Comments suppressed due to low confidence (3)

content/shared/influxdb3-cli/create/trigger.md:10

  • The removal of the '--plugin <PLUGIN_NAME>' parameter from the command and options table improves clarity. Please ensure that any internal references or related backend functionality have been updated accordingly.
influxdb3 create trigger [OPTIONS] \

content/influxdb3/clustered/admin/tokens/database/revoke 2.md:2

  • [nitpick] The file name 'revoke 2.md' contains a space and a numeral that may be inconsistent with typical naming conventions. Consider renaming it to avoid potential issues (e.g., 'revoke.md' or 'database-revoke.md').
title: Revoke a database token

content/shared/influxdb3-cli/create/token.md:8

  • Updating the command format from '' to '' aligns with the new CLI design; double-check that all related examples and usage instructions reflect this change consistently.
influxdb3 create token <SUBCOMMAND>

@MeelahMe MeelahMe requested a review from jstirnaman May 15, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API reference examples to Influxdb3
2 participants