From 0be7e44a9826ca2601a74d90bd32376e0bec8600 Mon Sep 17 00:00:00 2001 From: Han-Wen Nienhuys Date: Fri, 13 Mar 2015 19:29:16 +0000 Subject: Rename roadmap, fix some links. -- MOS_MIGRATED_REVID=88569464 --- README.md | 2 +- docs/FAQ.md | 9 ++--- docs/bazel-roadmap.md | 98 ------------------------------------------------- docs/contributing.md | 5 +-- docs/getting-started.md | 2 +- docs/roadmap.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 106 insertions(+), 108 deletions(-) delete mode 100644 docs/bazel-roadmap.md create mode 100644 docs/roadmap.md diff --git a/README.md b/README.md index 808f3e9c14..7cda78aacf 100644 --- a/README.md +++ b/README.md @@ -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/bazel-roadmap.md b/docs/bazel-roadmap.md deleted file mode 100644 index 1ecc6d36ea..0000000000 --- a/docs/bazel-roadmap.md +++ /dev/null @@ -1,98 +0,0 @@ -# Bazel Feature Roadmap - -Author: [The Bazel Team](https://groups.google.com/forum/#!forum/bazel-discuss) - -This document describes the Bazel team's plans for introducing future -system features. The document is divided into two main sections: - -* *Near-term plans:* Features that the team is committed to supporting - for alpha and beta releases. -* *Tentative post-beta plans:* Features that the team is considering - supporting within one year of the beta release. The availability and - sequencing of features on this list will depend technical feasibility - and user demand. - -Note that this roadmap only includes features that the Bazel team itself -intends to support. We anticipate that a number of other features will be -added by code contributors. - -For the alpha and beta releases, the Bazel team will maintain two code -repositories: - -* A Google-internal repository, containing both Bazel code and - Google-specific extensions and features -* An external [GitHub repository](https://github.com/google/bazel), - containing only the Bazel code. - -We anticipate making the external repository *primary* in the future, that is, -code from Google and non-Google contributors will committed and tested in the -external repository first, then imported into the internal repository. For -the alpha and beta releases, however, the internal repository will be primary. -Changes to Bazel code will be frequently pushed from the internal to -the external repository. - -## Near-term Plans - -### Alpha release (2015-03) - -This release is intended to - -* give users access to a basic set of supported features -* allow potential code contributors to understand Bazel's capabilities and - architecture -* enable users to monitor the team's progress toward a beta release - -Alpha users will need to build Bazel from source; we will not provide binary -releases until the beta. We will accept code contributions, but may need to -reject or defer code contributions related to beta features still under -development. Some features will be fully supported -henceforward, others are still experimental or partially supported; see -bazel/docs/governance.md for details. - - -The following features/capabilities will be available in the alpha: - -* Bazel runs on Linux and OS X -* Bazel builds itself on Linux and OS X -* Build rules target executables running on Linux and OS X -* Support for building and testing C++ -* Support for building and testing Java -* Support for building Objective C -* Support for building Python -* Support for building iOS apps -* Documentation for supported build rules and features -* Online support for bug and feature requests -* A basic Bazel test suite in GitHub -* Support for referencing Java JAR dependencies from HTTP and Maven endpoints -* Support for referencing remote source repositories via HTTP -* Support for extensibility via an interpreted Python subset (Skylark) - -### Beta release (target date: 2015-06) - -The beta release will add support for additional languages and platform and -various other fully supported features. In particular, the following -features/capabilities will be available: - -* Binary versions of Bazel for Linux and OS X -* All Bazel tests currently in Google's repository are ported to GitHub -* The Bazel test suite runs on externally-visible continuous integration - infrastructure -* Support for referencing transitive sources via Maven -* Support for prefetching and caching remote dependencies -* Support for building and testing Android apps -* Support for testing iOS apps -* Support for build action sandboxing - -## Tentative post-beta plans - -* Binary releases of Bazel at least monthly -* The external repository is primary -* An auto-update mechanism to allow Bazel to dynamically check for, fetch, - and install updated releases, rules, etc. -* AppEngine support -* Support for remote mobile testing -* Support for the Go language -* Support for Javascript -* Android Studio interoperability - - 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/roadmap.md b/docs/roadmap.md new file mode 100644 index 0000000000..1ecc6d36ea --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,98 @@ +# Bazel Feature Roadmap + +Author: [The Bazel Team](https://groups.google.com/forum/#!forum/bazel-discuss) + +This document describes the Bazel team's plans for introducing future +system features. The document is divided into two main sections: + +* *Near-term plans:* Features that the team is committed to supporting + for alpha and beta releases. +* *Tentative post-beta plans:* Features that the team is considering + supporting within one year of the beta release. The availability and + sequencing of features on this list will depend technical feasibility + and user demand. + +Note that this roadmap only includes features that the Bazel team itself +intends to support. We anticipate that a number of other features will be +added by code contributors. + +For the alpha and beta releases, the Bazel team will maintain two code +repositories: + +* A Google-internal repository, containing both Bazel code and + Google-specific extensions and features +* An external [GitHub repository](https://github.com/google/bazel), + containing only the Bazel code. + +We anticipate making the external repository *primary* in the future, that is, +code from Google and non-Google contributors will committed and tested in the +external repository first, then imported into the internal repository. For +the alpha and beta releases, however, the internal repository will be primary. +Changes to Bazel code will be frequently pushed from the internal to +the external repository. + +## Near-term Plans + +### Alpha release (2015-03) + +This release is intended to + +* give users access to a basic set of supported features +* allow potential code contributors to understand Bazel's capabilities and + architecture +* enable users to monitor the team's progress toward a beta release + +Alpha users will need to build Bazel from source; we will not provide binary +releases until the beta. We will accept code contributions, but may need to +reject or defer code contributions related to beta features still under +development. Some features will be fully supported +henceforward, others are still experimental or partially supported; see +bazel/docs/governance.md for details. + + +The following features/capabilities will be available in the alpha: + +* Bazel runs on Linux and OS X +* Bazel builds itself on Linux and OS X +* Build rules target executables running on Linux and OS X +* Support for building and testing C++ +* Support for building and testing Java +* Support for building Objective C +* Support for building Python +* Support for building iOS apps +* Documentation for supported build rules and features +* Online support for bug and feature requests +* A basic Bazel test suite in GitHub +* Support for referencing Java JAR dependencies from HTTP and Maven endpoints +* Support for referencing remote source repositories via HTTP +* Support for extensibility via an interpreted Python subset (Skylark) + +### Beta release (target date: 2015-06) + +The beta release will add support for additional languages and platform and +various other fully supported features. In particular, the following +features/capabilities will be available: + +* Binary versions of Bazel for Linux and OS X +* All Bazel tests currently in Google's repository are ported to GitHub +* The Bazel test suite runs on externally-visible continuous integration + infrastructure +* Support for referencing transitive sources via Maven +* Support for prefetching and caching remote dependencies +* Support for building and testing Android apps +* Support for testing iOS apps +* Support for build action sandboxing + +## Tentative post-beta plans + +* Binary releases of Bazel at least monthly +* The external repository is primary +* An auto-update mechanism to allow Bazel to dynamically check for, fetch, + and install updated releases, rules, etc. +* AppEngine support +* Support for remote mobile testing +* Support for the Go language +* Support for Javascript +* Android Studio interoperability + + -- cgit v1.2.3