Updated SNAPTEL.md - added mention about separated snap-cli repo #1732
Conversation
docs/SNAPTEL.md
Outdated
| The _alpha version_ of `snaptel` which bases on REST API V2 is available in separated repo | ||
| [snap-cli](https://github.com/intelsdi-x/snap-cli). | ||
|
|
||
| The separated Snap API client and CLI support [Swagger Open API Specification](https://swagger.io/specification). To get more help on the Snap API client and Snap CLI check out: |
There was a problem hiding this comment.
This section talks about "separated Snap API client" which is related yet different from Snap CLI - maybe consider a small sub-section explaining new Snap API client, or just putting link where it is described? Maybe a bit of introduction saying that new CLI is based on new Snap API client which in turn is talking to API v2 would be good?
docs/SNAPTEL.md
Outdated
| * [SECURE_PLUGIN_COMMUNICATION](SECURE_PLUGIN_COMMUNICATION.md) | ||
|
|
||
| ## Snap CLI (REST API V2) | ||
| The documentation for the Snap API CLI which bases on REST API V2 is located in [snap-cli](https://github.com/intelsdi-x/snap-cli). |
There was a problem hiding this comment.
"Snap API CLI" -> "Snap CLI"
|
@IzabellaRaulin , in this PR, can you also address this issue: In the example section of SNAPTEL.md, when unloading the plugins, there are two typos.
|
|
@kjlyon, according:
Thanks for catching that. I will change it.
snap-plugin-collector-mock1 has a name |
|
LGTM |
docs/SNAPTEL.md
Outdated
|
|
||
| ### Snap CLI on top of REST API V2 | ||
|
|
||
| The _alpha version_ of `snaptel` which relays on [Snap API Go client](https://github.com/intelsdi-x/snap-client-go) talking to [REST API V2](REST_API_V2.md) is available in separated repo [snap-cli](https://github.com/intelsdi-x/snap-cli). |
There was a problem hiding this comment.
Minor correction:
in separated repo --> in a separate repo
Summary of changes:
@intelsdi-x/snap-maintainers