Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Display the connector variables in the connector documentation page #59

Closed
NassimBtk opened this issue Sep 24, 2024 · 0 comments · Fixed by #61
Closed

Display the connector variables in the connector documentation page #59

NassimBtk opened this issue Sep 24, 2024 · 0 comments · Fixed by #61
Assignees
@bertysentry @CherfaElyes
Labels
enhancement New feature or request java Pull requests that update Java code

Comments

@NassimBtk
Copy link
Member

NassimBtk commented Sep 24, 2024 •
edited
Loading

Specification

On the connector's page, add a section to list all the connector's variables. Make sure to read the default variable values, and descriptions as well. If a connector variable has neither a default value nor a description, we will only report the variable that needs to be configured.
Update the resource configuration example (YAML) to explain how to setup configuration variables.
@NassimBtk NassimBtk changed the title Display the variables of a connector Display the connector variables Sep 24, 2024
@CherfaElyes CherfaElyes added enhancement New feature or request java Pull requests that update Java code labels Sep 26, 2024
CherfaElyes added a commit that referenced this issue Sep 27, 2024
@CherfaElyes
Issue #59: Display the connector variables
2017faa 
* Added a `variables` section under the `prerequisites`.
* Tested on metricshub-doc.
CherfaElyes added a commit that referenced this issue Sep 27, 2024
@CherfaElyes
Issue #59: Display the connector variables
4c8de39 
* Added a `variables` section under the `prerequisites` in the connectors pages to display the connector template variables, their description & their default value if available.
* Tested on metricshub-doc.
CherfaElyes added a commit that referenced this issue Sep 27, 2024
@CherfaElyes
Issue #59: Display the connector variables
b2010ce 
* Updated MetricsHub example content producer to add variables configuration example.
* Tested the results
@CherfaElyes CherfaElyes linked a pull request Sep 27, 2024 that will close this issue
Issue #59: Display the connector variables #61
Merged
CherfaElyes added a commit that referenced this issue Sep 27, 2024
@CherfaElyes
Issue #59: Display the connector variables
4fdb9ce 
* Resolved merge conflict.
CherfaElyes added a commit that referenced this issue Sep 30, 2024
@CherfaElyes
Issue #59: Display the connector variables
c2dad16 
* Changed the output format to make it more readable and concise.
* Tested all the changes on metricshub-doc.
* Updated the screenshots on the PR description.
NassimBtk added a commit that referenced this issue Sep 30, 2024
@NassimBtk
Merge pull request #61 from sentrysoftware/feature/issue-59-display-t…
7c5f640 
…he-connector-variables

Issue #59: Display the connector variables
@NassimBtk NassimBtk changed the title Display the connector variables Display the connector variables in the connector documentation page Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bertysentry bertysentry

@CherfaElyes CherfaElyes

Labels
enhancement New feature or request java Pull requests that update Java code
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue #59: Display the connector variables sentrysoftware/metricshub-connector-maven-plugin
3 participants
@NassimBtk @bertysentry @CherfaElyes