summaryrefslogtreecommitdiff
path: root/docs/platform/en.md
diff options
context:
space:
mode:
authorelijah <elijah@riseup.net>2013-02-20 00:44:39 -0800
committerelijah <elijah@riseup.net>2013-02-20 00:44:39 -0800
commit98df7f3f8c2d02bf831dfec08299360e0f330753 (patch)
tree5bddf219ef6149fd63716e47d04df29426edeaa6 /docs/platform/en.md
parent6655caf4c85016eb1c96cad52b6b10f19cee6605 (diff)
updated documents to take advantage of new markup syntax and remove locales.
Diffstat (limited to 'docs/platform/en.md')
-rw-r--r--docs/platform/en.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/docs/platform/en.md b/docs/platform/en.md
index 194a070..d3dba9b 100644
--- a/docs/platform/en.md
+++ b/docs/platform/en.md
@@ -1,5 +1,6 @@
-LEAP Platform Tools
-=================================
+@title = 'LEAP Platform for Service Providers'
+@nav_title = 'Provider Platform'
+@toc = true
If you have ever been a sysadmin for an organization or company that provides communication services to end users, you have probably screamed this many times:
@@ -36,13 +37,14 @@ A "provider instance" is a directory tree (typically tracked in git) containing
A minimal provider instance directory looks like this:
- └── myprovider # provider instance directory
- ├── common.json # settings common to all nodes
- ├── Leapfile # specifies which platform recipe directory to use
- ├── provider.json # global settings of the provider
- ├── files/ # keys, certificates, and other files.
- ├── nodes/ # a directory for node configurations, one node per file
- └── users/ # public key information for privileged sysadmins
+ └── bitmask # provider instance directory.
+ ├── common.json # settings common to all nodes.
+ ├── Leapfile # various settings for this instance.
+ ├── provider.json # global settings of the provider.
+ ├── files/ # keys, certificates, and other files.
+ ├── nodes/ # a directory for node configurations.
+ └── users/ # public key information for privileged sysadmins.
+
A provider instance directory contains everything needed to manage all the servers that compose a provider's infrastructure. Because of this, you can use normal git development work-flow to manage your provider instance.
@@ -73,6 +75,6 @@ Getting started
We recommend you read the platform documentation in this order:
1. [quick start tutorial](platform/quick-start).
-* platform [examples](platform/examples).
-* the `leap` [command reference](platform/command).
-* [configuration format](platform/config).
+2. platform [examples](platform/examples).
+3. the `leap` [command reference](platform/command).
+4. [configuration format](platform/config).