[ARVADOS] updated: 2d3d78091a2cc4a6e18b90b4112de69bf44ad04d
git at public.curoverse.com
git at public.curoverse.com
Mon Dec 23 13:55:07 EST 2013
Summary of changes:
doc/_config.yml | 6 ++
doc/_includes/navbar_left.html | 27 ++++++++
doc/_includes/navbar_top.html | 22 ++++++
doc/_layouts/default.html | 68 +-------------------
doc/user/examples/crunch-examples.textile | 3 +-
doc/user/getting_started/check-environment.textile | 1 +
doc/user/getting_started/ssh-access.textile | 1 +
doc/user/getting_started/workbench.textile | 1 +
doc/user/reference/api-tokens.textile | 3 +-
.../reference/crunch-utility-libraries.textile | 3 +-
doc/user/reference/sdk-cli.textile | 3 +-
doc/user/reference/sdk-python.textile | 3 +-
doc/user/tutorials/tutorial-firstscript.textile | 3 +-
.../tutorial-gatk-variantfiltration.textile | 3 +-
doc/user/tutorials/tutorial-job-debug.textile | 3 +-
doc/user/tutorials/tutorial-job1.textile | 3 +-
doc/user/tutorials/tutorial-keep.textile | 3 +-
doc/user/tutorials/tutorial-new-pipeline.textile | 3 +-
doc/user/tutorials/tutorial-parallel.textile | 3 +-
doc/user/tutorials/tutorial-trait-search.textile | 3 +-
20 files changed, 86 insertions(+), 79 deletions(-)
create mode 100644 doc/_includes/navbar_left.html
create mode 100644 doc/_includes/navbar_top.html
via 2d3d78091a2cc4a6e18b90b4112de69bf44ad04d (commit)
from 4de2c25d6bd0974b456cbe1f5c2f0ff91a15f087 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 2d3d78091a2cc4a6e18b90b4112de69bf44ad04d
Author: Tim Pierce <twp at clinicalfuture.com>
Date: Mon Dec 23 13:54:39 2013 -0500
Reorganize navbars.
Move top and left-side navbars to their own _include pages.
Define navbar sections in _config.yml.
diff --git a/doc/_config.yml b/doc/_config.yml
index e6cc670..d214f84 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -1,2 +1,8 @@
baseurl: /doc
arvados_api_host: qr1hi.arvadosapi.com
+navbar:
+ userguide:
+ - Getting Started
+ - Tutorials
+ - Examples
+ - Reference
diff --git a/doc/_includes/navbar_left.html b/doc/_includes/navbar_left.html
new file mode 100644
index 0000000..81e94b7
--- /dev/null
+++ b/doc/_includes/navbar_left.html
@@ -0,0 +1,27 @@
+ <div class="span3">
+ <div class="affix-top">
+ <div class="well sidebar-nav">
+ {% if page.navsection == 'userguide' %}
+ <ol class="nav nav-list">
+ {% for menu_item in site.navbar.userguide %}
+ <li>{{ menu_item }}
+ <ol class="nav nav-list">
+ {% for navorder in (0..99) %}
+ {% for p in site.pages %}
+ {% if p.navmenu == menu_item and p.navorder == navorder %}
+ <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
+ {% endif %}{% endfor %}{% endfor %}
+ </ol>
+ </li>
+ {% endfor %}
+ </ol>
+ {% else %}
+ <ol class="nav nav-list">
+ {% for navorder in (0..99) %}{% for p in site.pages %}{% if p.navsection == page.navsection and p.navorder == navorder %}
+ <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
+ {% endif %}{% endfor %}{% endfor %}
+ </ol>
+ {% endif %}
+ </div>
+ </div>
+ </div>
diff --git a/doc/_includes/navbar_top.html b/doc/_includes/navbar_top.html
new file mode 100644
index 0000000..fc2098d
--- /dev/null
+++ b/doc/_includes/navbar_top.html
@@ -0,0 +1,22 @@
+ <div class="navbar navbar-inverse navbar-fixed-top" style="margin-bottom:0;">
+ <div class="navbar-inner">
+ <div class="container">
+ <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="brand" href="{{ site.baseurl }}/">Arvados Docs</a>
+ <div class="nav-collapse collapse">
+ <ul class="nav">
+ <li {% if page.navsection == 'userguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/user/">User Guide</a></li>
+ <li {% if page.navsection == 'api' %} class="active" {% endif %}><a href="{{ site.baseurl }}/api/">API Reference</a></li>
+ <li {% if page.navsection == 'adminguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/admin/">Admin Guide</a></li>
+ <li {% if page.navsection == 'installguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/install/">Install Guide</a></li>
+ <li><a></a></li>
+ <li><a href="https://arvados.org/">arvados.org »</a></li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
diff --git a/doc/_layouts/default.html b/doc/_layouts/default.html
index 75b64e5..380d5f6 100644
--- a/doc/_layouts/default.html
+++ b/doc/_layouts/default.html
@@ -67,28 +67,7 @@
<![endif]-->
</head>
<body class="nopad">
- <div class="navbar navbar-inverse navbar-fixed-top" style="margin-bottom:0;">
- <div class="navbar-inner">
- <div class="container">
- <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- <a class="brand" href="{{ site.baseurl }}/">Arvados Docs</a>
- <div class="nav-collapse collapse">
- <ul class="nav">
- <li {% if page.navsection == 'userguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/user/">User Guide</a></li>
- <li {% if page.navsection == 'api' %} class="active" {% endif %}><a href="{{ site.baseurl }}/api/">API Reference</a></li>
- <li {% if page.navsection == 'adminguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/admin/">Admin Guide</a></li>
- <li {% if page.navsection == 'installguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/install/">Install Guide</a></li>
- <li><a></a></li>
- <li><a href="https://arvados.org/">arvados.org »</a></li>
- </ul>
- </div><!--/.nav-collapse -->
- </div>
- </div>
- </div>
+ {% include navbar_top.html %}
{% if page.navsection == 'top' %}
{{ content }}
@@ -98,50 +77,7 @@
<div class="container-fluid">
<div class="row-fluid">
- <div class="span3">
- <div class="affix-top">
- <div class="well sidebar-nav">
- {% if page.navsection == 'userguide' %}
- <ol class="nav nav-list">
- <li>Getting Started
- <ol class="nav nav-list">
- {% for navorder in (0..99) %}{% for p in site.pages %}{% if p.navsection == page.navsection and p.navorder == navorder %}
- <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
- {% endif %}{% endfor %}{% endfor %}
- </ol>
- </li>
- <li>Tutorials
- <ol class="nav nav-list">
- {% for navorder in (100..199) %}{% for p in site.pages %}{% if p.navsection == page.navsection and p.navorder == navorder %}
- <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
- {% endif %}{% endfor %}{% endfor %}
- </ol>
- </li>
- <li>Examples
- <ol class="nav nav-list">
- {% for navorder in (200..299) %}{% for p in site.pages %}{% if p.navsection == page.navsection and p.navorder == navorder %}
- <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
- {% endif %}{% endfor %}{% endfor %}
- </ol>
- </li>
- <li>Reference
- <ol class="nav nav-list">
- {% for navorder in (300..399) %}{% for p in site.pages %}{% if p.navsection == page.navsection and p.navorder == navorder %}
- <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
- {% endif %}{% endfor %}{% endfor %}
- </ol>
- </li>
- </ol>
- {% else %}
- <ol class="nav nav-list">
- {% for navorder in (0..99) %}{% for p in site.pages %}{% if p.navsection == page.navsection and p.navorder == navorder %}
- <li {% if p.url == page.url %} class="active activesubnav" {% elsif p.title == page.subnavsection %} class="activesubnav" {% endif %}><a href="{{ site.baseurl }}{{ p.url }}">{{ p.title }}</a></li>
- {% endif %}{% endfor %}{% endfor %}
- </ol>
- {% endif %}
- </div>
- </div>
- </div>
+ {% include navbar_left.html %}
<div class="span9"><div style="padding-left: 2em;">
{{ content }}
</div></div>
diff --git a/doc/user/examples/crunch-examples.textile b/doc/user/examples/crunch-examples.textile
index 2140c8e..6fc9dc0 100644
--- a/doc/user/examples/crunch-examples.textile
+++ b/doc/user/examples/crunch-examples.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Examples
title: "Crunch examples"
-navorder: 230
+navorder: 30
---
h1. Crunch examples
diff --git a/doc/user/getting_started/check-environment.textile b/doc/user/getting_started/check-environment.textile
index c199db9..298f188 100644
--- a/doc/user/getting_started/check-environment.textile
+++ b/doc/user/getting_started/check-environment.textile
@@ -1,6 +1,7 @@
---
layout: default
navsection: userguide
+navmenu: Getting Started
title: "Checking your environment"
navorder: 10
---
diff --git a/doc/user/getting_started/ssh-access.textile b/doc/user/getting_started/ssh-access.textile
index 4c8019c..5cd73c9 100644
--- a/doc/user/getting_started/ssh-access.textile
+++ b/doc/user/getting_started/ssh-access.textile
@@ -1,6 +1,7 @@
---
layout: default
navsection: userguide
+navmenu: Getting Started
title: Accessing an Arvados VM over ssh
navorder: 2
---
diff --git a/doc/user/getting_started/workbench.textile b/doc/user/getting_started/workbench.textile
index c463cfd..f4f8f08 100644
--- a/doc/user/getting_started/workbench.textile
+++ b/doc/user/getting_started/workbench.textile
@@ -1,6 +1,7 @@
---
layout: default
navsection: userguide
+navmenu: Getting Started
title: Accessing Arvados Workbench
navorder: 1
---
diff --git a/doc/user/reference/api-tokens.textile b/doc/user/reference/api-tokens.textile
index 49fd9a4..928ba26 100644
--- a/doc/user/reference/api-tokens.textile
+++ b/doc/user/reference/api-tokens.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Reference
title: "Getting an API token"
-navorder: 301
+navorder: 01
---
h1. Reference: Getting an API token
diff --git a/doc/user/reference/crunch-utility-libraries.textile b/doc/user/reference/crunch-utility-libraries.textile
index 8233791..524040f 100644
--- a/doc/user/reference/crunch-utility-libraries.textile
+++ b/doc/user/reference/crunch-utility-libraries.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Reference
title: "Crunch utility libraries"
-navorder: 331
+navorder: 31
---
h1. Crunch utility libraries
diff --git a/doc/user/reference/sdk-cli.textile b/doc/user/reference/sdk-cli.textile
index e909a8b..706fe93 100644
--- a/doc/user/reference/sdk-cli.textile
+++ b/doc/user/reference/sdk-cli.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Reference
title: "Command line SDK"
-navorder: 322
+navorder: 22
---
h1. Reference: Command line SDK
diff --git a/doc/user/reference/sdk-python.textile b/doc/user/reference/sdk-python.textile
index fe824ac..29212c1 100644
--- a/doc/user/reference/sdk-python.textile
+++ b/doc/user/reference/sdk-python.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Reference
title: "Python SDK"
-navorder: 323
+navorder: 23
---
h1. Reference: Python SDK
diff --git a/doc/user/tutorials/tutorial-firstscript.textile b/doc/user/tutorials/tutorial-firstscript.textile
index 3b557ae..bfde02c 100644
--- a/doc/user/tutorials/tutorial-firstscript.textile
+++ b/doc/user/tutorials/tutorial-firstscript.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Writing a Crunch script"
-navorder: 113
+navorder: 13
---
h1. Tutorial: Writing a Crunch script
diff --git a/doc/user/tutorials/tutorial-gatk-variantfiltration.textile b/doc/user/tutorials/tutorial-gatk-variantfiltration.textile
index c1cdf05..77306d0 100644
--- a/doc/user/tutorials/tutorial-gatk-variantfiltration.textile
+++ b/doc/user/tutorials/tutorial-gatk-variantfiltration.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Using GATK with Arvados"
-navorder: 116
+navorder: 16
---
h1. Tutorial: Using GATK with Arvados
diff --git a/doc/user/tutorials/tutorial-job-debug.textile b/doc/user/tutorials/tutorial-job-debug.textile
index 3b68929..9ea454c 100644
--- a/doc/user/tutorials/tutorial-job-debug.textile
+++ b/doc/user/tutorials/tutorial-job-debug.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Debugging a Crunch script"
-navorder: 114
+navorder: 14
---
h1. Tutorial: Debugging a Crunch script
diff --git a/doc/user/tutorials/tutorial-job1.textile b/doc/user/tutorials/tutorial-job1.textile
index 176b087..253c4bd 100644
--- a/doc/user/tutorials/tutorial-job1.textile
+++ b/doc/user/tutorials/tutorial-job1.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Running a Crunch job"
-navorder: 112
+navorder: 12
---
h1. Tutorial: Running a crunch job
diff --git a/doc/user/tutorials/tutorial-keep.textile b/doc/user/tutorials/tutorial-keep.textile
index d156e0a..8255440 100644
--- a/doc/user/tutorials/tutorial-keep.textile
+++ b/doc/user/tutorials/tutorial-keep.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Storing and Retrieving data using Arvados Keep"
-navorder: 111
+navorder: 11
---
h1. Tutorial: Storing and Retrieving data using Arvados Keep
diff --git a/doc/user/tutorials/tutorial-new-pipeline.textile b/doc/user/tutorials/tutorial-new-pipeline.textile
index 9a127bd..5277bfc 100644
--- a/doc/user/tutorials/tutorial-new-pipeline.textile
+++ b/doc/user/tutorials/tutorial-new-pipeline.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Constructing a Crunch pipeline"
-navorder: 115
+navorder: 15
---
h1. Tutorial: Constructing a Crunch pipeline
diff --git a/doc/user/tutorials/tutorial-parallel.textile b/doc/user/tutorials/tutorial-parallel.textile
index b6e0b68..149da77 100644
--- a/doc/user/tutorials/tutorial-parallel.textile
+++ b/doc/user/tutorials/tutorial-parallel.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Parallel Crunch tasks"
-navorder: 115
+navorder: 15
---
h1. Tutorial: Parallel Crunch tasks
diff --git a/doc/user/tutorials/tutorial-trait-search.textile b/doc/user/tutorials/tutorial-trait-search.textile
index a7d78a7..fa7301e 100644
--- a/doc/user/tutorials/tutorial-trait-search.textile
+++ b/doc/user/tutorials/tutorial-trait-search.textile
@@ -1,8 +1,9 @@
---
layout: default
navsection: userguide
+navmenu: Tutorials
title: "Querying the Metadata Database"
-navorder: 116
+navorder: 16
---
h1. Tutorial: Querying the Metadata Database
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list