diff options
author | Han-Wen Nienhuys <hanwen@google.com> | 2015-03-13 19:29:16 +0000 |
---|---|---|
committer | Han-Wen Nienhuys <hanwen@google.com> | 2015-03-16 17:34:14 +0000 |
commit | 0be7e44a9826ca2601a74d90bd32376e0bec8600 (patch) | |
tree | 98f2230309b5aeeb1c43457aa883d206df66bbfe | |
parent | d7bd77a82f33e911506994b7361812e885ae5398 (diff) |
Rename roadmap, fix some links.
--
MOS_MIGRATED_REVID=88569464
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | docs/FAQ.md | 9 | ||||
-rw-r--r-- | docs/contributing.md | 5 | ||||
-rw-r--r-- | docs/getting-started.md | 2 | ||||
-rw-r--r-- | docs/roadmap.md (renamed from docs/bazel-roadmap.md) | 0 |
5 files changed, 8 insertions, 10 deletions
@@ -15,7 +15,7 @@ knowledge of dependencies to parallelize builds. * How to [get started using Bazel](docs/getting-started.md) * How to [use the query command](docs/bazel-query-v2.html) * How to [extend Bazel](docs/skylark/index.md) - * TODO(bazel-team): link to the build encyclopedia. + * The rule reference documentation is in the [build encyclopedia](docs/build-encyclopedia.html). * TODO(bazel-team): link to the user-manual * TODO(bazel-team): link to the test encyclopedia? diff --git a/docs/FAQ.md b/docs/FAQ.md index a3d9cca831..fca9aa6024 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -245,8 +245,7 @@ should also hold for our open-source codebase. How can I start using Bazel? ---------------------------- -See our [getting started -doc](https://github.com/google/bazel/blob/master/docs/getting-started.md) +See our [getting started doc](getting-started.md) TODO(bazel-team): more doc links @@ -345,7 +344,7 @@ Our initial goal is to work on Google's internal use-cases. This includes Google's principal languages (C++, Java, Go) and major platforms (Linux, Android, iOS). For practical reasons, not all of these are currently open-sourced. For more details see our -[roadmap](bazel-roadmap.md). +[roadmap](roadmap.md). What about Python? @@ -370,7 +369,7 @@ Can I use Bazel for my LISP/Python/Haskell/Scala/Rust project? We have an extension mechanism that allows you to add new rules without recompiling Bazel. -For documentation: see [here](skylark-index.md). +For documentation: see [here](skylark/index.md). At present, the extension mechanism is experimental though. @@ -387,7 +386,7 @@ Can I contribute to the Bazel code base? ---------------------------------------- You can propose patches to Bazel. You can find all the details in the -[contribution guidelines](contribution.md). +[contribution guidelines](contributing.md). Why isn't all development done in the open? diff --git a/docs/contributing.md b/docs/contributing.md index 9af6bf42c6..2f2061dbc8 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -67,8 +67,8 @@ Bazel is organized in several parts: * The server code in Java (in `src/main/java` and `src/test/java`) * Core code which is mostly composed of [SkyFrame](skyframe.md) and some utilities. - * [Skylark](skylark_index.md) rules are defined in `tools/build_rules`. If you - want to add rules, consider using [Skylark](skylark_index.md) first. + * [Skylark](skylark/index.md) rules are defined in `tools/build_rules`. If you + want to add rules, consider using [Skylark](skylark/index.md) first. * Builtin rules in `com.google.devtools.build.lib.rules` and in `com.google.devtools.build.lib.bazel.rules`. * Java native interfaces in `src/main/native`. @@ -94,4 +94,3 @@ We do not currently accept pull requests on GitHub. We will make changes to this process as necessary, and we're hoping to move closer to a fully open development model in the future (also see [Is Bazel developed fully in the open?](governance.md#isbazelopen)). - diff --git a/docs/getting-started.md b/docs/getting-started.md index a7420e6943..ba5523ed08 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -8,7 +8,7 @@ Every Bazel project is contained in a directory called a _build root_, which holds the inputs, outputs, and build rules for the project. To create a Bazel project, first clone the [Github repo](https://github.com/google/bazel) and build Bazel (follow the instructions in the -[README](https://github.com/google/bazel/README.md) to install prerequisites): +[README](install.md) to install prerequisites): ```bash $ git clone https://github.com/google/bazel.git diff --git a/docs/bazel-roadmap.md b/docs/roadmap.md index 1ecc6d36ea..1ecc6d36ea 100644 --- a/docs/bazel-roadmap.md +++ b/docs/roadmap.md |