diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | docs/README.md | 15 | ||||
| -rw-r--r-- | docs/platform/amber/config.rb | 4 | ||||
| -rw-r--r-- | docs/platform/amber/layouts/default.html.haml | 74 | ||||
| -rw-r--r-- | docs/platform/amber/menu.txt | 35 | ||||
| l--------- | docs/platform/pages | 1 | ||||
| -rw-r--r-- | pages/docs/platform/services/couchdb.md | 6 | ||||
| -rw-r--r-- | pages/docs/platform/upgrading/upgrade-0-8.md | 6 |
8 files changed, 137 insertions, 7 deletions
@@ -1,4 +1,5 @@ .sass-cache/ public/* !public/.gitkeep -*~
\ No newline at end of file +*~ +docs/platform/public/*
\ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..dd8efa4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +The primary source of platform documentation lives in: + + pages/docs/platform + +However, we would like to also include a static render of this in the +leap_platform source code. + +So, this is a separate amber site just for the platform documentation. + +To generate portable static pages: + + cd docs/platform + amber server + cd /tmp + wget --mirror --convert-links --adjust-extension --page-requisites http://localhost:8000
\ No newline at end of file diff --git a/docs/platform/amber/config.rb b/docs/platform/amber/config.rb new file mode 100644 index 0000000..95df336 --- /dev/null +++ b/docs/platform/amber/config.rb @@ -0,0 +1,4 @@ +@title = "LEAP Platform Documentation" +@default_locale = :en +@locales = [:en] +@short_paths = false diff --git a/docs/platform/amber/layouts/default.html.haml b/docs/platform/amber/layouts/default.html.haml new file mode 100644 index 0000000..db44f9e --- /dev/null +++ b/docs/platform/amber/layouts/default.html.haml @@ -0,0 +1,74 @@ +!!! +%html{:lang => @locals[:locale].to_s} + %head + %title + = @page.nav_title + ' - ' + @site.title + %meta(name="viewport" content="width=device-width, initial-scale=1.0") + %meta(charset="UTF-8") + = html_head_base + :css + body { + background: #444; + display: flex; + flex-direction: row; + padding: 10px; + margin: 0px; + } + #sidebar { + flex: 0 0 250px; + background: white; + margin-right: 10px; + padding: 20px; + } + #sidebar ul { + list-style-type: none; + padding-left: 0px; + margin: 0; + } + #sidebar li { padding: 4px } + #sidebar li a { text-decoration: none } + #sidebar li.active { background: #444 } + #sidebar li.active a { color: white } + #sidebar li.level1 { padding-left: 20px } + #sidebar li.level2 { padding-left: 40px } + #main { + flex: 1 1 auto; + background: white; + padding: 20px; + } + #title-box { + padding-bottom: 20px; + border-bottom: 5px solid #eee; + } + #title-box h1 { + margin-top: 0px; + } + pre { + padding: 10px; + background: #eef; + } + code { + background: #eef; + } + table {border-collapse: collapse} + table td { + border: 1px solid #ccc; + padding: 4px; + vertical-align: top; + } + + %body + #sidebar + %ul + - home = @page.path.empty? ? 'active' : '' + %li{:class => home} + %a{:href => '/'} Home + - navigation_items(@site.menu, 0) do |item| + %li{:class => "#{item[:active]} level#{item[:level]}"} + %a{:href => item[:href], :class => ''}= item[:label] + #main + #title-box + = yield :title + #summary= @page.props.summary + #content-box + = yield :content diff --git a/docs/platform/amber/menu.txt b/docs/platform/amber/menu.txt new file mode 100644 index 0000000..819600a --- /dev/null +++ b/docs/platform/amber/menu.txt @@ -0,0 +1,35 @@ +guide + getting-started + config + nodes + keys-and-certificates + domains + provider-configuration + environments + virtual-machines + miscellaneous + commands +tutorials + quick-start + single-node-vpn + single-node-email + vagrant +services + couchdb + openvpn + monitor + mx + soledad + tor + webapp +upgrading + upgrade-0-8 +troubleshooting + tests + known-issues + where-to-look +details + faq + development + ports + under-the-hood diff --git a/docs/platform/pages b/docs/platform/pages new file mode 120000 index 0000000..5ecfaa3 --- /dev/null +++ b/docs/platform/pages @@ -0,0 +1 @@ +../../pages/docs/platform
\ No newline at end of file diff --git a/pages/docs/platform/services/couchdb.md b/pages/docs/platform/services/couchdb.md index 862ca56..b43d98b 100644 --- a/pages/docs/platform/services/couchdb.md +++ b/pages/docs/platform/services/couchdb.md @@ -71,10 +71,10 @@ Beware that this returns the uncompacted disk size (see http://wiki.apache.org/c ### Migrating from BigCouch to plain CouchDB -<%= render :partial => 'docs/platform/common/bigcouch_migration_begin.md' %> +<%= render :partial => '../common/bigcouch_migration_begin.md' %> -<%= render :partial => 'docs/platform/common/bigcouch_migration_end.md' %> +<%= render :partial => '../common/bigcouch_migration_end.md' %> -<%= render :partial => 'docs/platform/common/bigcouch_migration_finish.md' %> +<%= render :partial => '../common/bigcouch_migration_finish.md' %> diff --git a/pages/docs/platform/upgrading/upgrade-0-8.md b/pages/docs/platform/upgrading/upgrade-0-8.md index 84e9cee..79ef573 100644 --- a/pages/docs/platform/upgrading/upgrade-0-8.md +++ b/pages/docs/platform/upgrading/upgrade-0-8.md @@ -18,7 +18,7 @@ Upgrading to Platform 0.8 ### Step 2: Prepare to migrate from BigCouch to CouchDB -<%= render :partial => 'docs/platform/common/bigcouch_migration_begin.md' %> +<%= render :partial => '../common/bigcouch_migration_begin.md' %> ### Step 3: Upgrade from Debian Wheezy to Jessie @@ -127,7 +127,7 @@ You will need to deploy the 0.8 version of LEAP Platform to the couch node befor ### Step 5: Import Data into CouchDB -<%= render :partial => 'docs/platform/common/bigcouch_migration_end.md' %> +<%= render :partial => '../common/bigcouch_migration_end.md' %> ### Step 6: Deploy everything @@ -138,4 +138,4 @@ Now that you've upgraded all nodes to Jessie, and migrated to CouchDB, you are r ### Step 7: Test and cleanup -<%= render :partial => 'docs/platform/common/bigcouch_migration_finish.md' %> +<%= render :partial => '../common/bigcouch_migration_finish.md' %> |