Improve doc site left navbar structure
I used git poorly and accidentally broke https://github.com/bazelbuild/bazel/pull/10775.
This is the continuation of that.
Fixes https://github.com/bazelbuild/bazel/issues/10792
Preview: https://htmlpreview.github.io/?https://github.com/gregestren/bazel-docsy/blob/master/content/Bazel%20Overview%20-%20Bazel%202.1.0.htm
Closes #10815.
PiperOrigin-RevId: 296305066
diff --git a/site/_layouts/documentation.html b/site/_layouts/documentation.html
index a70c35b..f743576 100644
--- a/site/_layouts/documentation.html
+++ b/site/_layouts/documentation.html
@@ -49,29 +49,33 @@
<h3>Home</h3>
<ul class="sidebar-nav">
- <li><a href="/versions/{{ current_version }}/bazel-overview.html">Bazel Overview</a></li>
- <li><a href="/versions/{{ current_version }}/bazel-vision.html">Bazel Vision</a></li>
- <li><a href="/versions/{{ current_version }}/getting-started.html">Getting Started</a></li>
- <li><a href="/versions/{{ current_version }}/backward-compatibility.html">Backward Compatibility</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-overview.html">Bazel overview</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-vision.html">Bazel vision</a></li>
+ <li><a href="/versions/{{ current_version }}/getting-started.html">Getting started</a></li>
+ <li><a href="/versions/{{ current_version }}/backward-compatibility.html">Backward compatibility</a></li>
</ul>
- <h3>Installing and Using Bazel</h3>
+ <h3>Installing Bazel</h3>
<ul class="sidebar-nav">
+ <li class="sidebar-nav">
+ <a href="/versions/{{ current_version }}/install.html">Installation overview</a>
+ </li>
+
<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#installing-menu" aria-expanded="false"
aria-controls="installing-menu">
- Installing Bazel<span class="caret"></span>
+ Installation steps<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="installing-menu">
- <li><a href="/versions/{{ current_version }}/install.html">Installation Overview</a></li>
- <li><a href="/versions/{{ current_version }}/install-ubuntu.html">Installing on Ubuntu</a></li>
- <li><a href="/versions/{{ current_version }}/install-redhat.html">Installing on Fedora/CentOS</a></li>
- <li><a href="/versions/{{ current_version }}/install-os-x.html">Installing on macOS</a></li>
- <li><a href="/versions/{{ current_version }}/install-windows.html">Installing on Windows</a></li>
- <li><a href="/versions/{{ current_version }}/install-compile-source.html">Compiling from Source</a></li>
- <li><a href="/versions/{{ current_version }}/completion.html">Command-Line Completion</a></li>
+
+ <li><a href="/versions/{{ current_version }}/install-ubuntu.html">Ubuntu</a></li>
+ <li><a href="/versions/{{ current_version }}/install-redhat.html">Fedora/CentOS</a></li>
+ <li><a href="/versions/{{ current_version }}/install-os-x.html">macOS</a></li>
+ <li><a href="/versions/{{ current_version }}/install-windows.html">Windows</a></li>
+ <li><a href="/versions/{{ current_version }}/install-compile-source.html">Compiling from source</a></li>
+ <li><a href="/versions/{{ current_version }}/completion.html">Command-line completion</a></li>
<li><a href="/versions/{{ current_version }}/ide.html">Integrating with IDEs</a></li>
</ul>
</li>
@@ -81,36 +85,35 @@
<a href="/versions/{{ current_version }}/updating-bazel.html">Updating Bazel</a>
</li>
{% endif %}
+ </ul>
+ <h3>Using Bazel</h3>
+ <ul class="sidebar-nav">
<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#using-menu" aria-expanded="false"
aria-controls="using-menu">
- Using Bazel<span class="caret"></span>
+ Concepts<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="using-menu">
- <li><a href="/versions/{{ current_version }}/build-ref.html">Bazel Concepts</a></li>
- <li><a href="/versions/{{ current_version }}/guide.html">User's Guide (Bazel commands)</a></li>
- <li><a href="/versions/{{ current_version }}/external.html">External Dependencies</a></li>
- <li><a href="/versions/{{ current_version }}/configurable-attributes.html">Configurable Attributes</a></li>
- <li><a href="/versions/{{ current_version }}/best-practices.html">Best Practices</a></li>
- <li><a href="/versions/{{ current_version }}/memory-saving-mode.html">Memory-saving Mode</a></li>
- <li><a href="/versions/{{ current_version }}/windows.html">Using Bazel on Windows</a></li>
+ <li><a href="/versions/{{ current_version }}/build-ref.html">Core concepts</a></li>
+ <li><a href="/versions/{{ current_version }}/external.html">External dependencies</a></li>
+ <li><a href="/versions/{{ current_version }}/configurable-attributes.html">Configurable attributes</a></li>
+ <li><a href="/versions/master/platforms-intro.html">Platforms and toolchains</a></li>
</ul>
</li>
<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
- href="#build-files-menu" aria-expanded="false"
+ href="#guides-menu" aria-expanded="false"
aria-controls="build-files-menu">
- BUILD files<span class="caret"></span>
+ Guides<span class="caret"></span>
</a>
- <ul class="collapse sidebar-nav sidebar-submenu" id="build-files-menu">
- <li><a href="/versions/{{ current_version }}/be/functions.html">Functions</a></li>
- <li><a href="/versions/{{ current_version }}/be/common-definitions.html">Common Definitions</a></li>
- <li><a href="/versions/{{ current_version }}/be/make-variables.html">"Make" Variables</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/tutorial-sharing-variables.html">Sharing Variables</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/tutorial-creating-a-macro.html">Creating a Macro</a></li>
+ <ul class="collapse sidebar-nav sidebar-submenu" id="guides-menu">
+ <li><a href="/versions/{{ current_version }}/guide.html">Running Bazel</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/tutorial-creating-a-macro.html">Creating a macro</a></li>
+ <li><a href="/versions/{{ current_version }}/memory-saving-mode.html">Optimizing memory</a></li>
+ <li><a href="/versions/{{ current_version }}/windows.html">Building on Windows</a></li>
</ul>
</li>
@@ -125,10 +128,22 @@
Queries<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="query-menu">
- <li><a href="/versions/{{ current_version }}/query-how-to.html">Bazel query</a></li>
- <li><a href="/versions/{{ current_version }}/cquery.html">Bazel cquery</a></li>
- <li><a href="/versions/{{ current_version }}/aquery.html">Bazel aquery</a></li>
- <li><a href="/versions/{{ current_version }}/query.html">Query Language</a></li>
+ <li><a href="/versions/{{ current_version }}/query-how-to.html">The query command</a></li>
+ <li><a href="/versions/{{ current_version }}/cquery.html">The cquery command</a></li>
+ <li><a href="/versions/{{ current_version }}/aquery.html">The aquery command</a></li>
+ <li><a href="/versions/{{ current_version }}/query.html">Query language</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a class="sidebar-nav-heading" data-toggle="collapse"
+ href="#best-practices-menu" aria-expanded="false"
+ aria-controls="best-practices-menu">
+ Best practices<span class="caret"></span>
+ </a>
+ <ul class="collapse sidebar-nav sidebar-submenu" id="best-practices-menu">
+ <li><a href="/versions/{{ current_version }}/best-practices.html">General best practices</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/tutorial-sharing-variables.html">Sharing BUILD variables</a></li>
</ul>
</li>
@@ -136,24 +151,24 @@
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#remote-execution-menu" aria-expanded="false"
aria-controls="remote-execution-menu">
- Remote Execution<span class="caret"></span>
+ Remote execution<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="remote-execution-menu">
- <li><a href="/versions/{{ current_version }}/remote-execution.html">Remote Execution Overview</a></li>
- <li><a href="/versions/{{ current_version }}/remote-execution-rules.html">Guidelines for Remote Execution</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-execution.html">Overview</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-execution-rules.html">Guidelines</a></li>
<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#troubleshoot-remote-execution-menu" aria-expanded="false"
aria-controls="troubleshoot-remote-execution-menu">
- Troubleshooting Remote Execution<span class="caret"></span>
+ Troubleshooting<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="troubleshoot-remote-execution-menu">
- <li><a href="/versions/{{ current_version }}/remote-execution-sandbox.html">Troubleshooting Remote Execution with Bazel Sandbox</a></li>
- <li><a href="/versions/{{ current_version }}/workspace-log.html">Finding non-hermetic behavior in WORKSPACE rules</a></li>
- <li><a href="/versions/{{ current_version }}/remote-execution-caching-debug.html">Debugging Remote Cache Hit Rate</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-execution-sandbox.html">Troubleshooting with Bazel sandbox</a></li>
+ <li><a href="/versions/{{ current_version }}/workspace-log.html">Non-hermetic WORKSPACE rules</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-execution-caching-debug.html">Debugging remote cache hits</a></li>
</ul>
</li>
- <li><a href="/versions/{{ current_version }}/remote-execution-ci.html">Configuring Bazel CI for Remote Execution Rule Testing</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-execution-ci.html">Remote execution and CI</a></li>
</ul>
</li>
@@ -161,22 +176,21 @@
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#remote-caching-menu" aria-expanded="false"
aria-controls="remote-caching-menu">
- Remote Caching<span class="caret"></span>
+ Remote caching<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="remote-caching-menu">
- <li><a href="/versions/{{ current_version }}/remote-caching.html">Remote Caching Overview</a></li>
- <li><a href="/versions/{{ current_version }}/remote-caching-debug.html">Debugging Remote Cache Hit Rate for Local Execution</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-caching.html">Overview</a></li>
+ <li><a href="/versions/{{ current_version }}/remote-caching-debug.html">Debugging remote cache hits with local execution</a></li>
</ul>
</li>
{% if major_version == "master" or major_version > 1 or major_version == 1 and minor_version >= 1 %}
- <li><a href="/versions/master/platforms-intro.html">Building With Platforms</a></li>
{% endif %}
</ul>
{% if major_version == 0 %}
<h3>Rules</h3>
<ul class="sidebar-nav">
- <li><a href="/versions/{{ current_version }}/be/overview.html">Build Encyclopedia</a></li>
+ <li><a href="/versions/{{ current_version }}/be/overview.html">Build encyclopedia</a></li>
<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
@@ -186,11 +200,11 @@
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="android-menu">
<li><a href="/versions/{{ current_version }}/tutorial/android-app.html">Tutorial</a></li>
- <li><a href="/versions/{{ current_version }}/bazel-and-android.html">Android Resources</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-and-android.html">Android resources</a></li>
<li><a href="/versions/{{ current_version }}/mobile-install.html">Using mobile-install</a></li>
- <li><a href="/versions/{{ current_version }}/android-instrumentation-test.html">Android Instrumentation Tests</a></li>
+ <li><a href="/versions/{{ current_version }}/android-instrumentation-test.html">Android instrumentation tests</a></li>
<li><a href="/versions/{{ current_version }}/android-ndk.html">Android NDK</a></li>
- <li><a href="https://plugins.jetbrains.com/plugin/9185-bazel">Android Studio Plugin</a></li>
+ <li><a href="https://plugins.jetbrains.com/plugin/9185-bazel">Android Studio plugin</a></li>
</ul>
</li>
@@ -202,7 +216,7 @@
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="apple-menu">
<li><a href="/versions/{{ current_version }}/tutorial/ios-app.html">Tutorial</a></li>
- <li><a href="/versions/{{ current_version }}/bazel-and-apple.html">Apple Resources</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-and-apple.html">Apple resources</a></li>
<li><a href="/versions/{{ current_version }}/migrate-xcode.html">Migrating from Xcode</a></li>
<li><a href="/versions/{{ current_version }}/migrate-cocoapods.html">Converting CocoaPods</a></li>
</ul>
@@ -216,8 +230,8 @@
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="cpp-menu">
<li><a href="/versions/{{ current_version }}/tutorial/cpp.html">Tutorial</a></li>
- <li><a href="/versions/{{ current_version }}/bazel-and-cpp.html">C++ Resources</a></li>
- <li><a href="/versions/{{ current_version }}/cpp-use-cases.html">C++ Use Cases</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-and-cpp.html">C++ resources</a></li>
+ <li><a href="/versions/{{ current_version }}/cpp-use-cases.html">C++ use cases</a></li>
<li>
<a href="/versions/{{ current_version }}/cc-toolchain-config-reference.html">
C++ Toolchain Configuration
@@ -244,9 +258,9 @@
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="java-menu">
<li><a href="/versions/{{ current_version }}/tutorial/java.html">Tutorial</a></li>
- <li><a href="/versions/{{ current_version }}/bazel-and-java.html">Java Resources</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-and-java.html">Java resources</a></li>
<li><a href="/versions/{{ current_version }}/migrate-maven.html">Migrating from Maven</a></li>
- <li><a href="/versions/{{ current_version }}/generate-workspace.html">Converting Maven Dependencies</a></li>
+ <li><a href="/versions/{{ current_version }}/generate-workspace.html">Converting Maven dependencies</a></li>
</ul>
</li>
@@ -257,7 +271,7 @@
JavaScript<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="javascript-menu">
- <li><a href="/versions/{{ current_version }}/bazel-and-javascript.html">JavaScript Resources</a></li>
+ <li><a href="/versions/{{ current_version }}/bazel-and-javascript.html">JavaScript resources</a></li>
<li><a href="/versions/{{ current_version }}/build-javascript.html">Building JavaScript</a></li>
</ul>
</li>
@@ -267,21 +281,36 @@
<h3>Reference</h3>
<ul class="sidebar-nav">
- <li><a href="/versions/{{ current_version }}/user-manual.html">Commands and Options</a></li>
+ <li><a href="/versions/{{ current_version }}/user-manual.html">Commands and options</a></li>
+
<!-- TODO(jingwen): version this when the page is in a versioned docset. -->
<li><a href="/versions/master/glossary.html">Glossary</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/build-style.html">BUILD Style Guide</a></li>
- <li><a href="/versions/{{ current_version }}/command-line-reference.html">Command Line Reference</a></li>
- <li><a href="/versions/{{ current_version }}/test-encyclopedia.html">Writing Tests</a></li>
+
+ <li>
+ <a class="sidebar-nav-heading" data-toggle="collapse"
+ href="#build-files-menu" aria-expanded="false"
+ aria-controls="build-files-menu">
+ BUILD files<span class="caret"></span>
+ </a>
+ <ul class="collapse sidebar-nav sidebar-submenu" id="build-files-menu">
+ <li><a href="/versions/{{ current_version }}/be/functions.html">Functions</a></li>
+ <li><a href="/versions/{{ current_version }}/be/common-definitions.html">Common rule definitions</a></li>
+ <li><a href="/versions/{{ current_version }}/be/make-variables.html">"Make" variables</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/build-style.html">BUILD style guide</a></li>
+ </ul>
+ </li>
+
+ <li><a href="/versions/{{ current_version }}/command-line-reference.html">Command line reference</a></li>
+ <li><a href="/versions/{{ current_version }}/test-encyclopedia.html">Writing tests</a></li>
<li><a href="/versions/{{ current_version }}/build-event-protocol.html">Build Event Protocol</a></li>
- <li><a href="/versions/{{ current_version }}/output_directories.html">Output Directory Layout</a></li>
+ <li><a href="/versions/{{ current_version }}/output_directories.html">Output directory layout</a></li>
<li><a href="/versions/{{ current_version }}/platforms.html">Platforms</a></li>
<li><a href="/versions/{{ current_version }}/toolchains.html">Toolchains</a></li>
</ul>
- <h3>Extending Bazel</h3>
+ <h3>Extending Bazel</h3>
<ul class="sidebar-nav">
- <li><a href="/versions/{{ current_version }}/skylark/concepts.html">Extension Overview</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/concepts.html">Extension overview</a></li>
<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
@@ -294,32 +323,32 @@
<li><a href="/versions/{{ current_version }}/skylark/rules.html">Rules</a></li>
<li><a href="/versions/{{ current_version }}/skylark/depsets.html">Depsets</a></li>
<li><a href="/versions/{{ current_version }}/skylark/aspects.html">Aspects</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/repository_rules.html">Repository Rules</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/repository_rules.html">Repository rules</a></li>
<li><a href="/versions/{{ current_version }}/skylark/config.html">Configurations</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/faq.html">FAQ</a></li>
</ul>
</li>
- <li>
+ <li>
<a class="sidebar-nav-heading" data-toggle="collapse"
- href="#starlark-practices" aria-expanded="false"
- aria-controls="starlark-practices">
- Best Practices<span class="caret"></span>
+ href="#starlark-practices" aria-expanded="false"
+ aria-controls="starlark-practices">
+ Best practices<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="starlark-practices">
- <li><a href="/versions/{{ current_version }}/skylark/bzl-style.html">.bzl Style Guide</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/testing.html">Testing</a></li>
- <li><a href="https://skydoc.bazel.build" target="_blank">Documenting Rules</a></li>
- <li><a href="https://github.com/bazelbuild/buildtools/tree/master/buildifier">Linter</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/performance.html">Optimizing Performance</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/deploying.html">Deploying Rules</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/bzl-style.html">.bzl style guide</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/testing.html">Testing extensions</a></li>
+ <li><a href="https://skydoc.bazel.build" target="_blank">Documenting rules</a></li>
+ <li><a href="https://github.com/bazelbuild/buildtools/tree/master/buildifier">Linting</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/performance.html">Optimizing performance</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/deploying.html">Deploying rules</a></li>
<li><a href="/versions/{{ current_version }}/skylark/windows_tips.html">Writing rules on Windows</a></li>
</ul>
</li>
<li><a href="https://github.com/bazelbuild/examples/tree/master/rules">Examples</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/lib/skylark-overview.html">API Reference</a></li>
- <li><a href="/versions/{{ current_version }}/skylark/language.html">Starlark Language</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/lib/skylark-overview.html">Extensions API</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/faq.html">FAQ</a></li>
+ <li><a href="/versions/{{ current_version }}/skylark/language.html">Starlark language</a></li>
</ul>
</nav>
</div>
