Skip to content
Permalink
Browse files
move things to website/ subdir, update site-structure plugin to work …
…better with that, and have placeholder index.md in root
  • Loading branch information
ahgittin committed Dec 15, 2014
1 parent b4ee7ff commit 55c872a70c55a09a697777142fb95304d7506279
Showing 131 changed files with 110 additions and 98 deletions.
@@ -5,23 +5,22 @@
#
# jekyll serve --watch

# See in _scripts/ for more advanced dev and prod considerations.
# See in _build/ for more advanced dev and prod considerations.

# Deliberately add the "/website" to the URL to catch out places where a document uses a link starting "/" - these
# links should either be relative or use {{site.path.website}}. We want to preserve this behaviour to allow the possibility of
# "staging servers" which may publish preview copies of the site at a non-root URL.
# links should either be relative or use {{site.path.website}}

url_root: http://0.0.0.0:4000

path:
style: /website/style
style: /style
website: /website
v: /v

# site.url is deprecated in favour of site.path.website
# url: http://0.0.0.0:4000/website

# this is the instruction to jekyll to put things under /website dir
baseurl: /website
# no longer putting things under /website; there is a new website/ dir in the folder structure for most things
baseurl: ""


# Use local copies of depenedencies (but provide the full URL so it is easy to switch to remote locations)
@@ -6,8 +6,8 @@
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="{% dependency_url bootstrap.css %}" rel="stylesheet">
<link href="{{site.path.website}}/style/deps/bootstrap-theme.css" rel="stylesheet">
<link href="{{site.path.website}}/style/css/website.css" rel="stylesheet">
<link href="{{site.path.style}}/deps/bootstrap-theme.css" rel="stylesheet">
<link href="{{site.path.style}}/css/website.css" rel="stylesheet">
</head>

<body>
@@ -23,7 +23,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
{% if page.navgroup != 'home' %}<a class="navbar-brand" href="{{site.path.website}}/"><img src="{{site.path.website}}/style/img/apache-brooklyn-logo-244px-wide.png" alt="brooklyn"></a>{% endif %}
{% if page.navgroup != 'home' %}<a class="navbar-brand" href="{{site.path.website}}/"><img src="{{site.path.style}}/img/apache-brooklyn-logo-244px-wide.png" alt="brooklyn"></a>{% endif %}
</div>

<!-- Collect the nav links, forms, and other content for toggling -->
@@ -32,21 +32,21 @@
{% for navgroup in site.data.navgroups %}
{% if navgroup.page.menu2 %}
<li class="dropdown{% if page.navgroup == navgroup.id %} active{% endif %}">
<a href="{{site.path.website}}{{navgroup.page.url}}">{{navgroup.title}}</a>
<a href="{{navgroup.page.url}}">{{navgroup.title}}</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="{{site.path.website}}{{navgroup.page.url}}">{{navgroup.title_in_menu}}</a>
<a href="{{navgroup.page.url}}">{{navgroup.title_in_menu}}</a>
</li>
<li class="divider"></li>
{% for child in navgroup.page.menu2 %}
<li>
<a href="{{site.path.website}}{{child.reference.url}}">{{child.reference.title}}</a>
<a href="{{child.reference.url}}">{{child.reference.title}}</a>
</li>
{% endfor %}
</ul>
</li><!-- {{ navgroup.id }} -->
{% else %}
<li class="{% if page.navgroup == navgroup.id %}active{% endif %}"><a href="{{site.path.website}}{{navgroup.page.url}}">{{navgroup.title}}</a></li><!-- {{ navgroup.id }} -->
<li class="{% if page.navgroup == navgroup.id %}active{% endif %}"><a href="{{navgroup.page.url}}">{{navgroup.title}}</a></li><!-- {{ navgroup.id }} -->
{% endif %}
{% endfor %}
</ul>
@@ -11,9 +11,9 @@ <h1>{{ page.title }}</h1>
<div class="col-md-3">
{% if page.menu2 %}
<div class="list-group">
<h4><a href="{{site.path.website}}{{page.menu2parent.url}}" class="list-group-item{% if page.menu2parent.path == page.path %} active{% endif %}">{{ page.menu2parent.title }}</a></h4>
<h4><a href="{{page.menu2parent.url}}" class="list-group-item{% if page.menu2parent.path == page.path %} active{% endif %}">{{ page.menu2parent.title }}</a></h4>
{% for child in page.menu2 %}
<a href="{{site.path.website}}{{child.reference.url}}" class="list-group-item{% if child.reference.path == page.path %} active{% endif %}">{{ child.reference.title }}</a>
<a href="{{child.reference.url}}" class="list-group-item{% if child.reference.path == page.path %} active{% endif %}">{{ child.reference.title }}</a>
{% endfor %}
</div>
{% endif %}
@@ -34,7 +34,7 @@ <h4><a href="{{site.path.website}}{{page.menu2parent.url}}" class="list-group-it
<div class="col-md-2">
<a class="btn btn-sm btn-default" href="https://github.com/apache/incubator-brooklyn-site/edit/master/{{ page.path }}">Edit This Page</a>
<br />
<a href="https://brooklyn.incubator.apache.org/community/how-to-contribute-docs.html">help with editing</a>
<a href="{{ site.url_root }}{{ site.path.website }}/community/how-to-contribute-docs.html">help with editing</a>
</div>
</div>
</div>
@@ -2,7 +2,7 @@
# Starts from a page called "index.md", and follows "children" links in the YAML front matter
module SiteStructure

ROOT = "index.md"
ROOT = "website/index.md"

class Generator < Jekyll::Generator
def generate(site)
@@ -19,7 +19,8 @@ def generate(site)

def gen_structure(site, pagename, parent, navgroups)
page = site.pages.detect { |page| page.path == pagename }
throw "Could not find a page called: #{pagename} (referenced from #{page ? page.url : nil})" unless page

throw "Could not find a page called: #{pagename} (referenced from #{parent ? parent.url : "root"})" unless page

# My navgroup is (first rule matches):
# 1. what I have explicitly declared
@@ -50,10 +51,10 @@ def gen_structure(site, pagename, parent, navgroups)
if page.data['children']
page.data['children'].each do |c|
if c['path']
# links to another Jekyll-managed page
# links to another Jekyll site-structured page
c['reference'] = gen_structure(site, c['path'], page, navgroups)
elsif c['link']
# links to a not-Jekyll-managed page on this site
# links to a non-site-structured page, on this site or elsewhere
c['reference'] = { 'url' => c['link'], 'title' => c['title'] }
end
end
@@ -62,4 +63,4 @@ def gen_structure(site, pagename, parent, navgroups)
page
end
end
end
end
@@ -1,71 +1,12 @@
---
layout: website-landing
title: Home
navgroup: home
children:
- { path: learnmore/index.md }
- { path: download.md }
- { path: quickstart/index.md }
- { path: documentation.md }
- { path: community/index.md }
navgroups:
- { id: learnmore, page: learnmore/index.md, title: learn more }
- { id: download, page: download.md, title: download }
- { id: getstarted, page: quickstart/index.md, title: get started, title_in_menu: Get started }
- { id: documentation, page: documentation.md, title: documentation, title_in_menu: All documentation }
- { id: community, page: community/index.md, title: community, title_in_menu: Community home }
layout: website-normal
title: Brooklyn Website and Docs (dev build)
---

<div class="jumbotron">
<div id="apachebrooklynbanner">&nbsp;</div>
<i>This page is not copied into release builds. It is here as a convenience when doing dev builds.</i>

<div class="row">
<div class="col-md-4" markdown="1">
Consider looking at:

### model
* <a href="website/">the brooklyn website</a>

*Blueprints* describe your application, stored as *text files* in *version control*

*Compose* from the [*dozens* of supported components](learnmore/catalog/) or your *own components* using *bash, Java, Chef...*

<div class="text-muted" markdown="1">
#### JBoss &bull; Cassandra &bull; QPid &bull; nginx &bull; [many more](learnmore/catalog/)
</div>

</div>
<div class="col-md-4" markdown="1">

### deploy

Components *configured &amp; integrated* across *multiple machines* automatically

*20+ public clouds*, or your *private cloud* or bare servers - and *Docker* containers

<div class="text-muted" markdown="1">
#### Amazon EC2 &bull; CloudStack &bull; OpenStack &bull; SoftLayer &bull; many more
</div>

</div>
<div class="col-md-4" markdown="1">

