rundeck-plugins / rundeck-ec2-nodes-plugin

Get resource node data from Amazon EC2
85 stars 45 forks source link

Update the docs to be non-java developer friendly #11

Closed thorrsson closed 4 years ago

thorrsson commented 10 years ago

Not everyone is familiar with properties files layout, or even may have missed the part of the Rundeck docs on configuring resources. The documentation for the plugin seems to make some assumptions about it's user base that may not be correct given the adoption of Rundeck.

  1. A great example of how to improve the docs would be specifying how to add the parameters to the project.properties in the proper format (with example code) for example, instead of showing the final result in the UI when changing the username, show the line in the properties files

    if you want to change the default set: 
    Mapping Params: ssh-keypath.default=/path/to/key;username.default=my-username

    vs:

    resources.source.1.config.mappingParams=ssh-keypath.default=/path/to/key;username.default=my-username
  2. Adding an example file for the custom mappingFile would be handy, so newcomers would be able to base their configs on a know working example instead of hacking away at a file that they don't know the layout for.
  3. Adding an example for mapping the EC2 instance fields to the Rundeck node fields would be rally handy as well
  4. Examples are a great teacher when you come to a new project, so add them as appropriate

Thanks guys, I love the plugin now that I got it working :)

rodriguezsergio commented 10 years ago

+1

gschueler commented 10 years ago

thanks for the feedback, will try to improve the docs in that area asap :)

x110dc commented 10 years ago

+1

Put the rundeck-ec2-nodes-plugin-1.3.jar into your $RDECK_BASE/libext dir.

How do I get/make the JAR file? It's probably obvious to a Java dev, but not me.

gschueler commented 10 years ago

sorry, added link to releases tab in the readme:

https://github.com/rundeck-plugins/rundeck-ec2-nodes-plugin/releases

x110dc commented 10 years ago

No need to apologize! Thanks for creating the plugin and the quick response!