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

Doc: Create documentation for NodeCloud vocabulary #26

Open
rajikaimal opened this issue Nov 6, 2019 · 3 comments
Open

Doc: Create documentation for NodeCloud vocabulary #26

rajikaimal opened this issue Nov 6, 2019 · 3 comments

Comments

@rajikaimal
Copy link
Member

Current documentation doesn't explain the vocabulary of NodeCloud in a convenient manner. New users should be able to use the services without going through extra hassle to find the matching services in cloud providers and NodeCloud APIs.

A documentation page can be created with the vocabulary of current set of APIs in NodeCloud matched with vocabulary of the cloud providers.
@PratikDhanave
Copy link
Member

how about swagger integration ?

@rajikaimal
Copy link
Member Author

I have no experience using Swagger with a SDK, is it possible to use Swagger for SDK documentation?

@Pran-Ker
Copy link

Pran-Ker commented Dec 5, 2019

@rajikaimal I agree with you on this . How about I add to the documentation , while I am understanding the project .And then , I send it over to you , so you can go through and add points.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@PratikDhanave @rajikaimal @Pran-Ker