Skip to content

Commit e2d577f

Browse files
committed
Revamp BuildBuddy docs
1 parent 16495cc commit e2d577f

23 files changed

+871
-367
lines changed

.github/workflows/docs.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Update Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- 'docs/**.md'
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v1
17+
18+
- name: Update
19+
run: |
20+
./docs/update_docs.sh ${{ secrets.WEBFLOW_API_TOKEN }} ${{ secrets.WEBFLOW_DOCS_COLLECTION_ID }} ${{ secrets.BUILDBUDDY_GITHUB_USER_NAME }} ${{ secrets.BUILDBUDDY_GITHUB_USER_TOKEN }}

CONFIG.md

Lines changed: 0 additions & 281 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,37 @@
11
<p align="center">
22
<img width="40%" src="https://buildbuddy.io/images/header.png?version=1"><br/>
3-
<a href="https://buildbuddy.io">BuildBuddy</a> is an open source Bazel build event viewer<br/><br/>
3+
<a href="https://buildbuddy.io">BuildBuddy</a> is an open source Bazel build event viewer, result store, and remote cache.<br/><br/>
44
<img src="https://img.shields.io/badge/License-MIT-green.svg" />
55
<img src="https://img.shields.io/github/workflow/status/buildbuddy-io/buildbuddy/CI" />
66
</p>
77

88
# Intro
9-
BuildBuddy is an open source Bazel build event viewer. It helps you collect, view, share and debug build events in a user-friendly web UI.
9+
BuildBuddy is an open source Bazel build event viewer, result store, and remote cache. It helps you collect, view, share and debug build events in a user-friendly web UI.
1010

1111
It's written in Golang and React and can be deployed as a Docker image. It's run both as a [cloud hosted service](https://buildbuddy.io) and can be deployed to your cloud provider or run on-prem. BuildBuddy's core is open sourced in this repo under the [MIT License](https://github.com/buildbuddy-io/buildbuddy/blob/master/LICENSE).
1212

1313
# Get started
1414

15-
Getting started with Buildbuddy is simple. Just add these **two lines** to your `.bazelrc` file.
15+
Getting started with BuildBuddy is simple. Just add these **two lines** to your `.bazelrc` file.
1616

1717
**.bazelrc**
1818
```
1919
build --bes_results_url=https://app.buildbuddy.io/invocation/
2020
build --bes_backend=grpcs://events.buildbuddy.io:1986
2121
```
2222

23-
This will print a **Buildbuddy url** containing your build results at the beginning and end of every Bazel invocation. You can command click / double click on these to open the results in a browser.
23+
This will print a **BuildBuddy url** containing your build results at the beginning and end of every Bazel invocation. You can command click / double click on these to open the results in a browser.
2424

2525
**Want more control?** Want to get your whole team set up? Get up and running fast with the cloud hosted [BuildBuddy.io](https://buildbuddy.io) service.
2626

27-
If you'd like to host your own instance **on-premise** or in the cloud, check out our [getting started](https://github.com/buildbuddy-io/buildbuddy/blob/master/SETUP.md) guide.
27+
If you'd like to host your own instance **on-prem** or in the cloud, check out our [documentation](https://github.com/buildbuddy-io/buildbuddy/blob/master/docs/introduction.md).
28+
29+
# Documentation
30+
31+
Our [documentation](https://github.com/buildbuddy-io/buildbuddy/blob/master/docs/introduction.md) gives you a full look at how to set up and configure BuildBuddy.
32+
33+
# Questions?
34+
If you have any questions, e-mail us at [hello@buildbuddy.io](mailto:hello@buildbuddy.io) or join the [BuildBuddy Slack channel](https://join.slack.com/t/buildbuddy/shared_invite/zt-e0cugoo1-GiHaFuzzOYBPQzl9rkUR_g). We’d love to chat!
2835

2936
# Features
3037

@@ -58,7 +65,4 @@ If you'd like to host your own instance **on-premise** or in the cloud, check ou
5865
![BES backend multiplexing](https://buildbuddy.io/preview/multiplex.png)
5966

6067
- **Slack webhook support** - BuildBuddy allows you to message a Slack channel when builds finish. It's a nice way of getting a quick notification when a long running build completes, or a CI build fails. See the [configuration docs](https://github.com/buildbuddy-io/buildbuddy/blob/master/CONFIG.md#integrations) for more information.
61-
![Slack webhook support](https://buildbuddy.io/preview/slack.png)
62-
63-
# Questions?
64-
If you have any questions, e-mail us at [hello@buildbuddy.io](mailto:hello@buildbuddy.io) or join the [BuildBuddy Slack channel](https://join.slack.com/t/buildbuddy/shared_invite/zt-e0cugoo1-GiHaFuzzOYBPQzl9rkUR_g). We’d love to chat!
68+
![Slack webhook support](https://buildbuddy.io/preview/slack.png)

0 commit comments

Comments
 (0)