Skip to content

Commit e306318

Browse files
siggisimsiggisim
committed
Switch to docusaurus for docs
1 parent a47b1c1 commit e306318

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+11176
-467
lines changed

‎.github/workflows/docs.yaml‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
name: Update Docs
1+
name: Deploy
22

33
on:
44
push:
55
branches:
66
- master
77
paths:
88
- 'docs/**'
9+
- 'website/**'
910

1011
jobs:
1112
build:
1213
runs-on: ubuntu-latest
1314
if: "!contains(github.event.head_commit.message, 'docs skip')"
1415

1516
steps:
16-
- name: Checkout
17-
uses: actions/checkout@v1
17+
- name: Checkout
18+
uses: actions/checkout@v1
1819

19-
- name: Update
20-
run: |
21-
./docs/update.sh ${{ secrets.WEBFLOW_API_TOKEN }} ${{ secrets.WEBFLOW_DOCS_COLLECTION_ID }} ${{ secrets.BUILDBUDDY_GITHUB_USER_NAME }} ${{ secrets.BUILDBUDDY_GITHUB_USER_TOKEN }}
20+
- name: Build
21+
run: |
22+
cd website
23+
yarn install && yarn build
24+
25+
- name: Deploy 🚀
26+
uses: JamesIves/github-pages-deploy-action@4.1.0
27+
with:
28+
branch: gh-pages
29+
folder: website/build

‎docs/cloud.md‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "Cloud Quickstart",
4-
"category": "5f84be4816a467536a4ca064",
5-
"priority": 800
6-
}
7-
-->
8-
9-
# Cloud Quickstart
1+
---
2+
id: cloud
3+
title: Cloud Quickstart
4+
sidebar_label: Cloud Quickstart
5+
---
106

117
[Cloud BuildBuddy](https://app.buildbuddy.io/) is a fully managed SaaS solution for Enterprise Bazel features. It provides a results store & UI, remote build caching, remote build execution, and more.
128

@@ -16,7 +12,7 @@ It's easy to get set up and is free for individuals and open source projects. Fo
1612

1713
To use BuildBuddy's Results UI, you just need to configure Bazel to send build events to our cloud BuildBuddy instance. The easiest way to do this is with a `.bazelrc` file in the root of your project.
1814

19-
```
15+
```bash
2016
build --bes_results_url=https://app.buildbuddy.io/invocation/
2117
build --bes_backend=grpcs://cloud.buildbuddy.io
2218
```
@@ -27,7 +23,7 @@ That's it, 2 lines and you're up and running. For more advanced configurations,
2723

2824
Now, when you build or test with Bazel, it will print a url where you can view your build or test results. For example:
2925

30-
```
26+
```bash
3127
tylerw@lunchbox:~/buildbuddy-io/buildbuddy$ bazel build server:all
3228
INFO: Streaming build results to: https://app.buildbuddy.io/invocation/24a37b8f-4cf2-4909-9522-3cc91d2ebfc4
3329
INFO: Analyzed 13 targets (0 packages loaded, 0 targets configured).

‎docs/config-api.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "API",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 200
6-
}
7-
-->
8-
9-
# API Configuration
1+
---
2+
id: config-api
3+
title: API Configuration
4+
sidebar_label: API
5+
---
106

117
The API is only configurable in the [Enterprise version](enterprise.md) of BuildBuddy.
128

‎docs/config-app.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "App",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 800
6-
}
7-
-->
8-
9-
# App Configuration
1+
---
2+
id: config-app
3+
title: App Configuration
4+
sidebar_label: App
5+
---
106

117
## Section
128

‎docs/config-auth.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "Auth",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 300
6-
}
7-
-->
8-
9-
# Auth Configuration
1+
---
2+
id: config-auth
3+
title: Auth Configuration
4+
sidebar_label: Auth
5+
---
106

117
Auth is only configurable in the [Enterprise version](enterprise.md) of BuildBuddy.
128

‎docs/config-cache.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "Cache",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 500
6-
}
7-
-->
8-
9-
# Cache Configuration
1+
---
2+
id: config-cache
3+
title: Cache Configuration
4+
sidebar_label: Cache
5+
---
106

117
## Section
128

‎docs/config-database.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "Database",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 700
6-
}
7-
-->
8-
9-
# Database Configuration
1+
---
2+
id: config-database
3+
title: Database Configuration
4+
sidebar_label: Database
5+
---
106

117
## Section
128

‎docs/config-flags.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "Flags",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 100
6-
}
7-
-->
8-
9-
# BuildBuddy Flags
1+
---
2+
id: config-flags
3+
title: BuildBuddy Flags
4+
sidebar_label: Flags
5+
---
106

117
There are several configuration options that are not in the BuildBuddy configuration file. These are:
128

‎docs/config-github.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "GitHub",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 500
6-
}
7-
-->
8-
9-
# GitHub Configuration
1+
---
2+
id: config-github
3+
title: GitHub Configuration
4+
sidebar_label: GitHub
5+
---
106

117
In order to configure BuildBuddy's GitHub integration, you'll either need to:
128

‎docs/config-integrations.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
<!--
2-
{
3-
"name": "Integrations",
4-
"category": "5f84be4816a46711e64ca065",
5-
"priority": 300
6-
}
7-
-->
8-
9-
# Integration Configuration
1+
---
2+
id: config-integrations
3+
title: Integration Configuration
4+
sidebar_label: Integrations
5+
---
106

117
## Section
128

0 commit comments

Comments
 (0)