search

bmuschko / gradle-cargo-plugin

Gradle plugin that provides deployment capabilities to local and remote containers via Cargo
Apache License 2.0
258 stars 63 forks source link

Updated README multiple servers examples and added some cosmetic touch-ups #170

Closed viorelsfetea closed 6 years ago

viorelsfetea commented 6 years ago

Hi,

I had a problem with the deploy to multiple servers example, because the properties, such as containerId were not added to a cargo {} block when the tasks were automatically created. This resulted in an error saying "Container ID not set."

Since I was there, I also did some cosmetic touch-ups, such as:

  1. Added a table of contents
  2. Updated the code blocks to highlight groovy code
viorelsfetea commented 6 years ago

Yes, you are absolutely right. I must admit, I was totally confused here as to what the difference was since the block was just creating gradle tasks and the type of each task was referring to com.bmuschko.gradle.cargo.

Thank you for clarifying. I've removed the cargo{} block and I've added a note. Please merge only if you consider the other changes useful. Otherwise, please let me know and I'll close the PR.

viorelsfetea commented 6 years ago

I'll just squash now the commits so it's cleaner

bmuschko commented 6 years ago

@viorelsfetea Just had another look. The indentation of the code examples is off in the rendered output. They now have an additional tab/4 spaces. We'll want to have them start at the beginning of the grey box. Would you mind fixing that so I can merge?

bmuschko commented 6 years ago

Looking at this again. I don't think there's much benefit to adding a TOC manually. The TOC should be automatically generated as part of a user guide similar to what we do here. It'll be much easier to maintain. Please open a new pull request if you are interested in adding a similar user guide to the one available for the Gradle Docker plugin. You can find the relevant PR here.

Thanks again for your work!