diff options
author | dzc <dzc@google.com> | 2017-06-26 11:01:47 +0200 |
---|---|---|
committer | Marcel Hlopko <hlopko@google.com> | 2017-06-26 18:41:14 +0200 |
commit | 205125bfceffd1920a80799e4097d6433687ca71 (patch) | |
tree | 94a255309a1feaed4b5495cc187036d3547b3be1 /site/docs/tutorial/workspace.md | |
parent | 01776ee8495043816e6224ebeff2756d34db41cb (diff) |
Use relative paths in links in docs.
This change fixes links among Bazel docs to use relative paths links instead of
absolute path (either full URL or absolute from site root). This way, versioned
documentation will link to other pages within the same versioned directory
rather than to the site root, which will point to the latest version of the
page from HEAD.
Future improvements may include adding a lint tool to check links in
documentation to ensure that the correct convention is followed such that all
links to pages within a version of the docs will point to pages within the same
version.
RELNOTES: None
PiperOrigin-RevId: 160117865
Diffstat (limited to 'site/docs/tutorial/workspace.md')
-rw-r--r-- | site/docs/tutorial/workspace.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/site/docs/tutorial/workspace.md b/site/docs/tutorial/workspace.md index eee1b1a350..59115c7e31 100644 --- a/site/docs/tutorial/workspace.md +++ b/site/docs/tutorial/workspace.md @@ -5,7 +5,7 @@ title: Tutorial - Set Up a Workspace # Tutorial - Set Up a Workspace -A [workspace](/docs/build-ref.html#workspaces) is a directory that contains the +A [workspace](../build-ref.html#workspaces) is a directory that contains the source files for one or more software projects, as well as a `WORKSPACE` file and `BUILD` files that contain the instructions that Bazel uses to build the software. The workspace may also contain symbolic links to output @@ -32,7 +32,7 @@ export WORKSPACE=$HOME/examples/tutorial Every workspace must have a text file named `WORKSPACE` located in the top-level workspace directory. This file may be empty or it may contain references -to [external dependencies](/docs/external.html) required to build the +to [external dependencies](../external.html) required to build the software. For now, you'll create an empty `WORKSPACE` file, which simply serves to |