summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorelijah <elijah@riseup.net>2016-08-29 23:59:51 -0700
committerelijah <elijah@riseup.net>2016-08-29 23:59:51 -0700
commite4938d4fbe03caa3779be67b70fd346246a7af75 (patch)
tree4dda1c0f52f23a18d4225c03c961980636abaa98 /docs/README.md
parent0ee63f658230533a7b5645e104b012c665e1a962 (diff)
added 'docs' folder, for creating portable static mirrors of parts of leap_se
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md15
1 files changed, 15 insertions, 0 deletions
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