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.

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

[Feature request] Documentation improvement #44

Open
Dmitry1987 opened this issue Sep 11, 2018 · 6 comments
Open

[Feature request] Documentation improvement #44

Dmitry1987 opened this issue Sep 11, 2018 · 6 comments

Comments

@Dmitry1987
Copy link

Hi!
First of all thanks for the plugin!
I didn't find any documentation except examples folder, maybe this plugin should have a page with all options and features listed in one organized list so it will be easy to find every option that it provides?

For example I have no idea how to output the created server IP after it gets created, which field do I search for? Things like this can be listed in a separate page. I can help create that page with summary of all options.

@squat
Copy link
Owner

squat commented Sep 11, 2018

@Dmitry1987, thanks for opening this. I agree, more documentation would be very helpful! I know that another contributor has begun working on some documentation for the provider [0] but there is plenty of work to go around. I am quite focused at the moment on writing acceptance tests so any additional help in documentation would be very much appreciated!

[0] #5 (comment)

@Dmitry1987
Copy link
Author

Oh, wow, the docs I see from those 3 commits there in branch are almost fully complete, it covers all elements that I didn't know where to find 👍 didn't know that it's work in progress already.
What else would you like to document? I think I can help with that

@danielsreichenbach
Copy link
Contributor

@Dmitry1987 there are some differences though since a few resources were changed and I have not yet gotten to document these.

@Dmitry1987
Copy link
Author

how do you see what changed and how to know what each item means? from Vultr API docs?

@Dmitry1987
Copy link
Author

I'd like to assist, and have the docs merged :) but I don't know how exactly this all works, I never made a terraform plugin.

@danielsreichenbach
Copy link
Contributor

It's a combination of Vultr API changes and what changed in the implementation of the provider itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants