first cut at rationale and programming practices #93
Conversation
* 'master' of github.com:jclouds/jclouds.github.com: Updated outdated information about jclouds Continuous Integration and snapshot artifact repository Updated docs to renamed hpcloud provider
…;) ... i think having these in is asking for trouble (they break in jekyll --server FWIW) ... unless someone knows otherwise ?
…ooked beautiful; have changed inline code blocks to use same droid font, and now looking good (chrome os x)
…) without relying on local browser styles, tweaks to spacing/margins to make more consistent
…main "contributing" page
Providers testing documentation
* 'master' of github.com:jclouds/jclouds.github.com: 1.3 test results for azureblob(one glitch) bluelock(perfect) perfect scores for aws-cloudwatch aws-ec2 aws-s3 swift perfect scores for aws-cloudwatch aws-ec2 aws-s3 swift removed bad file
… cloudloadbalancers-us cloudonestorage cloudservers-us cloudstack elastichosts-lax-p eucalyptus-partnercloud-s3 go2cloud-jhb1 gogrid hpcloud-objectstorage-lvs ninefold-storage serverlove-z1-man stratogen-vcloud-mycloud vcloud
* 'master' of github.com:jclouds/jclouds.github.com: softlayer passed perfect
Added missing explanations from old wiki
…ed logging libs and added links.
Update Cloudify reference in apps-that-use-jclouds
…es. Added list of Rackspace providers. Added rackspace-cloudservers-* to compute provider list. Minor corrections. Discovered the Ant installation instructions do not work anymore because become.com is no longer. Updated Ant installation instructions and removed redundant instructions. Added links to First/Next Gen descriptions.
Updated chef docs to latest chef code
Added updated for release 1.5.2
Github -> GitHub (see https://github.com/ for spelling)
update for 1.5.3
|
Just scratches the surface, but certainly worth while in the long run. Need to use HTML entities or equivalent instead of angle brackets after Map. |
|
hoping the switch to asciidoc eliminates the angly bracket concern |
|
added feedback from @demobox except I don't have time to go through jclouds/jclouds#1010 right now. More structure needs to be added as well, but I suspect TOC will be something generated via javascript as opposed to outlayed explicitly here. NEXT STEPS: |
|
Great stuff. Also worth mentioning toString: "Main points on tostring are don't accidentally add passwords into and also use Guava ToStringHelper.omitNullValues() option." For hashcode/equals implementations, can we recommend (but not require) use of guava's Discussions on jclouds-dev earlier in the year for this include "equals/hashcode/toString conclusion" and "using commons-lang for equals/hashCode/toString". |
|
Could also mention that utility classes of static methods are frowned upon, except for things like |
|
fyi, github has a nifty feature that if there is a CONTRIBUTING or CONTRIBUTING.md file in the root of the repo it gets referenced as "guideline" when people are submitting pull requests [1]. We could use that feature for the set of principles that will be distilled from this thread, store that in jclouds/jclouds and reference it from here. wdyt? |
|
yeah, we can put a link to the effective jclouds core book in such a file. |
an attempt to start making rationale more transparent