Issue #59: Display the connector variables #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 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.
* Updated MetricsHub example content producer to add variables configuration example. * Tested the results
* Resolved merge conflict.
|
I would simplify the listing of variables like below: Variables:
So the "template" is like: <li> <code>VARNAME</code>: VARDESCRIPTION (default: <code>DEFAULTVALUE</code>)Description and default value should be displayed in the doc only if they are specified, like below:
|
|
Now an interesting question: how do we specify variable values for a connector through the CLI? 😅 |
|
There is a plan for this @bertysentry sentrysoftware/metricshub#357... indeed, we still require a spec. |
NassimBtk
requested changes
Sep 27, 2024
...ain/java/org/sentrysoftware/maven/metricshub/connector/producer/ConnectorJsonNodeReader.java
Outdated
Show resolved
Hide resolved
...entrysoftware/maven/metricshub/connector/producer/model/common/ConnectorDefaultVariable.java
Outdated
Show resolved
Hide resolved
* 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.
bertysentry
approved these changes
Sep 30, 2024
NassimBtk
approved these changes
Sep 30, 2024
NassimBtk
deleted the
feature/issue-59-display-the-connector-variables
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
variablessection under theprerequisitesin the connectors pages to display the connector template variables, their description & their default value if available.Tests
Default connector variables specified (description and defaultValue specified)
Default connector variables specified (description not specified)
Default connector variables specified (defaultValue not specified)
Default connector variables not specified (variables are present).
MetricsHub.yaml example