A series of changes to the top nav bar to make it more compact.
authorWard Vandewege <ward@curoverse.com>
Wed, 11 Mar 2015 18:39:10 +0000 (14:39 -0400)
committerWard Vandewege <ward@curoverse.com>
Wed, 11 Mar 2015 18:39:10 +0000 (14:39 -0400)
Refs #5211

doc/_config.yml
doc/_includes/_navbar_top.liquid
doc/admin/index.html.md.liquid [deleted file]
doc/index.html.liquid
doc/install/cheat_sheet.html.textile.liquid [moved from doc/admin/cheat_sheet.html.textile.liquid with 70% similarity]

index 3dd2e2e298bf5428b78c79449d268f77ddd945c5..4e81cbf838174721d3abf6008fa2a375f38cadae 100644 (file)
@@ -135,10 +135,6 @@ navbar:
       - api/schema/Trait.html.textile.liquid
       - api/schema/User.html.textile.liquid
       - api/schema/VirtualMachine.html.textile.liquid
-  admin:
-    - Admin:
-      - admin/index.html.md.liquid
-      - admin/cheat_sheet.html.textile.liquid
   installguide:
     - Overview:
       - install/index.html.textile.liquid
@@ -155,6 +151,7 @@ navbar:
       - install/install-keepproxy.html.textile.liquid
       - install/install-crunch-dispatch.html.textile.liquid
       - install/install-compute-node.html.textile.liquid
+      - install/cheat_sheet.html.textile.liquid
     - Software prerequisites:
       - install/install-manual-prerequisites-ruby.html.textile.liquid
       - install/install-sso.html.textile.liquid
index c6c8b28bff7f5ff95a3076842a1c2015215eaea8..9ac810140b8e925f26afce6851dafe74b28c2d9d 100644 (file)
       <ul class="nav navbar-nav">
         <li {% if page.navsection == 'start' %} class="active" {% endif %}><a href="{{ site.baseurl }}/start/index.html">Getting&nbsp;Started</a></li>
         <li {% if page.navsection == 'userguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/user/index.html">User&nbsp;Guide</a></li>
-        <li {% if page.navsection == 'sdk' %} class="active" {% endif %}><a href="{{ site.baseurl }}/sdk/index.html">SDK&nbsp;Reference</a></li>
-        <li {% if page.navsection == 'api' %} class="active" {% endif %}><a href="{{ site.baseurl }}/api/index.html">API&nbsp;Reference</a></li>
-        <li {% if page.navsection == 'adminguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/admin/index.html">Admin Guide</a></li>
-        <li {% if page.navsection == 'installguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/install/index.html">Install Guide</a></li>
+        <li {% if page.navsection == 'sdk' %} class="active" {% endif %}><a href="{{ site.baseurl }}/sdk/index.html">SDKs</a></li>
+        <li {% if page.navsection == 'api' %} class="active" {% endif %}><a href="{{ site.baseurl }}/api/index.html">API</a></li>
+        <li {% if page.navsection == 'installguide' %} class="active" {% endif %}><a href="{{ site.baseurl }}/install/index.html">Install</a></li>
         <li><a href="https://arvados.org/projects/arvados/" style="padding-left: 2em">Developer Site&nbsp;&raquo;</a></li>
       </ul>
     </div>
diff --git a/doc/admin/index.html.md.liquid b/doc/admin/index.html.md.liquid
deleted file mode 100644 (file)
index f0ed3ad..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
----
-layout: default
-navsection: admin
-title: Overview
-...
-
-{% include 'alert_stub' %}
-
-# Administration Overview
-
-Unlike other users, administrators
-
-* can see and modify all user-created objects regardless of permission settings
-* can directly create and modify system objects like Nodes and ApiClients
index 9bd537aa56739c730d00f65df266660e78d131c7..53a798ffa6adaa58f2f5fa8b1ff3aaf562c19be1 100644 (file)
@@ -52,9 +52,6 @@ title: Arvados
       <p>
         <a href="{{ site.baseurl }}/api/index.html">API Reference</a> &mdash; Details about the the Arvados REST API.
       </p>
-      <p>
-        <a href="{{ site.baseurl }}/admin/index.html">Admin Guide</a> &mdash; How to administer an Arvados system.
-      </p>
       <p>
         <a href="{{ site.baseurl }}/install/index.html">Install Guide</a> &mdash; How to install Arvados on a cloud platform.
       </p>
similarity index 70%
rename from doc/admin/cheat_sheet.html.textile.liquid
rename to doc/install/cheat_sheet.html.textile.liquid
index 83fa5e8f1be5f6340f0d01993bca0138ac695891..115c62e0d3107722e484d181a5ec4b5f057ea05a 100644 (file)
@@ -1,10 +1,12 @@
 ---
 layout: default
-navsection: admin
+navsection: installguide
 title: Cheat Sheet
 ...
 
+h3. Workbench: user management
 
+As an Admin user, use the gear icon on the top right to visit the Users page. From there, use the 'Add new user' button to create a new user. Alternatively, visit an existing user with the 'Show' button next to the user's name. Then use the 'Admin' tab and click the 'Setup' button to activate the user, and create a virtual machine login as well as git repository for them.
 
 h3. CLI setup
 
@@ -13,13 +15,13 @@ ARVADOS_API_HOST={{ site.arvados_api_host }}
 ARVADOS_API_TOKEN=1234567890qwertyuiopasdfghjklzxcvbnm1234567890zzzz
 </pre>
 
-h3. Create VM
+h3. CLI: Create VM
 
 <pre>
 arv virtual_machine create --virtual-machine '{"hostname":"xxxxxxxchangeme.example.com"}'
 </pre>
 
-h3. Activate user
+h3. CLI: Activate user
 
 <pre>
 user_uuid=xxxxxxxchangeme
@@ -47,7 +49,7 @@ read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"
 EOF
 </pre>
 
-h3. User &rarr; repo
+h3. CLI: User &rarr; repo
 
 Give @$user_uuid@ permission to commit to @$repo_uuid@ as @$repo_username@