[ROUGH DRAFT] Reorganize docs into a single folder and clean up spec description#209
[ROUGH DRAFT] Reorganize docs into a single folder and clean up spec description#209cdrage wants to merge 1 commit intoprojectatomic:masterfrom
Conversation
|
@goern do you agree that this is cleaner / better for easy-of-entry to Nulecule? |
|
@goern @dustymabe @rtnpro @kadel Could I get some feedback :) |
|
ping @goern @dustymabe @rtnpro @kadel |
| appversion | `string` | **Optional.** The semantic version string of the Container Application. | ||
| description | `string` | **Optional.** A human readable description of the Container Application. This may contain information for the deployer of the containerapp. | ||
| license | `License Object`| **Optional.** The license information for the containerapp. | ||
| arbitrary_data | `string` | **Optional.** Arbitrary `key: value` pair(s) of metadata. May contain nested objects. |
There was a problem hiding this comment.
I don't like the ring of it :\
There was a problem hiding this comment.
me neither, but it was copied from the nulecule spec
|
@cdrage In general, it looks good. However, I left a few comments in some places :) |
|
|
||
| ## Specification | ||
|
|
||
| An actively maintained page on the specifics of the specification can be found at [SPECIFICATION.md](SPECIFICATION.md). |
There was a problem hiding this comment.
maybe s/specifics/details/ "specifics of the specification" sounds funny :)
|
Why did we delete all of the files in the |
| This is only a specification. Implementations may be written in any language. See [implementation guide](IMPLEMENTATION_GUIDE.md) for more details. | ||
|
|
||
| **Reference implementation** https://github.com/projectatomic/atomicapp | ||
| **Reference implementation:** https://github.com/projectatomic/atomicapp |
There was a problem hiding this comment.
Still would rather not use the words "reference implementation" here. Let's just list Atomic App as an implementation, but not the reference implementation.
|
There are quite a few differences between |
3 participants
This is roughly what I would vision it to be. I've copied-pasted the doc that I did with
nulecule.mdon 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.