diff options
| -rwxr-xr-x | scripts/bootstrap/compile.sh | 2 | ||||
| -rw-r--r-- | site/_config.yml | 6 | ||||
| -rw-r--r-- | site/_includes/header.html | 10 | ||||
| -rw-r--r-- | site/_layouts/documentation.html | 101 | ||||
| -rw-r--r-- | site/docs/best-practices.md | 10 | ||||
| -rw-r--r-- | site/docs/external.md | 18 | ||||
| -rw-r--r-- | site/docs/skylark/repository_rules.md | 4 | ||||
| -rwxr-xr-x | site/jekyll-tree.sh | 16 |
8 files changed, 85 insertions, 82 deletions
diff --git a/scripts/bootstrap/compile.sh b/scripts/bootstrap/compile.sh index 06f27efb7e..74b6e85986 100755 --- a/scripts/bootstrap/compile.sh +++ b/scripts/bootstrap/compile.sh @@ -164,7 +164,7 @@ the protoc compiler (as we prefer not to version generated files). compile.sh on the unpacked archive. The full install instructions to install a release version of bazel can be found -at https://bazel.build/versions/master/docs/install-compile-source.html +at https://docs.bazel.build/install-compile-source.html For a rationale, why the bootstrap process is organized in this way, see https://bazel.build/designs/2016/10/11/distribution-artifact.html -------------------------------------------------------------------------------- diff --git a/site/_config.yml b/site/_config.yml index 9d549e3cc7..44668c51ef 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -4,5 +4,9 @@ paginate: 10 highlighter: pygments sass: sass_dir: _sass -default_version: "master" gems: [jekyll-paginate] + +version: "master" + +main_site_url: https://www.bazel.build +blog_site_url: https://blog.bazel.build diff --git a/site/_includes/header.html b/site/_includes/header.html index d3b473a609..55cd13d087 100644 --- a/site/_includes/header.html +++ b/site/_includes/header.html @@ -8,7 +8,7 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="/"> + <a class="navbar-brand" href="{{ site.main_site_url }}"> <img src="/images/bazel-navbar.png" height="30px"> </a> </div> @@ -28,15 +28,15 @@ </form> <ul class="nav navbar-nav navbar-right"> <li{% if page.nav == "docs" %} class="active"{% endif %}> - <a href="/versions/master/docs/bazel-overview.html">Docs</a> + <a href="/">Docs</a> </li> <li{% if page.nav == "contribute" %} class="active"{% endif %}> - <a href="/contributing.html">Contribute!</a> + <a href="{{ site.main_site_url }}/contributing.html">Contribute!</a> </li> <li{% if page.nav == "faq" %} class="active"{% endif %}> - <a href="/faq.html">FAQ</a></li> + <a href="{{ site.main_site_url }}/faq.html">FAQ</a></li> <li{% if page.nav == "blog" %} class="active"{% endif %}> - <a href="/blog">Blog</a> + <a href="{{ site.blog_site_url }}">Blog</a> </li> <li><a href="http://stackoverflow.com/questions/tagged/bazel" class="nav-icon"><i class="fa fa-stack-overflow"></i></a></li> <li><a href="https://groups.google.com/forum/#!forum/bazel-discuss" class="nav-icon"><i class="fa fa-envelope"></i></a></li> 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; diff --git a/site/docs/best-practices.md b/site/docs/best-practices.md index ca360954b9..e98dfa7fc5 100644 --- a/site/docs/best-practices.md +++ b/site/docs/best-practices.md @@ -73,7 +73,7 @@ inspecting the BUILD file to understand what a target's restrictions are. Prefer declaring third party dependencies as remote repositories in the WORKSPACE file. If it's necessary to check third party dependencies into your repository, put them in a directory called `third_party/` under your workspace directory. Note that all BUILD files in `third_party/` must -include [license](https://bazel.build/versions/master/docs/be/functions.html#licenses) +include [license](https://docs.bazel.build/be/functions.html#licenses) declarations. ## Depending on binaries @@ -116,7 +116,7 @@ dependencies will have to be updated. ## BUILD file style guide See the [BUILD file style -guide](https://bazel.build/versions/master/docs/skylark/build-style.html). +guide](https://docs.bazel.build/skylark/build-style.html). ## Formatting @@ -194,18 +194,18 @@ less obvious than an empty list. ## Skylark style guide See the [Style guide for .bzl -files](https://bazel.build/versions/master/docs/skylark/bzl-style.html) for Skylark rule guidelines. +files](https://docs.bazel.build/skylark/bzl-style.html) for Skylark rule guidelines. ## Packaging rules -See [Packaging rules](https://bazel.build/versions/master/docs/skylark/deploying.html) for advice +See [Packaging rules](https://docs.bazel.build/skylark/deploying.html) for advice on how to structure and where to put new Skylark rules. ## Rule choice When using a language for which Bazel has built-in rules (e.g., C++), prefer using these rules to writing your own in Skylark. These rules are documented in the [build -encyclopedia](https://bazel.build/versions/master/docs/be/overview.html). +encyclopedia](https://docs.bazel.build/be/overview.html). # WORKSPACE files diff --git a/site/docs/external.md b/site/docs/external.md index dae89f88bc..ed4b285ff6 100644 --- a/site/docs/external.md +++ b/site/docs/external.md @@ -34,9 +34,9 @@ A few basic types of external dependencies can be used: If you want to use targets from a second Bazel project, you can use -[`local_repository`](http://bazel.build/docs/be/workspace.html#local_repository), -[`git_repository`](https://bazel.build/docs/be/workspace.html#git_repository) -or [`http_archive`](http://bazel.build/docs/be/workspace.html#http_archive) +[`local_repository`](http://docs.bazel.build/be/workspace.html#local_repository), +[`git_repository`](https://docs.bazel.build/be/workspace.html#git_repository) +or [`http_archive`](http://docs.bazel.build/be/workspace.html#http_archive) to symlink it from the local filesystem, reference a git repository or download it (respectively). @@ -60,9 +60,9 @@ If your coworker has a target `//foo:bar`, your project can refer to it as ### Depending on non-Bazel projects Rules prefixed with `new_` (e.g., -[`new_local_repository`](http://bazel.build/docs/be/workspace.html#new_local_repository), -[`new_git_repository`](https://bazel.build/docs/be/workspace.html#new_git_repository) -and [`new_http_archive`](http://bazel.build/docs/be/workspace.html#new_http_archive) +[`new_local_repository`](http://docs.bazel.build/be/workspace.html#new_local_repository), +[`new_git_repository`](https://docs.bazel.build/be/workspace.html#new_git_repository) +and [`new_http_archive`](http://docs.bazel.build/be/workspace.html#new_http_archive) ) allow you to create targets from projects that do not use Bazel. For example, suppose you are working on a project, `my-project/`, and you want @@ -97,8 +97,8 @@ files. #### Maven repositories -Use the rule [`maven_jar`](https://bazel.build/versions/master/docs/be/workspace.html#maven_jar) -(and optionally the rule [`maven_server`](https://bazel.build/versions/master/docs/be/workspace.html#maven_server)) +Use the rule [`maven_jar`](https://docs.bazel.build/be/workspace.html#maven_jar) +(and optionally the rule [`maven_server`](https://docs.bazel.build/be/workspace.html#maven_server)) to download a jar from a Maven repository and make it available as a Java dependency. @@ -106,7 +106,7 @@ dependency. By default, external dependencies are fetched as needed during `bazel build`. If you would like to disable this behavior or prefetch dependencies, use -[`bazel fetch`](http://bazel.build/docs/bazel-user-manual.html#fetch). +[`bazel fetch`](http://docs.bazel.build/bazel-user-manual.html#fetch). ## Using Proxies diff --git a/site/docs/skylark/repository_rules.md b/site/docs/skylark/repository_rules.md index c6890062ef..db839d54be 100644 --- a/site/docs/skylark/repository_rules.md +++ b/site/docs/skylark/repository_rules.md @@ -88,10 +88,10 @@ dependencies might cause a restart: - Declaration of the repository rule in the `WORKSPACE` file. - Value of any environment variable declared with the `environ` attribute of the -[`repository_rule`](https://bazel.build/versions/master/docs/skylark/lib/globals.html#repository_rule) +[`repository_rule`](https://docs.bazel.build/skylark/lib/globals.html#repository_rule) function. The value of those environment variable can be enforced from the command line with the -[`--action_env`](/docs/command-line-reference.html#flag--action_env) +[`--action_env`](https://docs.bazel.build/command-line-reference.html#flag--action_env) flag (but this flag will invalidate every action of the build). - Content of any file used and referred to by a label (e.g., `//mypkg:label.txt` not `mypkg/label.txt`). diff --git a/site/jekyll-tree.sh b/site/jekyll-tree.sh index c2c8e985c6..99e93d507e 100755 --- a/site/jekyll-tree.sh +++ b/site/jekyll-tree.sh @@ -40,14 +40,14 @@ function setup { # Unpack the Build Encyclopedia into docs/be function unpack_build_encyclopedia { - local be_dir="$OUT_DIR/versions/master/docs/be" + local be_dir="$OUT_DIR/docs/be" mkdir -p "$be_dir" unzip -qq "$BE_ZIP" -d "$be_dir" mv "$be_dir/be-nav.html" "$OUT_DIR/_includes" # Create redirects to each page in the Build Encyclopedia. mkdir -p "$OUT_DIR/docs/be" - for f in $(find "$OUT_DIR/versions/master/docs/be" -name "*.html"); do + for f in $(find "$OUT_DIR/docs/be" -name "*.html"); do local filename=$(basename "$f") cat > "$OUT_DIR/docs/be/${filename}" <<EOF --- @@ -60,14 +60,14 @@ EOF # Unpack the Skylark Library into docs/skylark/lib function unpack_skylark_library { - local sl_dir="$OUT_DIR/versions/master/docs/skylark/lib" + local sl_dir="$OUT_DIR/docs/skylark/lib" mkdir -p "$sl_dir" unzip -qq "$SL_ZIP" -d "$sl_dir" mv "$sl_dir/skylark-nav.html" "$OUT_DIR/_includes" # Create redirects to each page in the Skylark Library mkdir -p "$OUT_DIR/docs/skylark/lib" - for f in $(find "$OUT_DIR/versions/master/docs/skylark/lib" -name "*.html"); do + for f in $(find "$OUT_DIR/docs/skylark/lib" -name "*.html"); do local filename=$(basename "$f") cat > "$OUT_DIR/docs/skylark/lib/${filename}" <<EOF --- @@ -81,7 +81,7 @@ EOF function copy_skylark_rule_doc { local rule_family=$1 local rule_family_name=$2 - local be_dir="$OUT_DIR/versions/master/docs/be" + local be_dir="$OUT_DIR/docs/be" ( cat <<EOF --- @@ -111,10 +111,10 @@ function process_doc { } function process_docs { - for f in $(find "$OUT_DIR/versions/master/docs" -name "*.html"); do + for f in $(find "$OUT_DIR/docs" -name "*.html"); do process_doc $f done - for f in $(find "$OUT_DIR/versions/master/docs" -name "*.md"); do + for f in $(find "$OUT_DIR/docs" -name "*.md"); do process_doc $f done for f in $(find "$OUT_DIR/designs" -name "*.md"); do @@ -132,7 +132,7 @@ function main { unpack_build_encyclopedia unpack_skylark_library unpack_skylark_rule_docs - cp ${CLR_HTML} ${OUT_DIR}/versions/master/docs + cp ${CLR_HTML} ${OUT_DIR}/docs process_docs package_output } |