Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Updated SNAPTEL.md - added mention about separated snap-cli repo #1732

Merged
merged 7 commits into from
Sep 13, 2017

Conversation

IzabellaRaulin
Copy link
Contributor

Summary of changes:

  • updated SNAPTEL.md - added mention about separated snap-cli repo

@intelsdi-x/snap-maintainers

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:
Copy link
Contributor

Choose a reason for hiding this comment

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

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

"Snap API CLI" -> "Snap CLI"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

Copy link
Contributor

@andrzej-k andrzej-k left a comment

Choose a reason for hiding this comment

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

Great job!

@kjlyon
Copy link
Contributor

kjlyon commented Sep 12, 2017

@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.

  • mock needs to be changed to mock1
  • and the second publisher needs to be changed to mock-file
    image

@IzabellaRaulin
Copy link
Contributor Author

IzabellaRaulin commented Sep 12, 2017

@kjlyon, according:

the second publisher needs to be changed to mock-file

Thanks for catching that. I will change it.

mock needs to be changed to mock1

snap-plugin-collector-mock1 has a name mock and version 1 (the version has never changed because the plugin is used in tests together with snap-plugin-collector-mock2 to check version swapping), so the name="mock" in this case is as expected

@kjlyon
Copy link
Contributor

kjlyon commented Sep 12, 2017

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor correction:
in separated repo --> in a separate repo

Copy link
Contributor

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

LGTM

@IzabellaRaulin IzabellaRaulin merged commit bc738d5 into intelsdi-x:master Sep 13, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants