Fix paths in Bazel docs, removing references to versions/master.

Follow-up to https://github.com/bazelbuild/bazel/commit/22b85a2a3c79c6f3aef1e0a61e485bb135be4551. This change updates paths and URLs to Bazel docs, removing the versions/master directory and changing bazel.build/docs to docs.bazel.build. For clarification on the convention of the docs site, links referencing docs.bazel.build/foo.html will be redirected to docs.bazel.build/versions/master/foo.html. The versions/master directory will contain the documentation pages pushed from HEAD. Once versioned documentation is ready, then docs.bazel.build/foo.html will instead be redirected to docs.bazel.build/x.y.z/foo.html, where x.y.z is the directory for the latest stable Bazel version. Follow-ups to this change: * Add script that will be used by the daily push job that pushes the latest documentation from HEAD to docs.bazel.build. This script will do the following: * Build the Jekyll tree, run jekyll build, and modify the resulting site tree, moving the docs/ directory into versions/master. * Add redirects for each of the site pages from the root of the site to the corresponding page in versions/master. * This should give us the minimum viable product for the new docs site. * Add script for cutting a release of the docs and pushing to a new versioned directory on the docs.bazel.build bucket. RELNOTES: None PiperOrigin-RevId: 158347197
author: dzc <dzc@google.com> 2017-06-07 21:51:52 -0400
committer: John Cater <jcater@google.com> 2017-06-08 10:52:56 -0400
commit: 5596d3bd9e938a3592c4e873763baec0953c9434 (patch)
tree: a30349414f1f1fea1e2a99f4f1aac5d103fc5827 /site/_layouts
parent: 7dec00574aa91327693f6ba7e90bff5bc834253e (diff)
1 files changed, 50 insertions, 51 deletions
diff --git a/site/_layouts/documentation.html b/site/_layouts/documentation.html
index e35902af07..6a04f6ef8c 100644
--- a/site/_layouts/documentation.html
+++ b/site/_layouts/documentation.html
@@ -1,6 +1,5 @@
 ---
 nav: docs
-version_prefix: /versions/master
 ---
 
 <!DOCTYPE html>
@@ -25,7 +24,7 @@ version_prefix: /versions/master
           </a>
           <nav class="sidebar collapse" id="sidebar-nav">
             <ul class="sidebar-nav">
-              <li><a href="{{ page.version_prefix }}/docs/bazel-overview.html">Bazel Overview</a></li>
+              <li><a href="/versions/{{ site.version }}/bazel-overview.html">Bazel Overview</a></li>
 
               <li>
                 <a class="sidebar-nav-heading" data-toggle="collapse"
@@ -34,15 +33,15 @@ version_prefix: /versions/master
                   Installing <span class="caret"></span>
                 </a>
                 <ul class="collapse sidebar-nav sidebar-submenu" id="installing-menu">
-                  <li><a href="{{ page.version_prefix }}/docs/install.html">Installing Bazel</a></li>
-                  <li><a href="{{ page.version_prefix }}/docs/install-ubuntu.html">Installing Bazel on Ubuntu</a></li>
-                  <li><a href="{{ page.version_prefix }}/docs/install-os-x.html">Installing Bazel on macOS (OS X)</a></li>
-                  <li><a href="{{ page.version_prefix }}/docs/install-windows.html">Installing Bazel on Windows</a></li>
-                  <li><a href="{{ page.version_prefix }}/docs/install-compile-source.html">Compile Bazel from Source</a></li>
+                  <li><a href="/versions/{{ site.version }}/install.html">Installing Bazel</a></li>
+                  <li><a href="/versions/{{ site.version }}/install-ubuntu.html">Installing Bazel on Ubuntu</a></li>
+                  <li><a href="/versions/{{ site.version }}/install-os-x.html">Installing Bazel on macOS (OS X)</a></li>
+                  <li><a href="/versions/{{ site.version }}/install-windows.html">Installing Bazel on Windows</a></li>
+                  <li><a href="/versions/{{ site.version }}/install-compile-source.html">Compile Bazel from Source</a></li>
                 </ul>
               </li>
 
