Skip to content

Commit 817e220

Browse files
Googlercopybara-github
Googler
authored andcommittedNov 21, 2020
Docs: Update headers in Bazel overview pages
PiperOrigin-RevId: 343606251
1 parent e9cfb39 commit 817e220

8 files changed

+29
-33
lines changed
 

‎site/docs/bazel-and-java.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Follow these guidelines when creating your BUILD files:
5757
* Tests should be in a matching directory under `src/test` and depend on this
5858
library.
5959

60-
## Java and new rules
60+
## Creating new rules for advanced Java builds
6161

6262
**Note**: Creating new rules is for advanced build and test scenarios.
6363
You do not need it when getting started with Bazel.

‎site/docs/bazel-and-javascript.md

-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ This page contains resources that help you use Bazel with JavaScript projects.
99
It links to build rules and other information specific to building JavaScript
1010
with Bazel.
1111

12-
## Working with Bazel
13-
1412
The following resources will help you work with Bazel on JavaScript projects:
1513

1614
* [Building JavaScript/TypeScript with Bazel](build-javascript.html)

‎site/docs/bazel-container.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: documentation
3-
title: Bazel Container
3+
title: Bazel container
44
---
55

6-
# Getting started with Bazel Docker Container
6+
# Getting Started with Bazel Docker Container
77

