summaryrefslogtreecommitdiff
path: root/spec.mdwn
Commit message (Collapse)AuthorAgeFilesLines
* Document submodule spec changesDaniel Firth2016-03-221-1/+14
| | | | Change-Id: Icc0aba5072cb4dd656e88855cdf2cbbb51c7caf9
* Raise some headings up by a levelSam Thursfield2016-03-011-17/+20
| | | | | | | | | As well as making the spec more readable, 2nd-level (----) headings show up in the sidebar generated by 'mkdocs', and are internal page anchors that we can link to. This allows more linking to between different sections of the spec. Change-Id: I35d4cf5e86b01fde3195944875640669d18dbca8
* Document the DEFAULTS file, and rewrite description of chunksSam Thursfield2016-03-011-87/+139
| | | | Change-Id: Ie4e693fe37252860110b4d5ff0b7d172c7dae415
* Describe what chunks, systems & strata actually are, and link to schemasSam Thursfield2016-03-011-8/+42
| | | | | | | | | | | | | | | The spec was trying to be technically precise about describing the structure of the .morph files. The JSON-Schema format is much better than prose for precisely describing structure of JSON/YAML documents, so we should link to the schemas. The text of the spec can then be rewritten a bit so it describes the intention and meaning of the different .morph files a bit more clearly. More rewriting would be useful. It's also unfortunate that we have go as far as 4th-level headings (####), reorganising a bit could fix that. Change-Id: Ic502db0b5723a46f72d9cf375df623ad89b4686d
* Move deployment into a separate pageSam Thursfield2016-03-011-111/+2
| | | | | | | | | | | Deployment is pretty unrelated to the definitions format, it's mostly about how to run programs in the extensions/ directory. So I think it makes sense to describe it in a separate page. This helps shorten the 'Definitions format' page, which is pretty long right now. Change-Id: I13684a3cc0bc8bdd7c9c043dd2a9ee2addac0d6a
* Update description of how deployment worksSam Thursfield2016-03-011-33/+15
| | | | | | It's not Morph-specific any more. Change-Id: I0742c21de14f6bb660ad60dd3b37242fd3067711
* Allow rendering the spec as a websiteSam Thursfield2016-02-291-24/+16
| | | | | | | | | | The website isn't too pretty so far (especially when Javascript is disabled), help welcome on that front. It should be usable though. You can install mkdocs and the mkdocs-material theme from PyPI, then run `mkdocs serve` to test changes locally. Change-Id: Iaa33f936310f6e126f50e095e0b924babbdd8540
* Creation of Baserock definitions format specification repoSam Thursfield2016-02-201-0/+518
This contains: - textual description of the Baserock definitions format, and the list of changes since version 0, taken from: git://baserock.branchable.com/ - migrations and schemas taken from git://git.baserock.org/baserock/baserock/definitions.