-              <li><a href="{{ page.version_prefix }}/docs/getting-started.html">Getting Started</a></li>
+              <li><a href="/versions/{{ site.version }}/getting-started.html">Getting Started</a></li>
 
               <li>
                 <a class="sidebar-nav-heading" data-toggle="collapse"
@@ -51,77 +50,77 @@ version_prefix: /versions/master
                   Tutorial <span class="caret"></span>
                 </a>
                 <ul class="collapse sidebar-nav sidebar-submenu" id="tutorial-menu">
-                  <li><a href="{{ page.version_prefix }}/docs/tutorial/java.html">Build a Java Project</a></li>
-                  <li><a href="{{ page.version_prefix }}/docs/tutorial/cpp.html">Build a C++ Project</a></li>
-                  <li><a href="{{ page.version_prefix }}/docs/tutorial/cpp-use-cases.html">Common C++ Use Cases</a></li>
+                  <li><a href="/versions/{{ site.version }}/tutorial/java.html">Build a Java Project</a></li>
+                  <li><a href="/versions/{{ site.version }}/tutorial/cpp.html">Build a C++ Project</a></li>
+                  <li><a href="/versions/{{ site.version }}/tutorial/cpp-use-cases.html">Common C++ Use Cases</a></li>
                   <li>
                     <a class="sidebar-nav-heading" href="#app-menu"
                        data-toggle="collapse" aria-expanded="false" aria-controls="app-menu">
                       Build a Mobile Application
                     </a>
                     <ul class="collapse sidebar-nav sidebar-submenu" id="app-menu">
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/app.html">Introduction</a></li>
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/environment.html">Set Up Your Environment</a></li>
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/workspace.html">Set Up a Workspace</a></li>
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/android-app.html">Build an Android App</a></li>
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/ios-app.html">Build an iOS App</a></li>
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/backend-server.html">Build the Backend Server</a></li>
-                      <li><a href="{{ page.version_prefix }}/docs/tutorial/review.html">Review</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/app.html">Introduction</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/environment.html">Set Up Your Environment</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/workspace.html">Set Up a Workspace</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/android-app.html">Build an Android App</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/ios-app.html">Build an iOS App</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/backend-server.html">Build the Backend Server</a></li>
+                      <li><a href="/versions/{{ site.version }}/tutorial/review.html">Review</a></li>
                     </ul>
                   </li>
                 </ul>
               </li>
-              <li><a href="{{ page.version_prefix }}/docs/support.html">Get Support</a></li>
+              <li><a href="/versions/{{ site.version }}/support.html">Get Support</a></li>
             </ul>
             <h3>Using Bazel</h3>
             <ul class="sidebar-nav">
-              <li><a href="{{ page.version_prefix }}/docs/build-ref.html">Concepts and Terminology</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/bazel-user-manual.html">User Manual</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/test-encyclopedia.html">Writing Tests</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/query.html">Query Language</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/query-how-to.html">Query How-To</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/mobile-install.html">mobile-install (Android)</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/external.html">External Dependencies</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/command-line-reference.html">Command-line Reference</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/output_directories.html">Output Directories</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/windows.html">Bazel on Windows</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/best-practices.html">Best Practices</a></li>
+              <li><a href="/versions/{{ site.version }}/build-ref.html">Concepts and Terminology</a></li>
+              <li><a href="/versions/{{ site.version }}/bazel-user-manual.html">User Manual</a></li>
+              <li><a href="/versions/{{ site.version }}/test-encyclopedia.html">Writing Tests</a></li>
+              <li><a href="/versions/{{ site.version }}/query.html">Query Language</a></li>
+              <li><a href="/versions/{{ site.version }}/query-how-to.html">Query How-To</a></li>
+              <li><a href="/versions/{{ site.version }}/mobile-install.html">mobile-install (Android)</a></li>
+              <li><a href="/versions/{{ site.version }}/external.html">External Dependencies</a></li>
+              <li><a href="/versions/{{ site.version }}/command-line-reference.html">Command-line Reference</a></li>
+              <li><a href="/versions/{{ site.version }}/output_directories.html">Output Directories</a></li>
+              <li><a href="/versions/{{ site.version }}/windows.html">Bazel on Windows</a></li>
+              <li><a href="/versions/{{ site.version }}/best-practices.html">Best Practices</a></li>
             </ul>
             {% include be-nav.html %}
             <h3>Extensions</h3>
             <ul class="sidebar-nav">
