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/best-practices.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/best-practices.md')
-rw-r--r-- | site/docs/best-practices.md | 10 |
1 files changed, 5 insertions, 5 deletions
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 |