88
In this guide, we will explore the contents of the Bazel container, build the
99
[abseil-cpp](https://github.com/abseil/abseil-cpp) project using Bazel inside

‎site/docs/bazel-overview.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
layout: documentation
3-
title: Bazel overview
3+
title: Bazel Overview
44
---
55

6-
# Bazel overview
6+
# Bazel Overview
77

88
Bazel is an open-source build and test tool similar to Make, Maven, and Gradle.
99
It uses a human-readable, high-level build language. Bazel supports projects in
1010
multiple languages and builds outputs for multiple platforms. Bazel supports
1111
large codebases across multiple repositories, and large numbers of users.
1212

1313

14-
## Why should I use Bazel?
14+
## Benefits
1515

1616
Bazel offers the following advantages:
1717

@@ -41,7 +41,7 @@ Bazel offers the following advantages:
4141
framework.
4242

4343

44-
## How do I use Bazel?
44+
## Using Bazel
4545

4646
To build or test a project with Bazel, you typically do the following:
4747

@@ -75,7 +75,7 @@ In addition to building, you can also use Bazel to run
7575
to trace dependencies in your code.
7676

7777

78-
## How does Bazel work?
78+
## Bazel build process
7979

8080
When running a build or a test, Bazel does the following:
8181

@@ -96,7 +96,7 @@ correctness, you can set up Bazel to run builds and tests
9696
and maximizing [reproducibility](guide.html#correctness).
9797

9898

99-
### What is the action graph?
99+
### Action graph
100100

101101
The action graph represents the build artifacts, the relationships between them,
102102
and the build actions that Bazel will perform. Thanks to this graph, Bazel can
@@ -106,7 +106,7 @@ know what build work has previously been done. The graph also enables you to
106106
easily [trace dependencies](query-how-to.html) in your code.
107107

108108

109-
## How do I get started?
109+
## Getting started tutorials
110110

111111
To get started with Bazel, see [Getting Started](getting-started.html) or jump
112112
directly to the Bazel tutorials:

‎site/docs/bazel-vision.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: documentation
33
title: Bazel vision
44
---
55

6-
# Bazel vision
6+
# Bazel Vision
77

88
<p><font size='+1'>Any software developer can efficiently build, test, and package
99
any project, of any size or complexity, with tooling that's easy to adopt and
@@ -74,7 +74,7 @@ available that integrate with the workflows and conventions of that community.
7474
Bazel is committed to be extensible and open, and to support good rulesets for
7575
any language.
7676

77-
### So what is a good ruleset?
77+
### Requirements of a good ruleset
7878

7979
1. The rules need to support efficient **building and testing** for the
8080
language, including code coverage.

‎site/docs/best-practices.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: documentation
33
title: Best practices
44
---
55

6-
# Best practices for Bazel
6+
# Best Practices
77

88
This document assumes that you are familiar with Bazel and provides advice on structuring your
99
projects to take full advantage of Bazel's features.
@@ -32,9 +32,9 @@ should be tagged as specifically as possible (e.g., "`requires-osx`"). This tagg
3232
targets to be filtered at a more fine-grained level than the "manual" tag and allows someone
3333
inspecting the BUILD file to understand what a target's restrictions are.
3434

35-
## Third party dependencies
35+
## Third-party dependencies
3636

37-
You may declare third party dependencies:
37+
You may declare third-party dependencies:
3838

3939
* Either declare them as remote repositories in the WORKSPACE file.
4040
* Or put them in a directory called `third_party/` under your workspace directory.
@@ -58,7 +58,7 @@ dependency issues: if one library depends on `guava-19.0` and one depends on `gu
5858
could end up with a library that tries to depend on two different versions. If you created a
5959
misleading alias to point both targets to one guava library, then the BUILD files are misleading.
6060

61-
## `.bazelrc`
61+
## Using the `.bazelrc` file
6262

6363
For project-specific options, use the configuration file your
6464
`<workspace>/.bazelrc` (see [bazelrc format](guide.html#bazelrc)).

‎site/docs/build-event-protocol.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: documentation
3-
title: Build event protocol
3+
title: Build Event Protocol
44
---
55

6-
# Build event protocol
6+
# Build Event Protocol
77

88
The [Build Event
99
Protocol](https://github.com/bazelbuild/bazel/blob/master/src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto)
@@ -18,8 +18,6 @@ results, build progress, the build configuration and much more. The Build Event
1818
Protocol is intended to be consumed programmatically and makes parsing Bazel’s
1919
command line output a thing of the past.
2020

21-
## Overview
22-
2321
The Build Event Protocol represents information about a build as events. A
2422
build event is a protocol buffer message consisting of a build event identifier,
2523
a set of child event identifiers, and a payload.
@@ -44,7 +42,7 @@ encoded as a protocol buffer message specific to that event. Note, that the
4442
payload might not be the expected type, but could be an `Aborted` message e.g.
4543
if the build aborted prematurely.
4644

47-
### Build event graph
45+
### Build Event graph
4846

4947
All build events form a directed acyclic graph through their parent and child
5048
relationship. Every build event except for the initial build event has one or
@@ -53,7 +51,7 @@ necessarily be posted before it. When a build is complete (succeeded or failed)
5351
all announced events will have been posted. In case of a Bazel crash or a failed
5452
network transport, some announced build events may never be posted.
5553

56-
## The Build Event Protocol by example
54+
## Build Event Protocol example
5755

5856
The full specification of the Build Event Protocol can be found in its protocol
5957
buffer definition and describing it here is beyond the scope of this document.
@@ -147,9 +145,9 @@ built.
147145
}
148146
```
149147

150-
## Consuming the Build Event Protocol
148+
## Consuming Build Event Protocol
151149

152-
### Consume in a binary format
150+
### Consume in binary format
153151

154152
To consume the Build Event Protocol in a binary format:
155153

@@ -164,17 +162,17 @@ method.
164162
2. Then, write a program that extracts the relevant information from the
165163
serialized protocol buffer message.
166164

167-
### Consume in text formats
165+
### Consume in text or JSON formats
168166

169-
The following Bazel command line flags will output the Build Event Protocol in a
170-
human-readable formats:
167+
The following Bazel command line flags will output the Build Event Protocol in
168+
human-readable formats, such as text and JSON:
171169

172170
```
173171
--build_event_text_file
174172
--build_event_json_file
175173
```
176174

177-
## The Build Event Service
175+
## Build Event Service
178176

179177
The [Build Event
180178
Service](https://github.com/googleapis/googleapis/blob/master/google/devtools/build/v1/publish_build_event.proto)

‎site/docs/build-javascript.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Started"](getting-started.html) material before proceeding.
3131
To set up your environment for building JavaScript outputs with Bazel, do the
3232
following:
3333

34-
### Step 1: Installing Bazel
34+
### Installing Bazel
3535

3636
You can either [Install Bazel](install.html) following the same steps that you
3737
would for backend development, or you can install NodeJS with npm and run
3838
`npm install -g @bazel/bazel`.
3939

40-
### Step 2: Installing iBazel
40+
### Installing iBazel
4141

4242
iBazel, or iterative Bazel, is a "watchdog" version of Bazel that automatically
4343
runs whenever your source files change. Use it to auto-run your tests and
@@ -61,7 +61,7 @@ yarn global add @bazel/ibazel
6161

6262
To use `ibazel`, simply replace `bazel` with `ibazel` in your Bazel commands.
6363

64-
### Step 3: Configuring the `bazel.rc` file
64+
### Configuring the `bazel.rc` file
6565

6666
Any Bazel build flag or option that can be placed on the command line can also
6767
be set in the project's [`bazel.rc` file](guide.html#bazelrc)

0 commit comments

Comments
 (0)
Please sign in to comment.