search

projectatomic / nulecule

[UNMAINTAINED] Specification describing a container-based application
209 stars 46 forks source link

Cleaning up Nulecule spec / easier to newcomers to read / remove all JSON #208

Open cdrage opened 8 years ago

cdrage commented 8 years ago

Please feel free to have a look at: https://github.com/projectatomic/atomicapp/blob/master/docs/nulecule.md

At how I implemented this.

Could we change the Nulecule spec to something that's a lot simpler / easier-to-read similar to how I've done it with the nulecule.md documentation on Atomic App?

No more messy JSON + more simplified doc (just one README.md and associated files) that cleanly describe the spec.

cdrage commented 8 years ago

ping @bexelbie @goern @dustymabe

goern commented 8 years ago

What did you try to archive with atomicapp/docs/nulecule.md ? It looks like you removed the JSON example, put one complete example at the end and removed some explanatory text.

cdrage commented 8 years ago

@goern Better clarification / easier to understand.

I remove the JSON "scheme" examples from the /nulecule spec as even I found them confusing hwne trying to understand it.

Like I said it's a rough draft, so I'll be adding more explanatory details for each-section :) But yes, the complete example at the end is meant to show-case the entirety of the spec.