1. Add extending Bazel section to Bazel navigation header. 2. Rename Documentation to Using Bazel. PiperOrigin-RevId: 359802645
diff --git a/site/_config.yml b/site/_config.yml index ad43cfa..563f984 100644 --- a/site/_config.yml +++ b/site/_config.yml
@@ -56,6 +56,7 @@ main_site_url: https://www.bazel.build getting_started_category_url: "/bazel-overview.html" docs_site_url: "/guide.html" +extending_category_url: "/skylark/concepts.html" blog_site_url: https://blog.bazel.build defaults:
diff --git a/site/_includes/documentation-sidebar/master/sidebar.html b/site/_includes/documentation-sidebar/master/sidebar.html index 32abce3..5e3b980 100644 --- a/site/_includes/documentation-sidebar/master/sidebar.html +++ b/site/_includes/documentation-sidebar/master/sidebar.html
@@ -7,14 +7,6 @@ <li><a href="/versions/{{ current_version }}/skylark/tutorial-sharing-variables.html">Sharing BUILD Variables</a></li> </ul> -<h3>Rules and Macros</h3> - <ul class="sidebar-nav"> - <li><a href="/versions/{{ current_version }}/rules.html">Understanding Rules</a></li> - <li><a href="/versions/{{ current_version }}/skylark/rules-tutorial.html">Writing Rules</a></li> - <li><a href="/versions/{{ current_version }}/rule-challenges.html">Rules Challenges</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 }}/skylark/tutorial-custom-verbs.html">Creating Custom Verbs</a></li> - </ul> <h3>Query for Dependencies</h3> <ul class="sidebar-nav"> @@ -55,64 +47,6 @@ </ul> -<h3>Extending Bazel</h3> -<ul class="sidebar-nav"> - <li><a href="/versions/{{ current_version }}/skylark/concepts.html">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/master/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/rules-tutorial.html">Rules tutorial</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> - <h3>Reference</h3> <ul class="sidebar-nav"> <li><a href="/versions/{{ current_version }}/user-manual.html">Commands and Options</a></li>
diff --git a/site/_includes/extending-sidebar/master/sidebar.html b/site/_includes/extending-sidebar/master/sidebar.html new file mode 100644 index 0000000..d587db7 --- /dev/null +++ b/site/_includes/extending-sidebar/master/sidebar.html
@@ -0,0 +1,66 @@ +<h3>Extending Bazel</h3> + <ul class="sidebar-nav"> + <li><a href="/versions/{{ current_version }}/skylark/concepts.html">Overview</a></li> + <li><a href="/versions/{{ current_version }}/skylark/language.html">Starlark Language</a></li> + <li><a href="/versions/{{ current_version }}/skylark/bzl-style.html">.bzl Style Guide</a></li> + <li><a href="/versions/{{ current_version }}/skylark/faq.html">FAQ</a></li> + </ul> + +<h3>Understanding Rules</h3> + <ul class="sidebar-nav" + id="starlark-concepts" + aria-controls="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> + +<h3>Writing Rules</h3> + + <ul class="sidebar-nav"> + <li><a href="/versions/{{ current_version }}/rules.html">Recommended & Native Rules</a></li> + <li><a href="/versions/{{ current_version }}/skylark/rules-tutorial.html">Writing Rules</a></li> + <li><a href="/versions/{{ current_version }}/skylark/windows_tips.html">Writing Rules on Windows</a></li> + <li><a href="https://github.com/bazelbuild/examples/tree/master/rules">Example rules</a></li> + <li><a href="/versions/{{ current_version }}/rule-challenges.html">Rules Challenges</a></li> + </ul> + +<h3>Writing Macros</h3> + + <ul class="sidebar-nav"> + <li><a href="/versions/{{ current_version }}/skylark/tutorial-creating-a-macro.html">Creating a Macro</a></li> + <li><a href="/versions/{{ current_version }}/skylark/tutorial-custom-verbs.html">Creating Custom Verbs</a></li> + </ul> + + +<h3>Testing & Deploying Rules</h3> + <ul class="sidebar-nav" + id="starlark-practices" + aria-controls="starlark-practices"> + <li><a href="/versions/{{ current_version }}/skylark/testing.html">Testing 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="https://github.com/bazelbuild/stardoc">Documenting Rules with Stardoc</a></li> + </ul> + + +<h3>Using Persistent Workers</h3> + + <ul class="sidebar-nav" + id="persistent-workers" + aria-controls="persistent-workers"> + <li><a href="/versions/{{ current_version }}/persistent-workers.html">Understanding 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> + +<h3>Reference</h3> + <ul class="sidebar-nav" + id="starlark-reference" + aria-controls="starlark-reference"> + <li><a href="/versions/{{ current_version }}/skylark/lib/skylark-overview.html">Extensions API</a></li> + </ul>
diff --git a/site/_includes/header.html b/site/_includes/header.html index 522d347..da011a2 100644 --- a/site/_includes/header.html +++ b/site/_includes/header.html
@@ -31,10 +31,13 @@ <a href="/versions/{{ current_version}}{{ site.getting_started_category_url }}">Getting Started</a> </li> <li{% if page.nav == "docs" %} class="active"{% endif %}> - <a href="/versions/{{ current_version }}{{ site.docs_site_url }}">Documentation</a> + <a href="/versions/{{ current_version }}{{ site.docs_site_url }}">Using Bazel</a> + </li> + <li{% if page.nav == "docs" %} class="active"{% endif %}> + <a href="/versions/{{ current_version }}{{ site.extending_category_url}}">Extending Bazel</a> </li> <li{% if page.nav == "contribute" %} class="active"{% endif %}> - <a href="{{ site.main_site_url }}/contributing.html">Contribute</a> + <a href="{{ site.main_site_url }}/contributing.html">Contributing</a> </li> <li{% if page.nav == "blog" %} class="active"{% endif %}> <a href="{{ site.blog_site_url }}">Blog</a>
diff --git a/site/docs/creating-workers.md b/site/docs/creating-workers.md index 232d515..b9140cb 100644 --- a/site/docs/creating-workers.md +++ b/site/docs/creating-workers.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Creating persistent workers +category: extending --- # Creating Persistent Workers
diff --git a/site/docs/multiplex-worker.md b/site/docs/multiplex-worker.md index 72a395e..b762e68 100644 --- a/site/docs/multiplex-worker.md +++ b/site/docs/multiplex-worker.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Multiplex workers +category: extending --- # Multiplex Workers (Experimental Feature)
diff --git a/site/docs/persistent-workers.md b/site/docs/persistent-workers.md index f6c2307..c790a35 100644 --- a/site/docs/persistent-workers.md +++ b/site/docs/persistent-workers.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Persistent Workers +category: extending --- # Persistent Workers
diff --git a/site/docs/rules.md b/site/docs/rules.md index 68fa262..e171216 100644 --- a/site/docs/rules.md +++ b/site/docs/rules.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Rules +category: extending --- # Rules
diff --git a/site/docs/skylark/aspects.md b/site/docs/skylark/aspects.md index 3754ddf..2e4db44 100644 --- a/site/docs/skylark/aspects.md +++ b/site/docs/skylark/aspects.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Aspects +category: extending --- # Aspects
diff --git a/site/docs/skylark/bzl-style.md b/site/docs/skylark/bzl-style.md index 3003d3c..402af53 100644 --- a/site/docs/skylark/bzl-style.md +++ b/site/docs/skylark/bzl-style.md
@@ -1,6 +1,7 @@ --- layout: documentation title: .bzl style guide +category: extending --- # .bzl style guide
diff --git a/site/docs/skylark/concepts.md b/site/docs/skylark/concepts.md index 1b4013f..83f8154 100644 --- a/site/docs/skylark/concepts.md +++ b/site/docs/skylark/concepts.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Extension overview +category: extending --- # Extension Overview
diff --git a/site/docs/skylark/config.md b/site/docs/skylark/config.md index a7ad59a..ee26469 100644 --- a/site/docs/skylark/config.md +++ b/site/docs/skylark/config.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Configurations +category: extending --- # Configurations
diff --git a/site/docs/skylark/deploying.md b/site/docs/skylark/deploying.md index 2aec4b7..7380c05 100644 --- a/site/docs/skylark/deploying.md +++ b/site/docs/skylark/deploying.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Deploying rules +category: extending --- # Deploying Rules
diff --git a/site/docs/skylark/depsets.md b/site/docs/skylark/depsets.md index 86b8ded..3ab237f 100644 --- a/site/docs/skylark/depsets.md +++ b/site/docs/skylark/depsets.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Depsets +category: extending --- # Depsets
diff --git a/site/docs/skylark/faq.md b/site/docs/skylark/faq.md index e48ff2d..40de900 100644 --- a/site/docs/skylark/faq.md +++ b/site/docs/skylark/faq.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Extension FAQ +category: extending --- # Frequently Asked Questions
diff --git a/site/docs/skylark/language.md b/site/docs/skylark/language.md index 32d397e..ab1b79c 100644 --- a/site/docs/skylark/language.md +++ b/site/docs/skylark/language.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Starlark language +category: extending --- # Starlark Language
diff --git a/site/docs/skylark/macros.md b/site/docs/skylark/macros.md index f1c3d6d..d201c44 100644 --- a/site/docs/skylark/macros.md +++ b/site/docs/skylark/macros.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Macros +category: extending --- # Macros
diff --git a/site/docs/skylark/performance.md b/site/docs/skylark/performance.md index 88c8ceb..4a4bcce 100644 --- a/site/docs/skylark/performance.md +++ b/site/docs/skylark/performance.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Optimizing performance +category: extending --- # Optimizing Performance
diff --git a/site/docs/skylark/repository_rules.md b/site/docs/skylark/repository_rules.md index 513565c..7b5f8f9 100644 --- a/site/docs/skylark/repository_rules.md +++ b/site/docs/skylark/repository_rules.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Repository rules +category: extending --- # Repository Rules
diff --git a/site/docs/skylark/rules-tutorial.md b/site/docs/skylark/rules-tutorial.md index 4eafad3..8e60316 100644 --- a/site/docs/skylark/rules-tutorial.md +++ b/site/docs/skylark/rules-tutorial.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Rules Tutorial +category: extending --- # Rules Tutorial
diff --git a/site/docs/skylark/rules.md b/site/docs/skylark/rules.md index e9fd2c2..050d6bc 100644 --- a/site/docs/skylark/rules.md +++ b/site/docs/skylark/rules.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Rules +category: extending --- # Rules
diff --git a/site/docs/skylark/testing.md b/site/docs/skylark/testing.md index e503491..abe3050 100644 --- a/site/docs/skylark/testing.md +++ b/site/docs/skylark/testing.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Testing +category: extending --- # Testing
diff --git a/site/docs/skylark/tutorial-creating-a-macro.md b/site/docs/skylark/tutorial-creating-a-macro.md index ffc6ee9..e3ff353 100644 --- a/site/docs/skylark/tutorial-creating-a-macro.md +++ b/site/docs/skylark/tutorial-creating-a-macro.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Creating a macro +category: extending --- # Creating a Macro
diff --git a/site/docs/skylark/tutorial-custom-verbs.md b/site/docs/skylark/tutorial-custom-verbs.md index 6bbcaae..e1cfd10 100644 --- a/site/docs/skylark/tutorial-custom-verbs.md +++ b/site/docs/skylark/tutorial-custom-verbs.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Using macros to create "custom verbs" +category: extending --- # Using Macros to Create "Custom Verbs"
diff --git a/site/docs/skylark/tutorial-sharing-variables.md b/site/docs/skylark/tutorial-sharing-variables.md index 5974c42..ab58da9 100644 --- a/site/docs/skylark/tutorial-sharing-variables.md +++ b/site/docs/skylark/tutorial-sharing-variables.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Sharing variables +category: extending --- # Sharing Variables
diff --git a/site/docs/skylark/windows_tips.md b/site/docs/skylark/windows_tips.md index ec2cd3e9..b8b2601 100644 --- a/site/docs/skylark/windows_tips.md +++ b/site/docs/skylark/windows_tips.md
@@ -1,6 +1,7 @@ --- layout: documentation title: Writing rules on Windows +category: extending --- # Writing Rules on Windows