Skip to content

Commit

Permalink
Update 5.0.0 docs
Browse files Browse the repository at this point in the history
#14013

PiperOrigin-RevId: 422828731
  • Loading branch information
Wyverald authored and copybara-github committed Jan 19, 2022
1 parent 975fb51 commit 10e3f5e
Show file tree
Hide file tree
Showing 5 changed files with 236 additions and 1 deletion.
4 changes: 4 additions & 0 deletions scripts/docs/doc_versions.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"""This module contains the versions and hashes of Bazel's documentation tarballs."""

DOC_VERSIONS = [
{
"version": "5.0.0",
"sha256": "8987121070113ebad742d975345263d3cfa46c16a287797d78543935e852d39c",
},
{
"version": "4.2.2",
"sha256": "2447e768d8ae1f62fbf59809b5a4ef45967be6a6cedb66cec3daeb062de0b68e",
Expand Down
3 changes: 2 additions & 1 deletion site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ gems:
url: "https://docs.bazel.build" # used by jekyll-sitemap

# Update this to the newest release for the default docs.bazel.build version.
version: "4.2.2"
version: "5.0.0"

# This must be kept in sync with //scripts/docs:doc_versions.bzl
doc_versions:
- main
- 5.0.0
- 4.2.2
- 4.2.1
- 4.2.0
Expand Down
228 changes: 228 additions & 0 deletions site/_includes/documentation-sidebar/5/sidebar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
<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>
</ul>

<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">
Installation steps<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="installing-menu">

<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>

<li class="sidebar-nav">
<a href="/versions/{{ current_version }}/updating-bazel.html">Updating Bazel</a>
</li>
</ul>

<h3>Tutorials</h3>
<ul class="sidebar-nav">
<li><a href="/versions/{{ current_version }}/tutorial/cpp.html">C++</a></li>
<li><a href="/versions/{{ current_version }}/tutorial/java.html">Java</a></li>
<li><a href="/versions/{{ current_version }}/tutorial/android-app.html">Android</a></li>
<li><a href="/versions/{{ current_version }}/tutorial/ios-app.html">iOS</a></li>
</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">
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">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/main/platforms-intro.html">Platforms and toolchains</a></li>
<li><a href="/versions/main/visibility.html">Visibility</a></li>
</ul>
</li>

<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#guides-menu" aria-expanded="false"
aria-controls="build-files-menu">
Guides<span class="caret"></span>
</a>
<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>

<li><a href="/versions/{{ current_version }}/rules.html">Rules</a></li>

<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#query-menu" aria-expanded="false"
aria-controls="query-menu">
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">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>

<li>
<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>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="remote-execution-menu">
<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<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 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">Remote execution and CI</a></li>
</ul>
</li>

<li>
<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>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="remote-caching-menu">
<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>
</ul>

<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 }}/glossary.html">Glossary</a></li>
<li><a href="/versions/{{ current_version }}/be/overview.html">Build encyclopedia</a></li>
<li><a href="/versions/{{ current_version }}/test-encyclopedia.html">Test encyclopedia</a></li>
<li><a href="/versions/{{ current_version }}/command-line-reference.html">Command line reference</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 }}/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 }}/platforms.html">Platforms</a></li>
<li><a href="/versions/{{ current_version }}/exec-groups.html">Execution Groups</a></li>
<li><a href="/versions/{{ current_version }}/toolchains.html">Toolchains</a></li>
</ul>

<h3>Extending Bazel</h3>
<ul class="sidebar-nav">
<li><a href="/versions/{{ current_version }}/skylark/concepts.html">Extension overview</a></li>

<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#starlark-concepts" aria-expanded="false"
aria-controls="starlark-concepts">
Concepts<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="starlark-concepts">
<li><a href="/versions/{{ current_version }}/skylark/macros.html">Macros</a></li>
<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/config.html">Configurations</a></li>
</ul>
</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>
</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 extensions</a></li>
<li><a href="https://github.com/bazelbuild/stardoc">Documenting rules with Stardoc</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/HEAD/rules">Examples</a></li>
<li><a href="/versions/{{ current_version }}/skylark/lib/skylark-overview.html">Extensions API</a></li>

<li>
<a class="sidebar-nav-heading" data-toggle="collapse"
href="#persistent-workers" aria-expanded="false"
aria-controls="persistent-workers">
Persistent workers<span class="caret"></span>
</a>
<ul class="collapse sidebar-nav sidebar-submenu" id="persistent-workers">
<li><a href="/versions/{{ current_version }}/persistent-workers.html">Persistent workers</a></li>
<li><a href="/versions/{{ current_version }}/multiplex-worker.html">Multiplex workers</a></li>
<li><a href="/versions/{{ current_version }}/creating-workers.html">Creating persistent workers</a></li>
</ul>
</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>
1 change: 1 addition & 0 deletions site/_includes/extending-sidebar/5
1 change: 1 addition & 0 deletions site/_includes/getting-started-sidebar/5

0 comments on commit 10e3f5e

Please sign in to comment.