Make a few minor edits to the docs

This commit is contained in:
joeduffy 2016-11-16 18:08:32 -08:00
parent d44a2c95ff
commit 623702f474
2 changed files with 13 additions and 5 deletions

View file

@ -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

View file

@ -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 <joesmith@elk.com>
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