-
Notifications
You must be signed in to change notification settings - Fork 302
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
Adding adequate CLI examples for creating triggers #6002
Conversation
There was a problem hiding this 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.
There was a problem hiding this 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.
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
There was a problem hiding this 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 |
792abc5
to
d72eccd
Compare
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
… creation on write
There was a problem hiding this 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 CLI documentation and examples for various commands while removing outdated plugin documentation. Key changes include:
- Removal of obsolete "plugin" command documentation across multiple sections.
- Addition of comprehensive examples for the "create trigger" command and updates to examples for other commands (database, token, table, last_cache, and distinct_cache).
- Improvements to command argument descriptions and environmental variable usage notes.
Reviewed Changes
Copilot reviewed 15 out of 15 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 obsolete plugin deletion docs. |
content/shared/influxdb3-cli/delete/database.md | Updated argument description to include valid database name format. |
content/shared/influxdb3-cli/create/trigger.md | Revised trigger creation examples and removed the "--plugin" flag. |
content/shared/influxdb3-cli/create/token.md | Enhanced token creation docs with additional usage notes. |
content/shared/influxdb3-cli/create/table.md | Updated table creation docs and examples for clarity. |
content/shared/influxdb3-cli/create/last_cache.md | Added detailed examples and prerequisites for last cache creation. |
content/shared/influxdb3-cli/create/distinct_cache.md | Improved distinct cache doc with updated examples and instructions. |
content/shared/influxdb3-cli/create/database.md | Clarified database creation guidelines including environment variable usage. |
content/shared/influxdb3-cli/create/_index.md | Removed reference to deprecated plugin docs. |
content/influxdb3/enterprise/core references | Removed plugin docs to reflect deprecation. |
content/influxdb3/clustered/admin/tokens/database/revoke 2.md | Added new documentation for revoking a database token. |
Comments suppressed due to low confidence (3)
content/shared/influxdb3-cli/create/trigger.md:12
- The '--plugin' flag has been removed from the trigger command. Please ensure that the CLI help text has been updated accordingly and that any related functionality or references are fully deprecated.
- --plugin <PLUGIN_NAME> \
content/influxdb3/enterprise/reference/cli/influxdb3/delete/plugin.md:1
- The removal of the plugin documentation in the enterprise section appears intentional. Please verify that all related references and functionality have been deprecated to avoid confusion.
----
content/shared/influxdb3-cli/delete/database.md:14
- The updated description for DATABASE_NAME is more specific. Please confirm that the backend validations enforce these constraints as described in the documentation.
+- **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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor fixes. Overall, it looks good.
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There were a couple of unresolved comments. I went ahead and applied them.
Part of #5949