search

projectatomic / nulecule

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

[ROUGH DRAFT] Reorganize docs into a single folder and clean up spec description #209

Open cdrage opened 8 years ago

cdrage commented 8 years ago

This is roughly what I would vision it to be. I've copied-pasted the doc that I did with nulecule.md on the atomicapp repo. There's a few things missing (for example, spec we say we can use ftp://, https://, etc. as source, but right now we use docker://) that I still need to add. But I just want people's input first on this before I proceed.

Feel free to have a look at it and let me know what you think.

Fixes #208

Feel free to view it at my branch if you wish: https://github.com/cdrage/nulecule/tree/update-docs

or the https://github.com/cdrage/nulecule/blob/update-docs/SPECIFICATION.md too.

cdrage commented 8 years ago

Would possibly help with #202 and #113 to make maintainability a lot easier.

cdrage commented 8 years ago

@goern do you agree that this is cleaner / better for easy-of-entry to Nulecule?

cdrage commented 8 years ago

@goern @dustymabe @rtnpro @kadel

Could I get some feedback :)

cdrage commented 8 years ago

ping @goern @dustymabe @rtnpro @kadel

rtnpro commented 8 years ago

@cdrage In general, it looks good. However, I left a few comments in some places :)

dustymabe commented 8 years ago

Why did we delete all of the files in the spec/ directory? I've never used them but they look like schema validation files that could be really useful at some point.

dustymabe commented 8 years ago

There are quite a few differences between spec/README.md (from before your commit) and SPECIFICATION.md after your commit. Any justification for all of those changes? Can you break the rename and the changes into separate commits?