From 623702f4749a1b12e728257debcacd55d1447cd4 Mon Sep 17 00:00:00 2001 From: joeduffy Date: Wed, 16 Nov 2016 18:08:32 -0800 Subject: [PATCH] Make a few minor edits to the docs --- docs/architecture.md | 4 ++++ docs/metadata.md | 14 +++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 6d843d26a..821de0e8c 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -89,6 +89,10 @@ TODO(joe): describe blue/green zero downtime deployments. ### Command Line Interface + mu check + mu diff + mu build + TODO(joe): deployment, ongoing interactions, management, etc. ## System Services diff --git a/docs/metadata.md b/docs/metadata.md index 2baac67c9..6f36515c5 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -20,7 +20,7 @@ to the API documentation for the context object (TODO(joe): do this) for details ## Package Managament Each Mufile begins with some standard "package manager"-like metadata, like name, version, description, and so on. As -with most package managers, most of these elements are optional: +with most package managers, most of these elements are optional. For example: name: elk version: 1.0.1 @@ -28,6 +28,10 @@ with most package managers, most of these elements are optional: author: Joe Smith website: https://github.com/joesmith/elk +TODO(joe): full set of attributes. + +In addition to basic metadata like this, any dependency packages must also be listed explicitly. + TODO(joe): finish this section. ## Security @@ -260,7 +264,7 @@ multiple Services inside of the same Mufile. For example, consider a container stacks: private: - - common: + common: type: mu/container image: acmecorp/great env: @@ -273,16 +277,16 @@ Now that we've defined `common`, we can go ahead and create it, without needing services: private: - - data: + data: type: common env: DATA: true public: - - master: + master: type: common env: MASTER: true - - worker: + worker: type: common env: HTTP: true