From 98df7f3f8c2d02bf831dfec08299360e0f330753 Mon Sep 17 00:00:00 2001 From: elijah Date: Wed, 20 Feb 2013 00:44:39 -0800 Subject: updated documents to take advantage of new markup syntax and remove locales. --- docs/platform/config.md | 3 +-- docs/platform/en.md | 26 ++++++++++++++------------ docs/platform/quick-start.md | 4 ++-- 3 files changed, 17 insertions(+), 16 deletions(-) (limited to 'docs/platform') diff --git a/docs/platform/config.md b/docs/platform/config.md index c7daa47..5ebee89 100644 --- a/docs/platform/config.md +++ b/docs/platform/config.md @@ -1,5 +1,4 @@ -Configuration files -=================================== +@title = "Configuration Files" File format ------------------------------------------- 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). diff --git a/docs/platform/quick-start.md b/docs/platform/quick-start.md index b348f40..81ad509 100644 --- a/docs/platform/quick-start.md +++ b/docs/platform/quick-start.md @@ -1,5 +1,5 @@ -LEAP Platform Quick Start -===================================================== +@title = 'LEAP Platform Quick Start' +@nav_title = 'Quick Start' This is a very minimal tutorial that will walk you through the process of creating and deploying a service provider running the LEAP platform. -- cgit v1.2.3