Reorganizing API documentation to support new navbar (refs #1651).

Add site.navbar.api to _config.yml, and add matching "navmenu" fields to API documentation pages.

diff --git a/doc/_config.yml b/doc/_config.yml
index d214f8406ee79e2ecff7ffabb391f798f392fffe..a4fed53b19ca5f79e499c5643e7a19092042e1b2 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -2,7 +2,11 @@ baseurl: /doc
 arvados_api_host: qr1hi.arvadosapi.com
 navbar:
   userguide:
-  - Getting Started
-  - Tutorials
-  - Examples
-  - Reference
+    - Getting Started
+    - Tutorials
+    - Examples
+    - Reference
+  api:
+    - Concepts
+    - API Methods
+    - Schema

diff --git a/doc/_includes/navbar_left.html b/doc/_includes/navbar_left.html
index 81e94b732866ff14fc6ec1b45d98cabcb83e1f99..d593ff33e00faeb071972c8bf413e6639761c9af 100644 (file)
--- a/doc/_includes/navbar_left.html
+++ b/doc/_includes/navbar_left.html
@@ -1,14 +1,14 @@
         <div class="span3">
           <div class="affix-top">
             <div class="well sidebar-nav">
-             {% if page.navsection == 'userguide' %}
+             {% if page.navsection == 'userguide' or page.navsection == 'api' %}
              <ol class="nav nav-list">
-                {% for menu_item in site.navbar.userguide %}
+                {% for menu_item in site.navbar[page.navsection] %}
                <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 %}