-              <li><a href="{{ page.version_prefix }}/docs/skylark/concepts.html">Overview</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/language.html">Language</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/macros.html">Macros</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/rules.html">Rules</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/depsets.html">Depsets</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/aspects.html">Aspects</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/repository_rules.html">Repository rules</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/rule-challenges.html">Challenges of writing rules</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/lib/skylark-overview.html">Reference</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/cookbook.html">Examples</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/deploying.html">Packaging rules</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/concepts.html">Overview</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/language.html">Language</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/macros.html">Macros</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/rules.html">Rules</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/depsets.html">Depsets</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/aspects.html">Aspects</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/repository_rules.html">Repository rules</a></li>
+              <li><a href="/versions/{{ site.version }}/rule-challenges.html">Challenges of writing rules</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/lib/skylark-overview.html">Reference</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/cookbook.html">Examples</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/deploying.html">Packaging rules</a></li>
               <li><a href="https://skydoc.bazel.build" target="_blank">Documenting rules</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/build-style.html">Style guide for BUILD files</a></li>
-              <li><a href="{{ page.version_prefix }}/docs/skylark/bzl-style.html">Style guide for bzl files</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/build-style.html">Style guide for BUILD files</a></li>
+              <li><a href="/versions/{{ site.version }}/skylark/bzl-style.html">Style guide for bzl files</a></li>
             </ul>
           </nav>
         </div>
         <div class="col-lg-9">
           <a id="gh-edit" class="gh-edit default-hidden"><i class="fa fa-pencil" aria-hidden="true"></i> Edit</a>
           <script>
-            var ghDocsBazeURL = 'https://github.com/bazelbuild/bazel/tree/master/site/versions/master/docs/';
+            var ghDocsBazeURL = 'https://github.com/bazelbuild/bazel/tree/master/site/docs/';
             var editButton = document.getElementById('gh-edit');
             // if there is an edit button and we are on a doc page but not in the Build Encyclopedia
-            if(editButton
-              && window.location.pathname.split('docs/').length > 1
-              && window.location.pathname.lastIndexOf('/be/') == -1) {
+            if (editButton
+                && window.location.pathname.split('docs/').length > 1
+                && window.location.pathname.lastIndexOf('/be/') == -1) {
               var docFile = window.location.pathname.split('docs/')[1];
               // some pages are now using markdown :(
-              if( docFile !== 'bazel-user-manual.html'
-              && docFile !== 'build-ref.html'
-              && docFile !== 'query.html'
-              && docFile !== 'test-encyclopedia.html') {
+              if (docFile !== 'bazel-user-manual.html'
+                  && docFile !== 'build-ref.html'
+                  && docFile !== 'query.html'
+                  && docFile !== 'test-encyclopedia.html') {
                 docFile = docFile.replace('html', 'md');
               }
               editButton.href = ghDocsBazeURL + docFile;
author	dzc <dzc@google.com>	2017-06-07 21:51:52 -0400
committer	John Cater <jcater@google.com>	2017-06-08 10:52:56 -0400
commit	5596d3bd9e938a3592c4e873763baec0953c9434 (patch)
tree	a30349414f1f1fea1e2a99f4f1aac5d103fc5827 /site/_layouts
parent	7dec00574aa91327693f6ba7e90bff5bc834253e (diff)