diff options
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/docs/external.md | |
parent | 7dec00574aa91327693f6ba7e90bff5bc834253e (diff) |
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
Diffstat (limited to 'site/docs/external.md')
-rw-r--r-- | site/docs/external.md | 18 |
1 files changed, 9 insertions, 9 deletions
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 |