+                      {% if p.navsection == page.navsection and 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>

diff --git a/doc/api/ApiClientAuthorization.textile b/doc/api/ApiClientAuthorization.textile
index 133b9cbb191d088325dd7c28c576f1a807425dc6..cb8a8e67ec947c1f56c77ef2efc8b4bc931bcd47 100644 (file)
--- a/doc/api/ApiClientAuthorization.textile
+++ b/doc/api/ApiClientAuthorization.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: ApiClientAuthorization"
 navorder: 101
 ---

diff --git a/doc/api/ApiClients.textile b/doc/api/ApiClients.textile
index b4bc5d1876f61f9bcfdb2e23af18b83d1d011d4f..7acfcf076d8beaf1c9edefb279fa95684f611f91 100644 (file)
--- a/doc/api/ApiClients.textile
+++ b/doc/api/ApiClients.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: ApiClient"
 navorder: 101
 ---

diff --git a/doc/api/AuthorizedKey.textile b/doc/api/AuthorizedKey.textile
index 645080740842d6c9c4dd2f50d9a5900c62bc3b43..28b7769013d12e88087db11a95ddcfc85e0e4529 100644 (file)
--- a/doc/api/AuthorizedKey.textile
+++ b/doc/api/AuthorizedKey.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: AuthorizedKey"
 navorder: 101
 ---

diff --git a/doc/api/Collections.textile b/doc/api/Collections.textile
index 428cdddd95d80f6b94c27dcb0d1354d1273e8731..90dcf2e9284a1b7d9085cfd70447594318117357 100644 (file)
--- a/doc/api/Collections.textile
+++ b/doc/api/Collections.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Collections"
 navorder: 13
 ---

diff --git a/doc/api/Commit.textile b/doc/api/Commit.textile
index 9bb8dbf88430c462eaf72cd884702ee73ca493b3..dddb61e1564f69fdcde882da8f778e891e37a2af 100644 (file)
--- a/doc/api/Commit.textile
+++ b/doc/api/Commit.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Commit"
 navorder: 101
 ---

diff --git a/doc/api/CommitAncestor.textile b/doc/api/CommitAncestor.textile
index d8921c318d46324e7c73f8bb4180388fcd8eed67..ae444ea2fb4f20cf80b7a7bec48d07cd3edb23ba 100644 (file)
--- a/doc/api/CommitAncestor.textile
+++ b/doc/api/CommitAncestor.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: CommitAncestor"
 navorder: 101
 ---

diff --git a/doc/api/Group.textile b/doc/api/Group.textile
index 5b4fae8a394d2c9187148a6438a19d36f3090e4d..853d05214cb3b809f5ab8d796bff1a37d077c585 100644 (file)
--- a/doc/api/Group.textile
+++ b/doc/api/Group.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Group"
 navorder: 101
 ---

diff --git a/doc/api/Human.textile b/doc/api/Human.textile
index 15718f39c29abe3d36c8f615de85a689bd0b2505..11a1ddec5e63ad7c97d2e45118fe0b7d7b25ac51 100644 (file)
--- a/doc/api/Human.textile
+++ b/doc/api/Human.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Human"
 navorder: 101
 ---

diff --git a/doc/api/JobTasks.textile b/doc/api/JobTasks.textile
index 7cb3ea3b7981080167f2e19f9bb7180075796893..656ca1d257b372a821fa1604f802aa8522452f4b 100644 (file)
--- a/doc/api/JobTasks.textile
+++ b/doc/api/JobTasks.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: JobTasks"
 navorder: 16
 ---

diff --git a/doc/api/Jobs.textile b/doc/api/Jobs.textile
index d238c13e2b9163c18ff33ec28159230564c21d74..b837b3ebfcd5b2297870fa1dc9a89387f21a90ec 100644 (file)
--- a/doc/api/Jobs.textile
+++ b/doc/api/Jobs.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Jobs"
 navorder: 15
 ---

diff --git a/doc/api/KeepDisk.textile b/doc/api/KeepDisk.textile
index 6873e8b471a6784c6dbdd3c4001c2a70a91ec4a5..b013ede8a48015cba58c9959d5ce20ac6a0b3a11 100644 (file)
--- a/doc/api/KeepDisk.textile
+++ b/doc/api/KeepDisk.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: KeepDisk"
 navorder: 101
 ---

diff --git a/doc/api/Link.textile b/doc/api/Link.textile
index 95ddeb55b1079f59d4a9359c388f66f9040574f6..1bffc1f30d7dd12430aac90cfc1faceffa857000 100644 (file)
--- a/doc/api/Link.textile
+++ b/doc/api/Link.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Link"
 navorder: 101
 ---

diff --git a/doc/api/Links.textile b/doc/api/Links.textile
index be3c0892cda05e36be303897e46fa993b31c4bf6..5faa9b0c44ec49d8079da81fe777416c2971b3f8 100644 (file)
--- a/doc/api/Links.textile
+++ b/doc/api/Links.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Links"
 navorder: 17
 ---

diff --git a/doc/api/Log.textile b/doc/api/Log.textile
index adeb166197dc64287556d12eddc8936c48998dad..34ec27f4193416c94412f7351a0119bb0758f7fc 100644 (file)
--- a/doc/api/Log.textile
+++ b/doc/api/Log.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Log"
 navorder: 101
 ---

diff --git a/doc/api/Node.textile b/doc/api/Node.textile
index 9c4c4267fc44bf5dc00f22f4142369da988a7fb0..c2f0ee94330211515e0bb0153c11b1cf294d94fb 100644 (file)
--- a/doc/api/Node.textile
+++ b/doc/api/Node.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Node"
 navorder: 101
 ---

diff --git a/doc/api/PipelineInstance.textile b/doc/api/PipelineInstance.textile
index 9b4c9a306cde97b8a4944c6b11fc3adb1158d5e7..2a646c97fd74977872053501f0c7ae30022fc67d 100644 (file)
--- a/doc/api/PipelineInstance.textile
+++ b/doc/api/PipelineInstance.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: PipelineInstance"
 navorder: 101
 ---

diff --git a/doc/api/PipelineTemplate.textile b/doc/api/PipelineTemplate.textile
index 84e012845a903ea7035bcb201d3828d1ad686be1..c316ac4f7adc6a447486e03163e275741172f8a8 100644 (file)
--- a/doc/api/PipelineTemplate.textile
+++ b/doc/api/PipelineTemplate.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: PipelineTemplate"
 navorder: 101
 ---

diff --git a/doc/api/Repository.textile b/doc/api/Repository.textile
index ad954792f4c2060c6b99bac81b18101ef23ebff8..f014b48a13a94a576dc9ad7659e32da0553ac45b 100644 (file)
--- a/doc/api/Repository.textile
+++ b/doc/api/Repository.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Repository"
 navorder: 101
 ---

diff --git a/doc/api/Specimen.textile b/doc/api/Specimen.textile
index 90216aa3421bcbf870a482d89542f374a731158c..dcb4326339572d3f9c2cd26a3f8ed2d3c7ef38a9 100644 (file)
--- a/doc/api/Specimen.textile
+++ b/doc/api/Specimen.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Specimen"
 navorder: 101
 ---

diff --git a/doc/api/Trait.textile b/doc/api/Trait.textile
index d2e625d7ff0d773e27ba1d6f0201b5db302a9914..49c444e18353b50e5f6492d170423eaa6a8802dd 100644 (file)
--- a/doc/api/Trait.textile
+++ b/doc/api/Trait.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: Trait"
 navorder: 101
 ---

diff --git a/doc/api/User.textile b/doc/api/User.textile
index d5fce1a85c0b10a8f0d536afd0df7775f0dcc725..5d9d90d1980d39823a7bb3f669a83e79f1d4aba5 100644 (file)
--- a/doc/api/User.textile
+++ b/doc/api/User.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: User"
 navorder: 101
 ---

diff --git a/doc/api/VirtualMachine.textile b/doc/api/VirtualMachine.textile
index 964df01bf7648aef593265ec4daba70bb117c8ff..241f4c7fd6191ec51f1d08384a6c10ed2108f672 100644 (file)
--- a/doc/api/VirtualMachine.textile
+++ b/doc/api/VirtualMachine.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Schema
 title: "Resource: VirtualMachine"
 navorder: 101
 ---

diff --git a/doc/api/authentication.textile b/doc/api/authentication.textile
index e48be7df51e8554be9dc9088d3526e2faf2fe23d..d02f834af00f7c0e790c20145d9d8ac45367c000 100644 (file)
--- a/doc/api/authentication.textile
+++ b/doc/api/authentication.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Concepts
 title: Authentication
 navorder: 2
 ---

diff --git a/doc/api/crunch-scripts.textile b/doc/api/crunch-scripts.textile
index 859e5a722be588faddf4545462f71f0cca46c8eb..10f0c653f6db0cdd9aa10426ba192a18a675f2b5 100644 (file)
--- a/doc/api/crunch-scripts.textile
+++ b/doc/api/crunch-scripts.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Concepts
 title: Crunch scripts
 navorder: 5
 ---

diff --git a/doc/api/methods.textile b/doc/api/methods.textile
index 5b47d3f55d1d471bc2c0222cff174b2526645798..fd11ddb277ec2e00a54d3aa9902f2adbae42e77a 100644 (file)
--- a/doc/api/methods.textile
+++ b/doc/api/methods.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Concepts
 title: REST methods
 navorder: 3
 ---

diff --git a/doc/api/permission-model.textile b/doc/api/permission-model.textile
index 78b83842a106a0884940fcc09b0bfc1c47c9da26..843ab2542ca0ac60a78a7319f61d041c02cd46bc 100644 (file)
--- a/doc/api/permission-model.textile
+++ b/doc/api/permission-model.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Concepts
 title: "Permission model"
 navorder: 6
 ---

diff --git a/doc/api/resources.textile b/doc/api/resources.textile
index e6ab62e9c53a52757c819bc11380058ec61f1b4f..f7c1e690e7bd414a1ae685e99d980d2176fd2090 100644 (file)
--- a/doc/api/resources.textile
+++ b/doc/api/resources.textile
@@ -1,6 +1,7 @@
 ---
 layout: default
 navsection: api
+navmenu: Concepts
 title: Resources
 navorder: 4
 ---