From 8d149b6d680e124f4079dfd5788ead5dbbc34c41 Mon Sep 17 00:00:00 2001 From: Tim Pierce Date: Mon, 23 Dec 2013 15:13:19 -0500 Subject: [PATCH] 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. --- doc/_config.yml | 12 ++++++++---- doc/_includes/navbar_left.html | 6 +++--- doc/api/ApiClientAuthorization.textile | 1 + doc/api/ApiClients.textile | 1 + doc/api/AuthorizedKey.textile | 1 + doc/api/Collections.textile | 1 + doc/api/Commit.textile | 1 + doc/api/CommitAncestor.textile | 1 + doc/api/Group.textile | 1 + doc/api/Human.textile | 1 + doc/api/JobTasks.textile | 1 + doc/api/Jobs.textile | 1 + doc/api/KeepDisk.textile | 1 + doc/api/Link.textile | 1 + doc/api/Links.textile | 1 + doc/api/Log.textile | 1 + doc/api/Node.textile | 1 + doc/api/PipelineInstance.textile | 1 + doc/api/PipelineTemplate.textile | 1 + doc/api/Repository.textile | 1 + doc/api/Specimen.textile | 1 + doc/api/Trait.textile | 1 + doc/api/User.textile | 1 + doc/api/VirtualMachine.textile | 1 + doc/api/authentication.textile | 1 + doc/api/crunch-scripts.textile | 1 + doc/api/methods.textile | 1 + doc/api/permission-model.textile | 1 + doc/api/resources.textile | 1 + 29 files changed, 38 insertions(+), 7 deletions(-) diff --git a/doc/_config.yml b/doc/_config.yml index d214f8406e..a4fed53b19 100644 --- 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 81e94b7328..d593ff33e0 100644 --- a/doc/_includes/navbar_left.html +++ b/doc/_includes/navbar_left.html @@ -1,14 +1,14 @@
- {% if page.navsection == 'userguide' %} + {% if page.navsection == 'userguide' or page.navsection == 'api' %}
    - {% for menu_item in site.navbar.userguide %} + {% for menu_item in site.navbar[page.navsection] %}
  1. {{ menu_item }}
      {% 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 %}
    1. {{ p.title }}
      2. {% endif %}{% endfor %}{% endfor %}
    diff --git a/doc/api/ApiClientAuthorization.textile b/doc/api/ApiClientAuthorization.textile index 133b9cbb19..cb8a8e67ec 100644 --- 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 b4bc5d1876..7acfcf076d 100644 --- 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 6450807408..28b7769013 100644 --- 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 428cdddd95..90dcf2e928 100644 --- 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 9bb8dbf884..dddb61e156 100644 --- 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 d8921c318d..ae444ea2fb 100644 --- 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 5b4fae8a39..853d05214c 100644 --- 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 15718f39c2..11a1ddec5e 100644 --- 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 7cb3ea3b79..656ca1d257 100644 --- 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 d238c13e2b..b837b3ebfc 100644 --- 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 6873e8b471..b013ede8a4 100644 --- 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 95ddeb55b1..1bffc1f30d 100644 --- 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 be3c0892cd..5faa9b0c44 100644 --- 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 adeb166197..34ec27f419 100644 --- 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 9c4c4267fc..c2f0ee9433 100644 --- 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 9b4c9a306c..2a646c97fd 100644 --- 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 84e012845a..c316ac4f7a 100644 --- 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 ad954792f4..f014b48a13 100644 --- 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 90216aa342..dcb4326339 100644 --- 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 d2e625d7ff..49c444e183 100644 --- 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 d5fce1a85c..5d9d90d198 100644 --- 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 964df01bf7..241f4c7fd6 100644 --- 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 e48be7df51..d02f834af0 100644 --- 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 859e5a722b..10f0c653f6 100644 --- 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 5b47d3f55d..fd11ddb277 100644 --- 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 78b83842a1..843ab2542c 100644 --- 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 e6ab62e9c5..f7c1e690e7 100644 --- a/doc/api/resources.textile +++ b/doc/api/resources.textile @@ -1,6 +1,7 @@ --- layout: default navsection: api +navmenu: Concepts title: Resources navorder: 4 --- -- 2.30.2