### manage

*Monitor* key application *metrics*; *scale* to meet demand; *restart* and *replace* failed components

View and modify using the *web console* or automate using the *REST API*

<div class="text-muted" markdown="1">
#### Metric-based autoscaler &bull; Restarter &amp; replacer &bull; Follow the sun &bull; Load balancing
</div>

</div>
</div><!-- row -->

<div style="text-align: center" markdown="1">

<a class="btn btn-primary btn-lg" role="button" href="learnmore.html">learn more</a>
<a class="btn btn-primary btn-lg" role="button" href="quickstart/">get started</a>

</div>

</div><!-- jumbotron -->
Also see the file <code>README.md</code> in this directory.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -2,10 +2,10 @@
layout: website-normal
title: Community
children:
- { path: community/how-to-contribute.md }
- { path: community/migrate-to-apache.md }
- { path: community/committers.md }
- { path: community/how-to-contribute-docs.md }
- { path: website/community/how-to-contribute.md }
- { path: website/community/migrate-to-apache.md }
- { path: website/community/committers.md }
- { path: website/community/how-to-contribute-docs.md }
---

<div class="row">
File renamed without changes.
File renamed without changes.
@@ -2,16 +2,16 @@
layout: website-normal
title: Documentation
children:
- { link: v/0.7.0-M1, title: User Manual (0.7.0-M1) }
- { path: glossary.md }
- { path: documentation/install-on-server.md }
- { link: /v/0.7.0-M1, title: User Manual (0.7.0-M1) }
- { path: website/glossary.md }
- { path: website/documentation/install-on-server.md }
---

## Official User Manual

Our main user manual is organised by release version. Please pick the version that you are using:

- [0.7.0-M1]({{ site.path.website }}/v/0.7.0-M1) -
- [0.7.0-M1]({{ site.path.v }}/0.7.0-M1) -
Please note that this release was made prior to entering the Apache Incubator,
and therefore it is not endorsed by Apache.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -0,0 +1,71 @@
---
layout: website-landing
title: Home
navgroup: home
children:
- { path: website/learnmore/index.md }
- { path: website/download.md }
- { path: website/quickstart/index.md }
- { path: website/documentation.md }
- { path: website/community/index.md }
navgroups:
- { id: learnmore, page: website/learnmore/index.md, title: learn more }
- { id: download, page: website/download.md, title: download }
- { id: getstarted, page: website/quickstart/index.md, title: get started, title_in_menu: Get started }
- { id: documentation, page: website/documentation.md, title: documentation, title_in_menu: All documentation }
- { id: website/community, page: website/community/index.md, title: community, title_in_menu: Community home }
---

<div class="jumbotron">
<div id="apachebrooklynbanner">&nbsp;</div>

<div class="row">
<div class="col-md-4" markdown="1">

### model

*Blueprints* describe your application, stored as *text files* in *version control*

*Compose* from the [*dozens* of supported components](learnmore/catalog/) or your *own components* using *bash, Java, Chef...*

<div class="text-muted" markdown="1">
#### JBoss &bull; Cassandra &bull; QPid &bull; nginx &bull; [many more](learnmore/catalog/)
</div>

</div>
<div class="col-md-4" markdown="1">

### deploy

Components *configured &amp; integrated* across *multiple machines* automatically

*20+ public clouds*, or your *private cloud* or bare servers - and *Docker* containers

<div class="text-muted" markdown="1">
#### Amazon EC2 &bull; CloudStack &bull; OpenStack &bull; SoftLayer &bull; many more
</div>

</div>
<div class="col-md-4" markdown="1">

### manage

*Monitor* key application *metrics*; *scale* to meet demand; *restart* and *replace* failed components

View and modify using the *web console* or automate using the *REST API*

<div class="text-muted" markdown="1">
#### Metric-based autoscaler &bull; Restarter &amp; replacer &bull; Follow the sun &bull; Load balancing
</div>

</div>
</div><!-- row -->

<div style="text-align: center" markdown="1">

<a class="btn btn-primary btn-lg" role="button" href="learnmore.html">learn more</a>
<a class="btn btn-primary btn-lg" role="button" href="quickstart/">get started</a>

</div>

</div><!-- jumbotron -->
File renamed without changes.