You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by al...@apache.org on 2016/02/25 16:39:39 UTC
[01/10] brooklyn-docs git commit: Renamed files & scripts
Repository: brooklyn-docs
Updated Branches:
refs/heads/master 7d24e76b3 -> c87b43fbb
Renamed files & scripts
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/70c731f4
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/70c731f4
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/70c731f4
Branch: refs/heads/master
Commit: 70c731f48844907615f2e82b7cfcfe359da86ca3
Parents: 5985336
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Mon Feb 8 12:10:32 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:50:25 2016 +0000
----------------------------------------------------------------------
README.md | 2 ++
_build/build.sh | 4 ++--
_config.yml | 7 ++++++-
singlePageManual.html | 26 --------------------------
singlePageStarted.html | 25 -------------------------
zoneMergeManual.html | 28 ++++++++++++++++++++++++++++
zoneMergeStarted.html | 27 +++++++++++++++++++++++++++
7 files changed, 65 insertions(+), 54 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 9f2465b..5b6cf54 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,8 @@ Some issues we've encountered are:
(more details [here](http://www.nokogiri.org/tutorials/installing_nokogiri.html))
* on Ubuntu, `sudo apt-get install libxslt-dev libxml2-dev`
+If you are building the PDF documentation, this requires [wkhtmltopdf](http://wkhtmltopdf.org/).
+You can download it from [here](http://wkhtmltopdf.org/downloads.html) or use the usual apt-get / yum / brew.
Seeing the Website and Docs
---------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/_build/build.sh
----------------------------------------------------------------------
diff --git a/_build/build.sh b/_build/build.sh
index ee3d331..7b734d5 100755
--- a/_build/build.sh
+++ b/_build/build.sh
@@ -191,10 +191,10 @@ function build_pdf() {
PDF_STARTED_LOG="_pdf/pdf_gen_started.log"
if [ "$SKIP_PDF_MANUAL" != "true" ]; then
- _build/buildPDF.sh "_site/singlePageManual.html" "_pdf/UserManual.pdf" 2>&1 | tee $PDF_MANUAL_LOG
+ _build/buildPDF.sh "_site/zoneMergeManual.html" "_pdf/UserManual.pdf" 2>&1 | tee $PDF_MANUAL_LOG
fi
if [ "$SKIP_PDF_STARTED" != "true" ]; then
- _build/buildPDF.sh "_site/singlePageStarted.html" "_pdf/GettingStarted.pdf" 2>&1 | tee $PDF_STARTED_LOG
+ _build/buildPDF.sh "_site/zoneMergeStarted.html" "_pdf/GettingStarted.pdf" 2>&1 | tee $PDF_STARTED_LOG
fi
}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index 7b634b2..bb44fb5 100644
--- a/_config.yml
+++ b/_config.yml
@@ -29,7 +29,7 @@ path:
guide: /guide
website: /website
v: /v
-
+
# Use local copies of dependencies in dev build (switched to remote using URLs for prod build)
dependency_mode: local
dependency_urls:
@@ -46,7 +46,12 @@ sass:
sass_dir: style/css
brooklyn-stable-version: 0.8.0-incubating
+brooklyn-base-url: https://brooklyn.apache.org
+pdf-rewrite-prefixes:
+ '/guide' : '/v/0.9.0-SNAPSHOT'
+ '/website' : ''
+
brooklyn-version: 0.9.0-SNAPSHOT # BROOKLYN_VERSION
brooklyn-snapshot-git-branch: master # if line above is SNAPSHOT this should point to corresponding git branch (e.g. master, 0.4)
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/singlePageManual.html
----------------------------------------------------------------------
diff --git a/singlePageManual.html b/singlePageManual.html
deleted file mode 100644
index bfdfa69..0000000
--- a/singlePageManual.html
+++ /dev/null
@@ -1,26 +0,0 @@
----
-title: Apache Brooklyn Manual
-layout: singlePage
-page_mask: usermanual-pdf-exclude
----
- <div id="content_container" class="container">
- <header>
- <h1>Apache Brooklyn: User Manual</h1>
- </header>
- <h1>Contents</h1>
-
- <nav><ul>
- {% assign visited = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-item.html %}
- {% endfor %}
- </ul></nav>
-
- {% assign visitedb = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-content.html %}
- {% endfor %}
-
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/singlePageStarted.html
----------------------------------------------------------------------
diff --git a/singlePageStarted.html b/singlePageStarted.html
deleted file mode 100644
index 9e527eb..0000000
--- a/singlePageStarted.html
+++ /dev/null
@@ -1,25 +0,0 @@
----
-title: Apache Brooklyn Manual
-layout: singlePage
-page_mask: started-pdf-exclude
----
- <div id="content_container" class="container">
- <header>
- <h1>Apache Brooklyn: Getting Started Guide</h1>
- </header>
- <h1>Contents</h1>
-
- <nav><ul>
- {% assign visited = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-item.html %}
- {% endfor %}
- </ul></nav>
-
- {% assign visitedb = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-content.html %}
- {% endfor %}
- </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/zoneMergeManual.html
----------------------------------------------------------------------
diff --git a/zoneMergeManual.html b/zoneMergeManual.html
new file mode 100644
index 0000000..e088395
--- /dev/null
+++ b/zoneMergeManual.html
@@ -0,0 +1,28 @@
+---
+title: Apache Brooklyn Manual
+layout: singlePage
+page_mask: usermanual-pdf-exclude
+---
+{% comment %}<!-- This page builds the single page manual for the PDF, note that this name must be retained for conversion order -->{% endcomment %}
+
+ <div id="content_container" class="container">
+ <header>
+ <h1>Apache Brooklyn: User Manual</h1>
+ </header>
+ <h1>Contents</h1>
+
+ <nav><ul>
+ {% assign visited = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ </ul></nav>
+
+ {% assign visitedb = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+
+ </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/70c731f4/zoneMergeStarted.html
----------------------------------------------------------------------
diff --git a/zoneMergeStarted.html b/zoneMergeStarted.html
new file mode 100644
index 0000000..11323b7
--- /dev/null
+++ b/zoneMergeStarted.html
@@ -0,0 +1,27 @@
+---
+title: Apache Brooklyn Manual
+layout: singlePage
+page_mask: started-pdf-exclude
+---
+{% comment %}<!-- This page builds the single page getting started for the PDF, note that this name must be retained for conversion order -->{% endcomment %}
+
+ <div id="content_container" class="container">
+ <header>
+ <h1>Apache Brooklyn: Getting Started Guide</h1>
+ </header>
+ <h1>Contents</h1>
+
+ <nav><ul>
+ {% assign visited = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ </ul></nav>
+
+ {% assign visitedb = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+ </div>
\ No newline at end of file
[07/10] brooklyn-docs git commit: Updates to spacing and script
Posted by al...@apache.org.
Updates to spacing and script
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/b6ae8329
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/b6ae8329
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/b6ae8329
Branch: refs/heads/master
Commit: b6ae8329c7aa8b11c703b0748e84e9e5b586287a
Parents: de1d17f
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Mon Feb 22 13:58:07 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:52:55 2016 +0000
----------------------------------------------------------------------
_build/buildPDF.sh | 9 ++++---
style/css/singlePage.css | 60 +++++++++++++++++++++----------------------
zoneMergeManual.html | 32 +++++++++++------------
zoneMergeStarted.html | 31 +++++++++++-----------
4 files changed, 67 insertions(+), 65 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b6ae8329/_build/buildPDF.sh
----------------------------------------------------------------------
diff --git a/_build/buildPDF.sh b/_build/buildPDF.sh
index a3d1196..a41ca69 100755
--- a/_build/buildPDF.sh
+++ b/_build/buildPDF.sh
@@ -7,14 +7,15 @@ if [ ! -x _build/build.sh ] ; then
exit 1
fi
-if [ "$#" -lt 2 ] ; then
+if [ "$#" -ne 2 ] ; then
echo "Usage: buildPDF.sh <source html> <target PDF>"
exit 1
fi
-command -v wkhtmltopdf >/dev/null 2>&1 || {
- echo "ERROR: script requires wkhtmltopdf but it's not installed." >&2; exit 1;
- }
+if ! command -v wkhtmltopdf >/dev/null 2>&1; then
+ echo "ERROR: script requires wkhtmltopdf but it's not installed."
+ exit 1
+fi
# run the PDF build with wkhtmltopdf
wkhtmltopdf --page-size Letter --margin-top 0.75in --margin-right 0.75in --margin-bottom 0.75in --margin-left 0.75in --encoding UTF-8 $1 $2
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b6ae8329/style/css/singlePage.css
----------------------------------------------------------------------
diff --git a/style/css/singlePage.css b/style/css/singlePage.css
index 0517ddb..07d7395 100644
--- a/style/css/singlePage.css
+++ b/style/css/singlePage.css
@@ -1,56 +1,56 @@
/* Fix the bootstrap parts so they show the content not the controls*/
.nav.nav-tabs{
- display: none;
+ display: none;
}
.tab-content > .tab-pane {
- display: inline;
+ display: inline;
}
.fade {
- opacity: 1;
+ opacity: 1;
}
#next, *[id$='_next']{
- display: none;
+ display: none;
}
.collapse {
- display: block;
+ display: block;
}
.section-breaker {
- page-break-before:always;
+ page-break-before:always;
}
.panel-heading{
- padding-bottom: 15px;
+ padding-bottom: 15px;
}
/* The styled bootstrap panels */
.panel-body, .panel-default{
- background: none;
- border: 0px solid #fff !important;
- box-shadow: none;
- padding: 0px;
+ background: none;
+ border: 0px solid #fff !important;
+ box-shadow: none;
+ padding: 0px;
}
.panel-default > .panel-heading{
- background: none;
- border: 0px solid #fff !important;
- box-shadow: none;
- padding-top: 0px;
- padding-right: 0px;
- padding-left: 0px;
+ background: none;
+ border: 0px solid #fff !important;
+ box-shadow: none;
+ padding-top: 0px;
+ padding-right: 0px;
+ padding-left: 0px;
}
pre, pre code{
- overflow: auto;
- white-space: pre-wrap; /* CSS 3 */
- white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
- white-space: -pre-wrap; /* Opera 4-6 */
- white-space: -o-pre-wrap; /* Opera 7 */
- word-wrap: break-word; /* Internet Explorer 5.5+ */
+ overflow: auto;
+ white-space: pre-wrap; /* CSS 3 */
+ white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ word-wrap: break-word; /* Internet Explorer 5.5+ */
}
.goToTop{
- padding-right: 25px;
- padding-top: 75px;
- float: right;
- font-size: 20pt;
- font-weight: bold;
+ padding-right: 25px;
+ padding-top: 75px;
+ float: right;
+ font-size: 20pt;
+ font-weight: bold;
}
#content_container h1{
- display: inline-block;
- width: 95%;
+ display: inline-block;
+ width: 95%;
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b6ae8329/zoneMergeManual.html
----------------------------------------------------------------------
diff --git a/zoneMergeManual.html b/zoneMergeManual.html
index 89c57f1..d1b8e6e 100644
--- a/zoneMergeManual.html
+++ b/zoneMergeManual.html
@@ -8,24 +8,24 @@ availablePages: []
---
{% comment %}<!-- This page builds the single page manual for the PDF, note that this name must be retained for conversion order -->{% endcomment %}
- <div id="content_container" class="container">
+<div id="content_container" class="container">
<header>
<h1 id="content-top">Apache Brooklyn: User Manual</h1>
</header>
- <h1>Contents</h1>
+ <h1>Contents</h1>
- <nav><ul>
- {% assign visited = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-item.html %}
- {% endfor %}
- </ul></nav>
-
- {% assign visitedb = "" | split: "|" %}
+ <nav><ul>
+ {% assign visited = "" | split: "|" %}
{% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-content.html %}
- {% endfor %}
-
- </div>
\ No newline at end of file
+ {% push site_items node %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ </ul></nav>
+
+ {% assign visitedb = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+
+</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b6ae8329/zoneMergeStarted.html
----------------------------------------------------------------------
diff --git a/zoneMergeStarted.html b/zoneMergeStarted.html
index 3cf4710..e4d703a 100644
--- a/zoneMergeStarted.html
+++ b/zoneMergeStarted.html
@@ -8,23 +8,24 @@ availablePages: []
---
{% comment %}<!-- This page builds the single page getting started for the PDF, note that this name must be retained for conversion order -->{% endcomment %}
- <div id="content_container" class="container">
+<div id="content_container" class="container">
<header>
<h1 id="content-top">Apache Brooklyn: Getting Started Guide</h1>
</header>
- <h1>Contents</h1>
+ <h1>Contents</h1>
- <nav><ul>
- {% assign visited = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-item.html %}
- {% endfor %}
- </ul></nav>
+ <nav><ul>
+ {% assign visited = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ </ul></nav>
- {% assign visitedb = "" | split: "|" %}
- {% for node in site.data.menu %}
- {% push site_items node %}
- {% include singlepage-content.html %}
- {% endfor %}
- </div>
\ No newline at end of file
+ {% assign visitedb = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+
+</div>
\ No newline at end of file
[04/10] brooklyn-docs git commit: Fixed merging error
Posted by al...@apache.org.
Fixed merging error
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/247a1b5b
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/247a1b5b
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/247a1b5b
Branch: refs/heads/master
Commit: 247a1b5b13ab00b390f4f23d14b68807de557aae
Parents: cbdf51d
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Tue Feb 2 11:23:09 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:50:25 2016 +0000
----------------------------------------------------------------------
_build/build.sh | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/247a1b5b/_build/build.sh
----------------------------------------------------------------------
diff --git a/_build/build.sh b/_build/build.sh
index 1438424..6081145 100755
--- a/_build/build.sh
+++ b/_build/build.sh
@@ -31,7 +31,7 @@ function help() {
echo "* --skip-javadoc : to skip javadoc build"
echo "* --quick-javadoc : to do a quick javadoc build (for testing)"
echo "* --serve : serve files from _site after building (for testing)"
- echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../incubator-brooklyn-site-public)"
+ echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../brooklyn-site-public)"
echo "* --skip-htmlproof : skip the HTML Proof run on _site"
echo "* --quick-htmlproof : do a fast HTML Proof run on _site (not checking external links)"
echo "* --skip-pdf : skip generation of the PDF Documentation"
@@ -189,6 +189,7 @@ function test_site() {
return
fi
echo "Running htmlproof on _site"
+ mkdir -p _build/target
HTMLPROOF_LOG="_build/target/htmlproof.log"
if [ "$QUICK_HTMLPROOF" == "true" ]; then
HTMLPROOF_OPTS="$HTMLPROOF_OPTS --disable_external"
@@ -268,8 +269,8 @@ function make_install() {
fi
if [ ! -z ${QUICK_JAVADOC+SET} ]; then echo "ERROR: --install not permitted when doing quick javadoc" ; return 1 ; fi
- SITE_DIR=${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
- ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find incubator-brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; }
+ SITE_DIR=${BROOKLYN_SITE_DIR-../../brooklyn-site-public}
+ ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; }
if [ -z ${INSTALL_RSYNC_OPTIONS+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi
if [ -z ${INSTALL_RSYNC_SUBDIR+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi
[09/10] brooklyn-docs git commit: Exclusion and style updates
Posted by al...@apache.org.
Exclusion and style updates
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/de1d17fc
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/de1d17fc
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/de1d17fc
Branch: refs/heads/master
Commit: de1d17fc53254e12d93765debbbfc120cdb1c3ec
Parents: ad3cad8
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Wed Feb 10 09:34:13 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:52:55 2016 +0000
----------------------------------------------------------------------
style/css/singlePage.css | 2 +-
website/download/index.md | 2 ++
website/learnmore/catalog/catalog-item.html | 2 ++
website/learnmore/catalog/index.html | 2 ++
4 files changed, 7 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/de1d17fc/style/css/singlePage.css
----------------------------------------------------------------------
diff --git a/style/css/singlePage.css b/style/css/singlePage.css
index f8f14f6..0517ddb 100644
--- a/style/css/singlePage.css
+++ b/style/css/singlePage.css
@@ -8,7 +8,7 @@
.fade {
opacity: 1;
}
-#next{
+#next, *[id$='_next']{
display: none;
}
.collapse {
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/de1d17fc/website/download/index.md
----------------------------------------------------------------------
diff --git a/website/download/index.md b/website/download/index.md
index 077e068..c4fc01e 100644
--- a/website/download/index.md
+++ b/website/download/index.md
@@ -1,6 +1,8 @@
---
layout: website-normal
title: Download
+started-pdf-exclude: true
+usermanual-pdf-exclude: true
children:
- { path: /guide/misc/download.md, title: Details }
- { path: verify.md, title: Verify }
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/de1d17fc/website/learnmore/catalog/catalog-item.html
----------------------------------------------------------------------
diff --git a/website/learnmore/catalog/catalog-item.html b/website/learnmore/catalog/catalog-item.html
index abff4c4..f0e0108 100644
--- a/website/learnmore/catalog/catalog-item.html
+++ b/website/learnmore/catalog/catalog-item.html
@@ -1,5 +1,7 @@
---
title: Catalog
+page_mask: usermanual-pdf-exclude
+page_mask: started-pdf-exclude
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/de1d17fc/website/learnmore/catalog/index.html
----------------------------------------------------------------------
diff --git a/website/learnmore/catalog/index.html b/website/learnmore/catalog/index.html
index 10257c0..5f97fed 100644
--- a/website/learnmore/catalog/index.html
+++ b/website/learnmore/catalog/index.html
@@ -1,6 +1,8 @@
---
layout: base
title: Catalog
+page_mask: usermanual-pdf-exclude
+page_mask: started-pdf-exclude
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
[10/10] brooklyn-docs git commit: This closes #4
Posted by al...@apache.org.
This closes #4
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/c87b43fb
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/c87b43fb
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/c87b43fb
Branch: refs/heads/master
Commit: c87b43fbb638a52651b12a5843890bf8b90f8d2d
Parents: 7d24e76 f78c5e9
Author: Aled Sage <al...@gmail.com>
Authored: Thu Feb 25 15:39:16 2016 +0000
Committer: Aled Sage <al...@gmail.com>
Committed: Thu Feb 25 15:39:16 2016 +0000
----------------------------------------------------------------------
.gitignore | 1 +
README.md | 2 +
_build/build.sh | 36 ++++++
_build/buildPDF.sh | 28 +++++
_config.yml | 8 +-
_includes/singlepage-content.html | 51 +++++++++
_includes/singlepage-item.html | 41 +++++++
_layouts/singlePage.html | 30 +++++
_plugins/regex_filter.rb | 118 ++++++++++++++++++++
_plugins/stringTools.rb | 35 ++++++
guide/concepts/stop-start-restart-behaviour.md | 4 +-
guide/dev/index.md | 1 +
guide/java/index.md | 1 +
guide/misc/index.md | 1 +
guide/ops/index.md | 1 +
guide/start/blueprints.md | 8 +-
guide/start/index.md | 1 +
guide/start/managing.md | 24 ++--
guide/start/running.md | 15 ++-
style/css/singlePage.css | 56 ++++++++++
website/community/index.md | 2 +
website/developers/index.md | 1 +
website/documentation/index.md | 1 +
website/download/index.md | 2 +
website/learnmore/blueprint-tour.md | 1 +
website/learnmore/catalog/catalog-item.html | 2 +
website/learnmore/catalog/index.html | 2 +
website/learnmore/index.md | 1 +
website/meta/sitemap.md | 1 +
website/meta/versions.md | 1 +
zoneMergeManual.html | 31 +++++
zoneMergeStarted.html | 31 +++++
32 files changed, 519 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
[02/10] brooklyn-docs git commit: Updated single page theme
Posted by al...@apache.org.
Updated single page theme
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/59853364
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/59853364
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/59853364
Branch: refs/heads/master
Commit: 598533648ef48da07ecdedc45c5d37a0a97dc7fa
Parents: 247a1b5
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Fri Feb 5 11:56:35 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:50:25 2016 +0000
----------------------------------------------------------------------
_build/build.sh | 21 ++++++++++--
_includes/singlepage-content.html | 32 +++++++++--------
_includes/singlepage-item.html | 14 ++------
_layouts/singlePage.html | 8 +++++
_plugins/stringTools.rb | 26 ++++++++++++++
guide/concepts/stop-start-restart-behaviour.md | 4 +--
guide/start/blueprints.md | 2 +-
guide/start/running.md | 2 +-
singlePageManual.html | 6 ++--
singlePageStarted.html | 5 ++-
style/css/singlePage.css | 38 +++++++++++++++++++++
website/learnmore/blueprint-tour.md | 1 +
12 files changed, 121 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/_build/build.sh
----------------------------------------------------------------------
diff --git a/_build/build.sh b/_build/build.sh
index 6081145..ee3d331 100755
--- a/_build/build.sh
+++ b/_build/build.sh
@@ -34,7 +34,9 @@ function help() {
echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../brooklyn-site-public)"
echo "* --skip-htmlproof : skip the HTML Proof run on _site"
echo "* --quick-htmlproof : do a fast HTML Proof run on _site (not checking external links)"
- echo "* --skip-pdf : skip generation of the PDF Documentation"
+ echo "* --skip-pdf : skip generation of all PDF Documentation"
+ echo "* --skip-pdf-manual : skip generation of the PDF Manual"
+ echo "* --skip-pdf-started : skip generation of the Getting Started PDF"
echo ""
}
@@ -161,6 +163,14 @@ function parse_arguments() {
SKIP_PDF=true
shift
;;
+ "--skip-pdf-manual")
+ SKIP_PDF_MANUAL=true
+ shift
+ ;;
+ "--skip-pdf-started")
+ SKIP_PDF_STARTED=true
+ shift
+ ;;
*)
echo "ERROR: invalid argument '"$1"'"
exit 1
@@ -179,8 +189,13 @@ function build_pdf() {
mkdir -p _pdf
PDF_MANUAL_LOG="_pdf/pdf_gen_manual.log"
PDF_STARTED_LOG="_pdf/pdf_gen_started.log"
- _build/buildPDF.sh "_site/singlePageManual.html" "_pdf/UserManual.pdf" 2>&1 | tee $PDF_MANUAL_LOG
- _build/buildPDF.sh "_site/singlePageStarted.html" "_pdf/GettingStarted.pdf" 2>&1 | tee $PDF_STARTED_LOG
+
+ if [ "$SKIP_PDF_MANUAL" != "true" ]; then
+ _build/buildPDF.sh "_site/singlePageManual.html" "_pdf/UserManual.pdf" 2>&1 | tee $PDF_MANUAL_LOG
+ fi
+ if [ "$SKIP_PDF_STARTED" != "true" ]; then
+ _build/buildPDF.sh "_site/singlePageStarted.html" "_pdf/GettingStarted.pdf" 2>&1 | tee $PDF_STARTED_LOG
+ fi
}
# Runs htmlproof against _site
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/_includes/singlepage-content.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-content.html b/_includes/singlepage-content.html
index 4b10bf8..18fc1b7 100644
--- a/_includes/singlepage-content.html
+++ b/_includes/singlepage-content.html
@@ -1,5 +1,5 @@
{% pop site_items item %}
-{% if item[pageMask] != true %}
+{% if item[page.page_mask] != true %}
{% set_hash_entry item path item_path %}
{% set_hash_entry item url item_url %}
@@ -7,15 +7,6 @@
{% set_hash_entry item title item_title %}
{% set_hash_entry item id item_id %}
- {% unless item_path %}
- {% unless item_url %}
- {% puts error, null item_url %}
- {% putp item %}
- {% putv item_url %}
- {% fail item missing path and url (jekyll block evaluation order can cause this) %}
- {% endunless %}
- {% endunless %}
-
{% if visitedb contains item_title %}
{% comment %} <!-- ignore --> {% endcomment %}
{% elsif item['external'] %}
@@ -24,7 +15,7 @@
{% else %}
{% capture pid %}{{ item.title | remove:'/' | replace:' ','-' | downcase }}{% endcapture %}
{% if item_content != null %}
- <div id="contentsLink-{{pid}}" class="section p-{{item_id}}">
+ <div id="contentsLink-{{pid}}" class="section-breaker section p-{{item_id}}">
<h1>{{ item_title }}</h1>
{% comment %}
<!--
@@ -34,13 +25,26 @@
{% comment %}<!-- Build the page directory by removing the file name from the item url -->{% endcomment %}
{% capture page_url %}{{ item_url | replace_regex:'[^\/]*$', '' }}{% endcapture %}
- {% capture new_var %}img src=".{{ page_url }}{% endcapture %}
+
+ {% comment %}<!-- If the URL is prefixed with a pdf-rewrite-prefix, remove it -->{% endcomment %}
+ {% for part in site.pdf-rewrite-prefixes %}
+ {% capture prefixed %}{{ page_url | startsWith: part[0] }}{% endcapture %}
+ {% if prefixed == "true" %}
+ {% capture page_url %}{{ part[1] }}{{ page_url | removePrefix: part[0] }}{% endcapture %}
+ {% endif %}
+ {% endfor %}
+
+ {% capture new_img %}img src=".{{ page_url }}{% endcapture %}
+ {% capture new_href %}href="{{ site.brooklyn-base-url }}{{ brooklyn-version }}{{ page_url }}{% endcapture %}
{% comment %}<!-- Build a regex which replaces the current path with an absolute one but leaves any sub folders such as /images -->{% endcomment %}
- {% capture regex %}(img(.*)src="{{ page_url | replace:'/','\/' }})|(img(.*)src="){% endcapture %}
+ {% capture img_regex %}(img(.*)src="{{ page_url | replace:'/','\/' }})|(img(.*)src="){% endcapture %}
+
+ {% comment %}<!-- Build a regex which replaces the current links with an absolute one but leaves any sub folders such as /images and ignores # or external links -->{% endcomment %}
+ {% capture link_regex %}(href="{{ page_url | replace:'/','\/' }})|(href="(?!http)(?!#)){% endcapture %}
{% comment %}<!-- Filter the content of the included page -->{% endcomment %}
- {% capture content_filtered %}{{ item_content | replace_regex:regex, new_var }}{% endcapture %}
+ {% capture content_filtered %}{{ item_content | replace_regex: img_regex, new_img | replace_regex: link_regex, new_href }}{% endcapture %}
{{ content_filtered }}
</div>
{% endif %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/_includes/singlepage-item.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-item.html b/_includes/singlepage-item.html
index 803cf7e..8725939 100644
--- a/_includes/singlepage-item.html
+++ b/_includes/singlepage-item.html
@@ -1,23 +1,15 @@
{% pop site_items item %}
-{% if item[pageMask] != true %}
-
+{% if item[page.page_mask] != true %}
+
{% set_hash_entry item path item_path %}
{% set_hash_entry item url item_url %}
{% set_hash_entry item title item_title %}
{% set_hash_entry item content item_content %}
{% set_hash_entry item data item_data %}
- {% unless item_path %}
- {% unless item_url %}
- {% puts error, null item_url %}
- {% putp item %}
- {% putv item_url %}
- {% fail item missing path and url (jekyll block evaluation order can cause this) %}
- {% endunless %}
- {% endunless %}
-
{% capture pid %}{{ item.title | remove:'/' | replace:' ','-' | downcase }}{% endcapture %}
<a id="{{ item_path }}" name="{{ item_path }}" href="javascript:void(0);"></a>
+ {{ page.my_array['test'] = 'test' }}
<li>
{% if visited contains item_title %}
{{ item['title'] }} <a href="#link-{{pid}}"><span class="octicon octicon-link-external flip"></span></a>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/_layouts/singlePage.html
----------------------------------------------------------------------
diff --git a/_layouts/singlePage.html b/_layouts/singlePage.html
index 6f45639..adb3c03 100644
--- a/_layouts/singlePage.html
+++ b/_layouts/singlePage.html
@@ -3,7 +3,15 @@
<!DOCTYPE html>
<html>
<head>
+<title>{{ page.title }} - Apache Brooklyn</title>
+<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
+<link href=".{{site.path.style}}/deps/bootstrap.min.css" rel="stylesheet">
+<link href=".{{site.path.style}}/deps/octicons/octicons.css" rel="stylesheet">
+<link href=".{{site.path.style}}/deps/bootstrap-theme.css" rel="stylesheet">
+<link href=".{{site.path.style}}/css/website.css" rel="stylesheet">
+<link rel="stylesheet" href=".{{ site.path.style }}/css/singlePage.css" type="text/css" media="screen" />
+<style>.{{ page.pageMask }}{ display: none; }</style>
</head>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/_plugins/stringTools.rb
----------------------------------------------------------------------
diff --git a/_plugins/stringTools.rb b/_plugins/stringTools.rb
new file mode 100644
index 0000000..929a7c5
--- /dev/null
+++ b/_plugins/stringTools.rb
@@ -0,0 +1,26 @@
+module SliceFilter
+ def slice(input, length, start=0)
+ if length > input.length
+ length = input.length
+ end
+ input[start, length]
+ end
+
+ Liquid::Template.register_filter self
+end
+
+module StartsWithFilter
+ def startsWith(input, startStr)
+ startStr.length < input.length && input[0, startStr.length] == startStr
+ end
+
+ Liquid::Template.register_filter self
+end
+
+module RemovePrefixFilter
+ def removePrefix(input, prefix)
+ input[prefix.length, input.length]
+ end
+
+ Liquid::Template.register_filter self
+end
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/guide/concepts/stop-start-restart-behaviour.md
----------------------------------------------------------------------
diff --git a/guide/concepts/stop-start-restart-behaviour.md b/guide/concepts/stop-start-restart-behaviour.md
index 916ea5c..d862cb3 100644
--- a/guide/concepts/stop-start-restart-behaviour.md
+++ b/guide/concepts/stop-start-restart-behaviour.md
@@ -10,7 +10,7 @@ Many entities expose `start`, `stop` and `restart` effectors. The semantics of t
## Top-level applications
A top-level application is a grouping of other entities, pulling them together into the "application" of your choice. This could range from a single app-server, to an app that is a composite of a no-sql cluster (e.g. MongoDB sharded cluster, or Cassandra spread over multiple datacenters), a cluster of load-balanced app-servers, message brokers, etc.
-### start(Collection<Location>)
+### start(Collection <Location>)
This will start the application in the given location(s). Each child-entity within the application will be started concurrently, passing the location(s) to each child.
The start effector will be called automatically when the application is deployed through the catalog.
Is is strongly recommended to not call start again.
@@ -25,7 +25,7 @@ Is is strongly recommended to not call this, unless the application has been exp
## Software Process (e.g MySql, Tomcat, JBoss app-server, MongoDB)
-### start(Collection<Location>)
+### start(Collection <Location>)
This will start the software process in the given location.
If a machine location is passed in, then the software process is started there.
If a cloud location is passed in, then a new VM will be created in that cloud - the software process will be **installed+launched** on that new VM.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/guide/start/blueprints.md
----------------------------------------------------------------------
diff --git a/guide/start/blueprints.md b/guide/start/blueprints.md
index 1b195ef..e282e8d 100644
--- a/guide/start/blueprints.md
+++ b/guide/start/blueprints.md
@@ -3,7 +3,7 @@ title: Deploying Blueprints
layout: website-normal
---
-Blueprints are descriptors or patterns which describe how Apache Brooklyn should deploy applications. Blueprints are written in [YAML](https://en.wikipedia.org/wiki/YAML){:target="_blank"} and all of the entities available are defined in the __[Brooklyn Catalog](../../website/learnmore/catalog/)__.
+Blueprints are descriptors or patterns which describe how Apache Brooklyn should deploy applications. Blueprints are written in [YAML](https://en.wikipedia.org/wiki/YAML){:target="_blank"} and all of the entities available are defined in the __[Brooklyn Catalog]({{ site.path.website }}/learnmore/catalog/)__.
## Launching from a Blueprint
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/guide/start/running.md
----------------------------------------------------------------------
diff --git a/guide/start/running.md b/guide/start/running.md
index ed78028..e7631f1 100644
--- a/guide/start/running.md
+++ b/guide/start/running.md
@@ -132,4 +132,4 @@ The CLI provides the command `br`, it's full usage is described in the user manu
## Next
-The first thing we want to do with Brooklyn is **[deploy a blueprint](blueprints.html)**.
+<div class="started-pdf-exclude">The first thing we want to do with Brooklyn is **[deploy a blueprint](blueprints.html)**.</div>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/singlePageManual.html
----------------------------------------------------------------------
diff --git a/singlePageManual.html b/singlePageManual.html
index 98bd900..bfdfa69 100644
--- a/singlePageManual.html
+++ b/singlePageManual.html
@@ -1,6 +1,7 @@
---
title: Apache Brooklyn Manual
layout: singlePage
+page_mask: usermanual-pdf-exclude
---
<div id="content_container" class="container">
<header>
@@ -8,9 +9,7 @@ layout: singlePage
</header>
<h1>Contents</h1>
- {% assign pageMask = "usermanual-pdf-exclude" %}
-
- <nav><ul><!-- site.pages -->
+ <nav><ul>
{% assign visited = "" | split: "|" %}
{% for node in site.data.menu %}
{% push site_items node %}
@@ -23,4 +22,5 @@ layout: singlePage
{% push site_items node %}
{% include singlepage-content.html %}
{% endfor %}
+
</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/singlePageStarted.html
----------------------------------------------------------------------
diff --git a/singlePageStarted.html b/singlePageStarted.html
index 5598f55..9e527eb 100644
--- a/singlePageStarted.html
+++ b/singlePageStarted.html
@@ -1,6 +1,7 @@
---
title: Apache Brooklyn Manual
layout: singlePage
+page_mask: started-pdf-exclude
---
<div id="content_container" class="container">
<header>
@@ -8,9 +9,7 @@ layout: singlePage
</header>
<h1>Contents</h1>
- {% assign pageMask = "started-pdf-exclude" %}
-
- <nav><ul><!-- site.pages -->
+ <nav><ul>
{% assign visited = "" | split: "|" %}
{% for node in site.data.menu %}
{% push site_items node %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/style/css/singlePage.css
----------------------------------------------------------------------
diff --git a/style/css/singlePage.css b/style/css/singlePage.css
new file mode 100644
index 0000000..781e590
--- /dev/null
+++ b/style/css/singlePage.css
@@ -0,0 +1,38 @@
+.nav.nav-tabs{
+ display: none;
+}
+#next{
+ display: none;
+}
+.collapse {
+ display: block;
+}
+.section-breaker {
+page-break-before:always;
+}
+.panel-heading{
+ padding-bottom: 15px;
+}
+/* The styled bootstrap panels */
+.panel-body, .panel-default{
+ background: none;
+ border: 0px solid #fff !important;
+ box-shadow: none;
+ padding: 0px;
+}
+.panel-default > .panel-heading{
+ background: none;
+ border: 0px solid #fff !important;
+ box-shadow: none;
+ padding-top: 0px;
+ padding-right: 0px;
+ padding-left: 0px;
+}
+pre{
+ overflow: auto;
+ white-space: pre-wrap; /* CSS 3 */
+ white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ word-wrap: break-word; /* Internet Explorer 5.5+ */
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/59853364/website/learnmore/blueprint-tour.md
----------------------------------------------------------------------
diff --git a/website/learnmore/blueprint-tour.md b/website/learnmore/blueprint-tour.md
index 0a7795b..11a1f23 100644
--- a/website/learnmore/blueprint-tour.md
+++ b/website/learnmore/blueprint-tour.md
@@ -1,6 +1,7 @@
---
layout: website-normal
title: A Quick Tour of a Brooklyn Blueprint
+usermanual-pdf-exclude: true
title_in_menu: Blueprint Tour
---
[05/10] brooklyn-docs git commit: Fixed sizing issue for PDF
Posted by al...@apache.org.
Fixed sizing issue for PDF
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/f78c5e9d
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/f78c5e9d
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/f78c5e9d
Branch: refs/heads/master
Commit: f78c5e9d525fcd682509a20c238426c27b31768c
Parents: b6ae832
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Thu Feb 25 10:35:06 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:52:55 2016 +0000
----------------------------------------------------------------------
style/css/singlePage.css | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f78c5e9d/style/css/singlePage.css
----------------------------------------------------------------------
diff --git a/style/css/singlePage.css b/style/css/singlePage.css
index 07d7395..9c87950 100644
--- a/style/css/singlePage.css
+++ b/style/css/singlePage.css
@@ -52,5 +52,5 @@ pre, pre code{
}
#content_container h1{
display: inline-block;
- width: 95%;
+ width: 90%;
}
\ No newline at end of file
[06/10] brooklyn-docs git commit: Finished URL rewriting and
formatting
Posted by al...@apache.org.
Finished URL rewriting and formatting
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/f3c06f5c
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/f3c06f5c
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/f3c06f5c
Branch: refs/heads/master
Commit: f3c06f5cda1e97fe325d678f0e64c501c286a709
Parents: 70c731f
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Tue Feb 9 14:45:15 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:52:55 2016 +0000
----------------------------------------------------------------------
_build/buildPDF.sh | 4 +-
_config.yml | 1 +
_includes/singlepage-content.html | 17 +-----
_includes/singlepage-item.html | 3 +
_layouts/singlePage.html | 11 +++-
_plugins/regex_filter.rb | 108 ++++++++++++++++++++++++++++++++-
_plugins/stringTools.rb | 11 +++-
guide/start/blueprints.md | 6 +-
guide/start/managing.md | 24 ++++----
guide/start/running.md | 17 +++++-
style/css/singlePage.css | 11 +++-
zoneMergeManual.html | 5 +-
zoneMergeStarted.html | 3 +
13 files changed, 183 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_build/buildPDF.sh
----------------------------------------------------------------------
diff --git a/_build/buildPDF.sh b/_build/buildPDF.sh
index 54ff597..a3d1196 100755
--- a/_build/buildPDF.sh
+++ b/_build/buildPDF.sh
@@ -20,6 +20,8 @@ command -v wkhtmltopdf >/dev/null 2>&1 || {
wkhtmltopdf --page-size Letter --margin-top 0.75in --margin-right 0.75in --margin-bottom 0.75in --margin-left 0.75in --encoding UTF-8 $1 $2
if [ $? -eq 1 ] ; then
echo "Note that ContentNotFoundError is usually because of the invalid relational path of a local resource such as an image"
-else
+elif [ $? -eq 0 ] ; then
echo "PDF Built successfully."
+else
+ exit $?
fi
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index bb44fb5..8e32e3b 100644
--- a/_config.yml
+++ b/_config.yml
@@ -51,6 +51,7 @@ brooklyn-base-url: https://brooklyn.apache.org
pdf-rewrite-prefixes:
'/guide' : '/v/0.9.0-SNAPSHOT'
'/website' : ''
+ '/community' : '/community'
brooklyn-version: 0.9.0-SNAPSHOT # BROOKLYN_VERSION
brooklyn-snapshot-git-branch: master # if line above is SNAPSHOT this should point to corresponding git branch (e.g. master, 0.4)
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_includes/singlepage-content.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-content.html b/_includes/singlepage-content.html
index 18fc1b7..7d24206 100644
--- a/_includes/singlepage-content.html
+++ b/_includes/singlepage-content.html
@@ -26,25 +26,14 @@
{% comment %}<!-- Build the page directory by removing the file name from the item url -->{% endcomment %}
{% capture page_url %}{{ item_url | replace_regex:'[^\/]*$', '' }}{% endcapture %}
- {% comment %}<!-- If the URL is prefixed with a pdf-rewrite-prefix, remove it -->{% endcomment %}
- {% for part in site.pdf-rewrite-prefixes %}
- {% capture prefixed %}{{ page_url | startsWith: part[0] }}{% endcapture %}
- {% if prefixed == "true" %}
- {% capture page_url %}{{ part[1] }}{{ page_url | removePrefix: part[0] }}{% endcapture %}
- {% endif %}
- {% endfor %}
-
{% capture new_img %}img src=".{{ page_url }}{% endcapture %}
- {% capture new_href %}href="{{ site.brooklyn-base-url }}{{ brooklyn-version }}{{ page_url }}{% endcapture %}
{% comment %}<!-- Build a regex which replaces the current path with an absolute one but leaves any sub folders such as /images -->{% endcomment %}
- {% capture img_regex %}(img(.*)src="{{ page_url | replace:'/','\/' }})|(img(.*)src="){% endcapture %}
-
- {% comment %}<!-- Build a regex which replaces the current links with an absolute one but leaves any sub folders such as /images and ignores # or external links -->{% endcomment %}
- {% capture link_regex %}(href="{{ page_url | replace:'/','\/' }})|(href="(?!http)(?!#)){% endcapture %}
+ {% capture img_regex %}(img(.*?)src="{{ page_url | replace:'/','\/' }})|(img(.*?)src="){% endcapture %}
{% comment %}<!-- Filter the content of the included page -->{% endcomment %}
- {% capture content_filtered %}{{ item_content | replace_regex: img_regex, new_img | replace_regex: link_regex, new_href }}{% endcapture %}
+ {% capture content_filtered %}{{ item_content | replace_regex: img_regex, new_img | refactorURL: 'href="(.*?)"', site, site.pages, page.availablePages, page, item }}{% endcapture %}
+
{{ content_filtered }}
</div>
{% endif %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_includes/singlepage-item.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-item.html b/_includes/singlepage-item.html
index 8725939..4ede485 100644
--- a/_includes/singlepage-item.html
+++ b/_includes/singlepage-item.html
@@ -7,6 +7,9 @@
{% set_hash_entry item content item_content %}
{% set_hash_entry item data item_data %}
+ {% comment %}<!-- Build a list of all the pages included in this manual -->{% endcomment %}
+ {{ page.availablePages | appendToArray: item }}
+
{% capture pid %}{{ item.title | remove:'/' | replace:' ','-' | downcase }}{% endcapture %}
<a id="{{ item_path }}" name="{{ item_path }}" href="javascript:void(0);"></a>
{{ page.my_array['test'] = 'test' }}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_layouts/singlePage.html
----------------------------------------------------------------------
diff --git a/_layouts/singlePage.html b/_layouts/singlePage.html
index adb3c03..5e738c3 100644
--- a/_layouts/singlePage.html
+++ b/_layouts/singlePage.html
@@ -11,10 +11,17 @@
<link href=".{{site.path.style}}/css/website.css" rel="stylesheet">
<link rel="stylesheet" href=".{{ site.path.style }}/css/singlePage.css" type="text/css" media="screen" />
-<style>.{{ page.pageMask }}{ display: none; }</style>
+<style>.{{ page.css_hide_class }}{ display: none; } .{{ page.css_show_class }}{ display: inline !important; visibility: visible !important; }</style>
+<script>
+[]
+.forEach
+.call(document.querySelectorAll('a[target="_blank"]'),
+ function(link) {
+ link.removeAttribute('target');
+});
+</script>
</head>
-
<body>
{{ content }}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_plugins/regex_filter.rb
----------------------------------------------------------------------
diff --git a/_plugins/regex_filter.rb b/_plugins/regex_filter.rb
index 4ece039..b82169d 100644
--- a/_plugins/regex_filter.rb
+++ b/_plugins/regex_filter.rb
@@ -9,4 +9,110 @@ module Jekyll
end
end
-Liquid::Template.register_filter(Jekyll::RegexFilter)
\ No newline at end of file
+Liquid::Template.register_filter(Jekyll::RegexFilter)
+
+
+#######
+# This function rewrites a link in the following manner
+#
+# 1) If the link is fully external leave it as an unaltered link
+# 2) If the link is an anchor, convert to the anchor scheme used in PDF generation
+# 3) If the link target is in the PDF, change the link to point at the anchor in the PDF
+# 4) If the link is pointing at somewhere on the brooklyn site which is not included in this PDF, point to the website with a specific version, so https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/start/concept-quickstart.html for instance
+#
+# * Input - the document body, site - the jekyll site object, page - all pages, availablePages - ones included in this merge, mergePage - the root merge page, currentPage - the current page being merged
+module RefactorURL
+ def refactorURL(input, reg_str, site, pages, availablePages, mergePage, currentPage)
+ if input == nil
+ return nil
+ end
+
+ # generate document id, this will be used for the anchors
+ $pid = "id-undefined"
+ if currentPage['title'] != nil
+ $pid = currentPage['title'].downcase.delete('/')
+ $pid.gsub!(/\s+/, '-')
+ end
+
+ # re-write any ids to our internal references
+ input.gsub!("id=\"", "id=\"internalLink_"+$pid+"_")
+
+ # get rid of any opening in new tabs, they'll break our anchors
+ input.gsub!(" target=\"_blank\"", "")
+
+ # make a multi-line regex for finding URLs within the document body
+ re = Regexp.new reg_str, Regexp::MULTILINE
+
+ # for each url matched replace using the following rules
+ input.gsub(re) {
+
+ $newLink = "#"
+ # there should only be one capturing group (the URL), so use the first
+ $match = Regexp.last_match.captures[0]
+ # the URL is now in match
+ if $match.start_with?('http')
+ # 1) it's an external link, leave it as it is
+ $newLink = $match
+ elsif $match.start_with?('#')
+ # 2) it's an anchor in the local document re-write with the local document id prefixed
+ $newLink = "#internalLink_"+$pid+"_"+($match.gsub! '#', '')
+ else
+ # 3/4) it's a link to a page within the site scope
+
+ # -- Firstly clean up the URL
+ if $match =~ /#/
+ # if there's an anchor remove it (anything after the #)
+ $match = $match[/[^#]+/]
+ end
+ # swap ./ for absolute path
+ if $match.start_with?('./')
+ $match = currentPage['dir']+"/"+$match[2, $match.length]
+ # if the string doesnt start with a / it cant be prefixed by the path, so prefix it
+ elsif !($match.start_with?('/'))
+ $match = currentPage['dir']+"/"+$match
+ end
+ # add index.html to the end if it's just a folder
+ if $match.end_with?('/')
+ $match = $match+"index.html"
+ end
+
+ # -- now work out if the linked to page is within the page scope
+ $pageOutOfScope = true;
+ for page in availablePages
+ if (page['url'] == $match)
+ # 3) the page is within the scope of the document, swap it for an anchor
+ $pageOutOfScope = false;
+# puts "In Scope "+$match
+ # get the pid for this specific page
+ $current_pid = page['title'].downcase.delete('/')
+ $current_pid.gsub!(/\s+/, '-')
+ # make the link an anchor to it
+ $newLink = "#contentsLink-"+$current_pid
+ end
+ end
+ # 4) page is out of scope of the document put an absolute URL
+ if $pageOutOfScope
+# puts $match+" not in scope - "+$newLink
+ $notFoundPrefix = true
+ # go through the URL prefixes in the site and swap them for the website paths
+ for prefix in site['pdf-rewrite-prefixes']
+
+ # make an absolute external URL for the link
+ if $match.start_with?(prefix[0])
+ $notFoundPrefix = false
+ $newLink = site['brooklyn-base-url']+prefix[1]+$match[prefix[0].length, $match.length]
+ end
+ end
+ if $notFoundPrefix
+ puts $match+" not found prefix"
+ $newLink = site['brooklyn-base-url']+"/v/"+site['brooklyn-version']+$match
+ end
+ end
+ end
+ # return the re-written link wrapped in the property
+ "href=\""+$newLink+"\""
+ }
+ end
+
+ Liquid::Template.register_filter self
+end
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/_plugins/stringTools.rb
----------------------------------------------------------------------
diff --git a/_plugins/stringTools.rb b/_plugins/stringTools.rb
index 929a7c5..96f001b 100644
--- a/_plugins/stringTools.rb
+++ b/_plugins/stringTools.rb
@@ -23,4 +23,13 @@ module RemovePrefixFilter
end
Liquid::Template.register_filter self
-end
\ No newline at end of file
+end
+
+module Append
+ def appendToArray(array, addition)
+ (array ||= []) << addition
+ ""
+ end
+
+ Liquid::Template.register_filter self
+end
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/guide/start/blueprints.md
----------------------------------------------------------------------
diff --git a/guide/start/blueprints.md b/guide/start/blueprints.md
index e282e8d..c823eb7 100644
--- a/guide/start/blueprints.md
+++ b/guide/start/blueprints.md
@@ -126,4 +126,8 @@ you can monitor the progress of the application deployment and verify if it was
## Next
-Having deployed an application, the next step is **[monitoring and managing](managing.html)** it.
\ No newline at end of file
+<div class="started-pdf-exclude">
+
+Having deployed an application, the next step is **[monitoring and managing](managing.html)** it.
+
+</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/guide/start/managing.md
----------------------------------------------------------------------
diff --git a/guide/start/managing.md b/guide/start/managing.md
index 51ff7b1..add6ce6 100644
--- a/guide/start/managing.md
+++ b/guide/start/managing.md
@@ -141,7 +141,7 @@ brooklyn.wrapper_app true
## Entities
-An *Entity* is Apache Brooklyn's representation of a software package or service which it can control or interact with. All of the entities Apache Brooklyn can use are listed in the __[Brooklyn Catalog](../../website/learnmore/catalog/)__.
+An *Entity* is Apache Brooklyn's representation of a software package or service which it can control or interact with. All of the entities Apache Brooklyn can use are listed in the __[Brooklyn Catalog]({{ site.path.website }}/learnmore/catalog/)__.
To list the entities of the application you can use the `entity` or `ent` command:
@@ -208,15 +208,15 @@ To explore sensors on a specific entity use the `sensor` command with an entity
$ br application Tomcat entity tomcatServer sensor
{% endhighlight %}
<pre>
-Name Description Value
-download.addon.urls URL patterns for downloading named add-ons (will substitute things like ${version} automatically)
-download.url URL pattern for downloading the installer (will substitute things like ${version} automatically) "http://download.nextag.com/apache/tomcat/tomcat-7/v${version}/bin/apache-tomcat-${version}.tar.gz"
-expandedinstall.dir Directory for installed artifacts (e.g. expanded dir after unpacking .tgz) "/home/vagrant/brooklyn-managed-processes/installs/TomcatServer_7.0.65/apache-tomcat-7.0.65"
-host.address Host IP address "10.10.10.101"
-host.name Host name "10.10.10.101"
-host.sshAddress user@host:port for ssh'ing (or null if inappropriate) "vagrant@10.10.10.101:22"
-host.subnet.address Host address as known internally in the subnet where it is running (if different to host.name) "10.10.10.101"
-host.subnet.hostname Host name as known internally in the subnet where it is running (if different to host.name) "10.10.10.101"
+Name Description Value
+download.addon.urls URL patterns for downloading named add-ons (will substitute things like ${version} automatically)
+download.url URL pattern for downloading the installer (will substitute things like ${version} automatically) "http://download.nextag.com/apache/tomcat/tomcat-7/v${version}/bin/apache-tomcat-${version}.tar.gz"
+expandedinstall.dir Directory for installed artifacts (e.g. expanded dir after unpacking .tgz) "/home/vagrant/brooklyn-managed-processes/installs/TomcatServer_7.0.65/apache-tomcat-7.0.65"
+host.address Host IP address "10.10.10.101"
+host.name Host name "10.10.10.101"
+host.sshAddress user@host:port for ssh'ing (or null if inappropriate) "vagrant@10.10.10.101:22"
+host.subnet.address Host address as known internally in the subnet where it is running (if different to host.name) "10.10.10.101"
+host.subnet.hostname Host name as known internally in the subnet where it is running (if different to host.name) "10.10.10.101"
# etc. etc.
</pre>
@@ -239,9 +239,9 @@ Effectors are a means by which you can manipulate the entities in an application
$ br application Tomcat effector
{% endhighlight %}
<pre>
-Name Description Parameters
+Name Description Parameters
restart Restart the process/service represented by an entity
-start Start the process/service represented by an entity locations
+start Start the process/service represented by an entity locations
stop Stop the process/service represented by an entity
</pre>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/guide/start/running.md
----------------------------------------------------------------------
diff --git a/guide/start/running.md b/guide/start/running.md
index e7631f1..ca1936c 100644
--- a/guide/start/running.md
+++ b/guide/start/running.md
@@ -23,8 +23,9 @@ Two methods of deployment are detailed in this tutorial, using virtualisation wi
<div class="tab-content">
<div id="impl-1" class="tab-pane fade in active">
-[Vagrant](https://www.vagrantup.com/){:target="_blank"} is a software package which automates the process of setting up virtual machines (VM) such as [Oracle VirtualBox](https://www.virtualbox.org){:target="_blank"}. We recommend it as
-the easiest way of getting started with Apache Brooklyn.
+<strong class="hidden started-pdf-include">a) Vagrant</strong>
+
+[Vagrant](https://www.vagrantup.com/){:target="_blank"} is a software package which automates the process of setting up virtual machines (VM) such as [Oracle VirtualBox](https://www.virtualbox.org){:target="_blank"}. We recommend it as the easiest way of getting started with Apache Brooklyn.
Firstly, download and install:
@@ -44,6 +45,8 @@ $ cd apache-brooklyn-{{site.brooklyn-version}}-vagrant
</div>
<div id="impl-2" class="tab-pane fade">
+<strong class="hidden started-pdf-include">b) Local Install</strong>
+
Download the Apache Brooklyn binary distribution as described on [the download page]({{site.path.website}}/download/){:target="_blank"}.
{% if brooklyn_version contains 'SNAPSHOT' %}
@@ -88,6 +91,8 @@ you may wish to set up other configuration options first:
<div class="tab-content">
<div id="impl-1" class="tab-pane fade in active">
+<strong class="hidden started-pdf-include">a) Vagrant</strong>
+
Now start Apache Brooklyn with the following command:
{% highlight bash %}
@@ -103,6 +108,8 @@ $ vagrant ssh brooklyn --command 'sudo journalctl -n15 -f -u brooklyn'
</div>
<div id="impl-2" class="tab-pane fade">
+<strong class="hidden started-pdf-include">b) Local Install</strong>
+
Now start Apache Brooklyn with the following command:
{% highlight bash %}
@@ -132,4 +139,8 @@ The CLI provides the command `br`, it's full usage is described in the user manu
## Next
-<div class="started-pdf-exclude">The first thing we want to do with Brooklyn is **[deploy a blueprint](blueprints.html)**.</div>
+<div class="started-pdf-exclude">
+
+The first thing we want to do with Brooklyn is **[deploy a blueprint](blueprints.html)**.
+
+</div>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/style/css/singlePage.css
----------------------------------------------------------------------
diff --git a/style/css/singlePage.css b/style/css/singlePage.css
index 781e590..4b03262 100644
--- a/style/css/singlePage.css
+++ b/style/css/singlePage.css
@@ -1,6 +1,13 @@
+/* Fix the bootstrap parts so they show the content not the controls*/
.nav.nav-tabs{
display: none;
}
+.tab-content > .tab-pane {
+ display: inline;
+}
+.fade {
+ opacity: 1;
+}
#next{
display: none;
}
@@ -8,7 +15,7 @@
display: block;
}
.section-breaker {
-page-break-before:always;
+ page-break-before:always;
}
.panel-heading{
padding-bottom: 15px;
@@ -28,7 +35,7 @@ page-break-before:always;
padding-right: 0px;
padding-left: 0px;
}
-pre{
+pre, pre code{
overflow: auto;
white-space: pre-wrap; /* CSS 3 */
white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/zoneMergeManual.html
----------------------------------------------------------------------
diff --git a/zoneMergeManual.html b/zoneMergeManual.html
index e088395..3111d01 100644
--- a/zoneMergeManual.html
+++ b/zoneMergeManual.html
@@ -2,6 +2,9 @@
title: Apache Brooklyn Manual
layout: singlePage
page_mask: usermanual-pdf-exclude
+css_hide_class: usermanual-pdf-exclude
+css_show_class: usermanual-pdf-include
+availablePages: []
---
{% comment %}<!-- This page builds the single page manual for the PDF, note that this name must be retained for conversion order -->{% endcomment %}
@@ -10,7 +13,7 @@ page_mask: usermanual-pdf-exclude
<h1>Apache Brooklyn: User Manual</h1>
</header>
<h1>Contents</h1>
-
+
<nav><ul>
{% assign visited = "" | split: "|" %}
{% for node in site.data.menu %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/f3c06f5c/zoneMergeStarted.html
----------------------------------------------------------------------
diff --git a/zoneMergeStarted.html b/zoneMergeStarted.html
index 11323b7..3cc0e3a 100644
--- a/zoneMergeStarted.html
+++ b/zoneMergeStarted.html
@@ -2,6 +2,9 @@
title: Apache Brooklyn Manual
layout: singlePage
page_mask: started-pdf-exclude
+css_hide_class: started-pdf-exclude
+css_show_class: started-pdf-include
+availablePages: []
---
{% comment %}<!-- This page builds the single page getting started for the PDF, note that this name must be retained for conversion order -->{% endcomment %}
[08/10] brooklyn-docs git commit: Style updates & jump to top
Posted by al...@apache.org.
Style updates & jump to top
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/ad3cad82
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/ad3cad82
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/ad3cad82
Branch: refs/heads/master
Commit: ad3cad8266f56cef6c276100c06eab4cd6459d9c
Parents: f3c06f5
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Tue Feb 9 15:49:38 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:52:55 2016 +0000
----------------------------------------------------------------------
_includes/singlepage-content.html | 3 +--
style/css/singlePage.css | 11 +++++++++++
zoneMergeManual.html | 2 +-
zoneMergeStarted.html | 2 +-
4 files changed, 14 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/ad3cad82/_includes/singlepage-content.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-content.html b/_includes/singlepage-content.html
index 7d24206..5fadfe2 100644
--- a/_includes/singlepage-content.html
+++ b/_includes/singlepage-content.html
@@ -16,13 +16,12 @@
{% capture pid %}{{ item.title | remove:'/' | replace:' ','-' | downcase }}{% endcapture %}
{% if item_content != null %}
<div id="contentsLink-{{pid}}" class="section-breaker section p-{{item_id}}">
- <h1>{{ item_title }}</h1>
+ <span style="width: 100%"><h1>{{ item_title }}</h1><a href="#content-top" class="goToTop">^</a></span>
{% comment %}
<!--
--This Section re-writes images so the base of their paths is the root docs directory. This allows the PDF to build properly.
-->
{% endcomment %}
-
{% comment %}<!-- Build the page directory by removing the file name from the item url -->{% endcomment %}
{% capture page_url %}{{ item_url | replace_regex:'[^\/]*$', '' }}{% endcapture %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/ad3cad82/style/css/singlePage.css
----------------------------------------------------------------------
diff --git a/style/css/singlePage.css b/style/css/singlePage.css
index 4b03262..f8f14f6 100644
--- a/style/css/singlePage.css
+++ b/style/css/singlePage.css
@@ -42,4 +42,15 @@ pre, pre code{
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
word-wrap: break-word; /* Internet Explorer 5.5+ */
+}
+.goToTop{
+ padding-right: 25px;
+ padding-top: 75px;
+ float: right;
+ font-size: 20pt;
+ font-weight: bold;
+}
+#content_container h1{
+ display: inline-block;
+ width: 95%;
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/ad3cad82/zoneMergeManual.html
----------------------------------------------------------------------
diff --git a/zoneMergeManual.html b/zoneMergeManual.html
index 3111d01..89c57f1 100644
--- a/zoneMergeManual.html
+++ b/zoneMergeManual.html
@@ -10,7 +10,7 @@ availablePages: []
<div id="content_container" class="container">
<header>
- <h1>Apache Brooklyn: User Manual</h1>
+ <h1 id="content-top">Apache Brooklyn: User Manual</h1>
</header>
<h1>Contents</h1>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/ad3cad82/zoneMergeStarted.html
----------------------------------------------------------------------
diff --git a/zoneMergeStarted.html b/zoneMergeStarted.html
index 3cc0e3a..3cf4710 100644
--- a/zoneMergeStarted.html
+++ b/zoneMergeStarted.html
@@ -10,7 +10,7 @@ availablePages: []
<div id="content_container" class="container">
<header>
- <h1>Apache Brooklyn: Getting Started Guide</h1>
+ <h1 id="content-top">Apache Brooklyn: Getting Started Guide</h1>
</header>
<h1>Contents</h1>
[03/10] brooklyn-docs git commit: Combine Brooklyn docs into single
page/pdf - for review
Posted by al...@apache.org.
Combine Brooklyn docs into single page/pdf - for review
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/cbdf51d1
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/cbdf51d1
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/cbdf51d1
Branch: refs/heads/master
Commit: cbdf51d17705284d40736087fae2f3fd9eeec14c
Parents: 7d24e76
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Tue Feb 2 11:03:42 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Thu Feb 25 14:50:25 2016 +0000
----------------------------------------------------------------------
.gitignore | 1 +
_build/build.sh | 28 +++++++++++++---
_build/buildPDF.sh | 25 ++++++++++++++
_includes/singlepage-content.html | 59 ++++++++++++++++++++++++++++++++++
_includes/singlepage-item.html | 46 ++++++++++++++++++++++++++
_layouts/singlePage.html | 15 +++++++++
_plugins/regex_filter.rb | 12 +++++++
guide/dev/index.md | 1 +
guide/java/index.md | 1 +
guide/misc/index.md | 1 +
guide/ops/index.md | 1 +
guide/start/index.md | 1 +
singlePageManual.html | 26 +++++++++++++++
singlePageStarted.html | 26 +++++++++++++++
website/community/index.md | 2 ++
website/developers/index.md | 1 +
website/documentation/index.md | 1 +
website/learnmore/index.md | 1 +
website/meta/sitemap.md | 1 +
website/meta/versions.md | 1 +
20 files changed, 246 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 806a062..97a4608 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,6 +31,7 @@ brooklyn*.log.*
ignored
_site
+_pdf
_config_local.yml
.sass-cache
style/js/catalog/items.js
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/_build/build.sh
----------------------------------------------------------------------
diff --git a/_build/build.sh b/_build/build.sh
index b4c8f15..1438424 100755
--- a/_build/build.sh
+++ b/_build/build.sh
@@ -31,9 +31,10 @@ function help() {
echo "* --skip-javadoc : to skip javadoc build"
echo "* --quick-javadoc : to do a quick javadoc build (for testing)"
echo "* --serve : serve files from _site after building (for testing)"
- echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../brooklyn-site-public)"
+ echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../incubator-brooklyn-site-public)"
echo "* --skip-htmlproof : skip the HTML Proof run on _site"
echo "* --quick-htmlproof : do a fast HTML Proof run on _site (not checking external links)"
+ echo "* --skip-pdf : skip generation of the PDF Documentation"
echo ""
}
@@ -156,6 +157,10 @@ function parse_arguments() {
QUICK_HTMLPROOF=true
shift
;;
+ "--skip-pdf")
+ SKIP_PDF=true
+ shift
+ ;;
*)
echo "ERROR: invalid argument '"$1"'"
exit 1
@@ -165,12 +170,25 @@ function parse_arguments() {
}
# Runs htmlproof against _site
+function build_pdf() {
+ if [ "$SKIP_PDF" == "true" ]; then
+ return
+ fi
+ echo "Running PDF Generation on _site/UserManual.html"
+ rm -rf _pdf
+ mkdir -p _pdf
+ PDF_MANUAL_LOG="_pdf/pdf_gen_manual.log"
+ PDF_STARTED_LOG="_pdf/pdf_gen_started.log"
+ _build/buildPDF.sh "_site/singlePageManual.html" "_pdf/UserManual.pdf" 2>&1 | tee $PDF_MANUAL_LOG
+ _build/buildPDF.sh "_site/singlePageStarted.html" "_pdf/GettingStarted.pdf" 2>&1 | tee $PDF_STARTED_LOG
+}
+
+# Runs htmlproof against _site
function test_site() {
if [ "$SKIP_HTMLPROOF" == "true" ]; then
return
fi
echo "Running htmlproof on _site"
- mkdir -p _build/target
HTMLPROOF_LOG="_build/target/htmlproof.log"
if [ "$QUICK_HTMLPROOF" == "true" ]; then
HTMLPROOF_OPTS="$HTMLPROOF_OPTS --disable_external"
@@ -250,8 +268,8 @@ function make_install() {
fi
if [ ! -z ${QUICK_JAVADOC+SET} ]; then echo "ERROR: --install not permitted when doing quick javadoc" ; return 1 ; fi
- SITE_DIR=${BROOKLYN_SITE_DIR-../../brooklyn-site-public}
- ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; }
+ SITE_DIR=${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
+ ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find incubator-brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; }
if [ -z ${INSTALL_RSYNC_OPTIONS+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi
if [ -z ${INSTALL_RSYNC_SUBDIR+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi
@@ -304,6 +322,8 @@ make_jekyll || { echo ERROR: failed jekyll docs build in `pwd` ; exit 1 ; }
make_javadoc || { echo ERROR: failed javadoc build ; exit 1 ; }
+build_pdf
+
test_site
# TODO build catalog
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/_build/buildPDF.sh
----------------------------------------------------------------------
diff --git a/_build/buildPDF.sh b/_build/buildPDF.sh
new file mode 100755
index 0000000..54ff597
--- /dev/null
+++ b/_build/buildPDF.sh
@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+#
+# this generates A PDF from a HTML file
+
+if [ ! -x _build/build.sh ] ; then
+ echo "ERROR: script must be run in root of docs dir"
+ exit 1
+fi
+
+if [ "$#" -lt 2 ] ; then
+ echo "Usage: buildPDF.sh <source html> <target PDF>"
+ exit 1
+fi
+
+command -v wkhtmltopdf >/dev/null 2>&1 || {
+ echo "ERROR: script requires wkhtmltopdf but it's not installed." >&2; exit 1;
+ }
+
+# run the PDF build with wkhtmltopdf
+wkhtmltopdf --page-size Letter --margin-top 0.75in --margin-right 0.75in --margin-bottom 0.75in --margin-left 0.75in --encoding UTF-8 $1 $2
+if [ $? -eq 1 ] ; then
+ echo "Note that ContentNotFoundError is usually because of the invalid relational path of a local resource such as an image"
+else
+ echo "PDF Built successfully."
+fi
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/_includes/singlepage-content.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-content.html b/_includes/singlepage-content.html
new file mode 100644
index 0000000..4b10bf8
--- /dev/null
+++ b/_includes/singlepage-content.html
@@ -0,0 +1,59 @@
+{% pop site_items item %}
+{% if item[pageMask] != true %}
+
+ {% set_hash_entry item path item_path %}
+ {% set_hash_entry item url item_url %}
+ {% set_hash_entry item content item_content %}
+ {% set_hash_entry item title item_title %}
+ {% set_hash_entry item id item_id %}
+
+ {% unless item_path %}
+ {% unless item_url %}
+ {% puts error, null item_url %}
+ {% putp item %}
+ {% putv item_url %}
+ {% fail item missing path and url (jekyll block evaluation order can cause this) %}
+ {% endunless %}
+ {% endunless %}
+
+ {% if visitedb contains item_title %}
+ {% comment %} <!-- ignore --> {% endcomment %}
+ {% elsif item['external'] %}
+ {% comment %} <!-- ignore --> {% endcomment %}
+
+ {% else %}
+ {% capture pid %}{{ item.title | remove:'/' | replace:' ','-' | downcase }}{% endcapture %}
+ {% if item_content != null %}
+ <div id="contentsLink-{{pid}}" class="section p-{{item_id}}">
+ <h1>{{ item_title }}</h1>
+ {% comment %}
+ <!--
+ --This Section re-writes images so the base of their paths is the root docs directory. This allows the PDF to build properly.
+ -->
+ {% endcomment %}
+
+ {% comment %}<!-- Build the page directory by removing the file name from the item url -->{% endcomment %}
+ {% capture page_url %}{{ item_url | replace_regex:'[^\/]*$', '' }}{% endcapture %}
+ {% capture new_var %}img src=".{{ page_url }}{% endcapture %}
+
+ {% comment %}<!-- Build a regex which replaces the current path with an absolute one but leaves any sub folders such as /images -->{% endcomment %}
+ {% capture regex %}(img(.*)src="{{ page_url | replace:'/','\/' }})|(img(.*)src="){% endcapture %}
+
+ {% comment %}<!-- Filter the content of the included page -->{% endcomment %}
+ {% capture content_filtered %}{{ item_content | replace_regex:regex, new_var }}{% endcapture %}
+ {{ content_filtered }}
+ </div>
+ {% endif %}
+ {% if item['menu'] %}
+ {% push visitedb item_title %}
+ {% push site_items item %}
+ {% assign last_item = site_items[-1] %}
+ {% for item in last_item['menu'] %}
+ {% push site_items item %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+ {% pop site_items item %}
+ {% endif %}
+ {% endif %}
+
+ {% endif %}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/_includes/singlepage-item.html
----------------------------------------------------------------------
diff --git a/_includes/singlepage-item.html b/_includes/singlepage-item.html
new file mode 100644
index 0000000..803cf7e
--- /dev/null
+++ b/_includes/singlepage-item.html
@@ -0,0 +1,46 @@
+{% pop site_items item %}
+{% if item[pageMask] != true %}
+
+ {% set_hash_entry item path item_path %}
+ {% set_hash_entry item url item_url %}
+ {% set_hash_entry item title item_title %}
+ {% set_hash_entry item content item_content %}
+ {% set_hash_entry item data item_data %}
+
+ {% unless item_path %}
+ {% unless item_url %}
+ {% puts error, null item_url %}
+ {% putp item %}
+ {% putv item_url %}
+ {% fail item missing path and url (jekyll block evaluation order can cause this) %}
+ {% endunless %}
+ {% endunless %}
+
+ {% capture pid %}{{ item.title | remove:'/' | replace:' ','-' | downcase }}{% endcapture %}
+ <a id="{{ item_path }}" name="{{ item_path }}" href="javascript:void(0);"></a>
+ <li>
+ {% if visited contains item_title %}
+ {{ item['title'] }} <a href="#link-{{pid}}"><span class="octicon octicon-link-external flip"></span></a>
+ {% elsif item['external'] %}
+ {{ item['title'] }} <a href="{{ item['url'] }}"><span class="octicon octicon-link-external"></span></a>
+ {% else %}
+ {% if item['content'] != null %}
+ <a href="#contentsLink-{{pid}}" id="link-{{pid}}">{{ item['title'] }}</a>
+ {% else %}
+ {{ item['title'] }}
+ {% endif %}
+ {% if item['menu'] %}
+ {% push visited item_title %}
+ <ul>
+ {% push site_items item %}
+ {% assign last_item = site_items[-1] %}
+ {% for item in last_item['menu'] %}
+ {% push site_items item %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ {% pop site_items item %}
+ </ul>
+ {% endif %}
+ {% endif %}
+ </li>
+{% endif %}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/_layouts/singlePage.html
----------------------------------------------------------------------
diff --git a/_layouts/singlePage.html b/_layouts/singlePage.html
new file mode 100644
index 0000000..6f45639
--- /dev/null
+++ b/_layouts/singlePage.html
@@ -0,0 +1,15 @@
+---
+---
+<!DOCTYPE html>
+<html>
+<head>
+
+</head>
+
+
+<body>
+
+{{ content }}
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/_plugins/regex_filter.rb
----------------------------------------------------------------------
diff --git a/_plugins/regex_filter.rb b/_plugins/regex_filter.rb
new file mode 100644
index 0000000..4ece039
--- /dev/null
+++ b/_plugins/regex_filter.rb
@@ -0,0 +1,12 @@
+module Jekyll
+ module RegexFilter
+ def replace_regex(input, reg_str, repl_str)
+ re = Regexp.new reg_str, Regexp::MULTILINE
+
+ # This will be returned
+ input.gsub re, repl_str
+ end
+ end
+end
+
+Liquid::Template.register_filter(Jekyll::RegexFilter)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/guide/dev/index.md
----------------------------------------------------------------------
diff --git a/guide/dev/index.md b/guide/dev/index.md
index 79e22fd..f0cf45e 100644
--- a/guide/dev/index.md
+++ b/guide/dev/index.md
@@ -1,5 +1,6 @@
---
title: Developer Guide
+started-pdf-exclude: true
layout: website-normal
menu_parent: /website/documentation/
breadcrumbs:
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/guide/java/index.md
----------------------------------------------------------------------
diff --git a/guide/java/index.md b/guide/java/index.md
index 279ca4b..e2b7984 100644
--- a/guide/java/index.md
+++ b/guide/java/index.md
@@ -2,6 +2,7 @@
title: Java Blueprints
title_in_menu: Java Blueprints
layout: website-normal
+started-pdf-exclude: true
children:
- archetype.md
- defining-and-deploying.md
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/guide/misc/index.md
----------------------------------------------------------------------
diff --git a/guide/misc/index.md b/guide/misc/index.md
index fab2222..6463cf5 100644
--- a/guide/misc/index.md
+++ b/guide/misc/index.md
@@ -2,6 +2,7 @@
# BROOKLYN_VERSION_BELOW
title: Other 0.9.0-SNAPSHOT Resources
layout: website-normal
+started-pdf-exclude: true
children:
- { title: Javadoc, path: javadoc/ }
- download.md
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/guide/ops/index.md
----------------------------------------------------------------------
diff --git a/guide/ops/index.md b/guide/ops/index.md
index 78644d9..192bc77 100644
--- a/guide/ops/index.md
+++ b/guide/ops/index.md
@@ -1,5 +1,6 @@
---
title: Operations
+started-pdf-exclude: true
layout: website-normal
children:
- server-cli-reference.md
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/guide/start/index.md
----------------------------------------------------------------------
diff --git a/guide/start/index.md b/guide/start/index.md
index ea8c2a3..aa14f22 100644
--- a/guide/start/index.md
+++ b/guide/start/index.md
@@ -1,6 +1,7 @@
---
layout: website-normal
title: Getting Started
+usermanual-pdf-exclude: true
children:
- running.md
- blueprints.md
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/singlePageManual.html
----------------------------------------------------------------------
diff --git a/singlePageManual.html b/singlePageManual.html
new file mode 100644
index 0000000..98bd900
--- /dev/null
+++ b/singlePageManual.html
@@ -0,0 +1,26 @@
+---
+title: Apache Brooklyn Manual
+layout: singlePage
+---
+ <div id="content_container" class="container">
+ <header>
+ <h1>Apache Brooklyn: User Manual</h1>
+ </header>
+ <h1>Contents</h1>
+
+ {% assign pageMask = "usermanual-pdf-exclude" %}
+
+ <nav><ul><!-- site.pages -->
+ {% assign visited = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ </ul></nav>
+
+ {% assign visitedb = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+ </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/singlePageStarted.html
----------------------------------------------------------------------
diff --git a/singlePageStarted.html b/singlePageStarted.html
new file mode 100644
index 0000000..5598f55
--- /dev/null
+++ b/singlePageStarted.html
@@ -0,0 +1,26 @@
+---
+title: Apache Brooklyn Manual
+layout: singlePage
+---
+ <div id="content_container" class="container">
+ <header>
+ <h1>Apache Brooklyn: Getting Started Guide</h1>
+ </header>
+ <h1>Contents</h1>
+
+ {% assign pageMask = "started-pdf-exclude" %}
+
+ <nav><ul><!-- site.pages -->
+ {% assign visited = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-item.html %}
+ {% endfor %}
+ </ul></nav>
+
+ {% assign visitedb = "" | split: "|" %}
+ {% for node in site.data.menu %}
+ {% push site_items node %}
+ {% include singlepage-content.html %}
+ {% endfor %}
+ </div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/website/community/index.md
----------------------------------------------------------------------
diff --git a/website/community/index.md b/website/community/index.md
index 29fe46c..a046f3c 100644
--- a/website/community/index.md
+++ b/website/community/index.md
@@ -1,6 +1,8 @@
---
layout: website-normal
title: Community
+started-pdf-exclude: true
+usermanual-pdf-exclude: true
children:
- mailing-lists.md
- irc.md
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/website/developers/index.md
----------------------------------------------------------------------
diff --git a/website/developers/index.md b/website/developers/index.md
index 5e07c87..4f0e605 100644
--- a/website/developers/index.md
+++ b/website/developers/index.md
@@ -1,6 +1,7 @@
---
layout: website-normal
title: Developers
+started-pdf-exclude: true
children:
- code/
- how-to-contribute.md
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/website/documentation/index.md
----------------------------------------------------------------------
diff --git a/website/documentation/index.md b/website/documentation/index.md
index 5c07fa1..80f9555 100644
--- a/website/documentation/index.md
+++ b/website/documentation/index.md
@@ -1,6 +1,7 @@
---
layout: website-normal
title: Documentation
+started-pdf-exclude: true
children:
- /guide/
- /guide/dev/
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/website/learnmore/index.md
----------------------------------------------------------------------
diff --git a/website/learnmore/index.md b/website/learnmore/index.md
index e3b84a4..42dfa69 100644
--- a/website/learnmore/index.md
+++ b/website/learnmore/index.md
@@ -1,6 +1,7 @@
---
layout: website-normal
title: Learn More
+started-pdf-exclude: true
children:
- blueprint-tour.md
- features/
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/website/meta/sitemap.md
----------------------------------------------------------------------
diff --git a/website/meta/sitemap.md b/website/meta/sitemap.md
index 7411976..38c66b3 100644
--- a/website/meta/sitemap.md
+++ b/website/meta/sitemap.md
@@ -1,5 +1,6 @@
---
layout: website-normal
+usermanual-pdf-exclude: true
title: Site Map
---
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cbdf51d1/website/meta/versions.md
----------------------------------------------------------------------
diff --git a/website/meta/versions.md b/website/meta/versions.md
index 4e704f4..f3941d7 100644
--- a/website/meta/versions.md
+++ b/website/meta/versions.md
@@ -1,5 +1,6 @@
---
layout: website-normal
+usermanual-pdf-exclude: true
title: Versions
---