Skip to content

Commit 7386895

Browse files
authored
Replace Gatsby with Docusaurus. (#211)
* Replace Gatsby with Docusaurus. Gatsby is great, but brings a high level of complexity, and in this commit, it is replaced with Docusaurus which is simpler and also streamlined to produced versioned documentation. Things like a collapsable sidebar, right hand side page navigation, bread-crumbs, warning about using old site documentation, just works out of the box. Themes (light and dark) has also been added along with a search-bar which is backed by Google's programmable search engine. Lots of unused images were removed. Signed-off-by: Thomas Hallgren <thomas@tada.se>
1 parent 8ac60d8 commit 7386895

File tree

567 files changed

+7662
-27086
lines changed

Some content is hidden

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

567 files changed

+7662
-27086
lines changed

.github/workflows/blc.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ jobs:
1313
with:
1414
repository: datawire/getambassador.io-blc2
1515
path: blc
16-
- run: yarn install
16+
- run: yarn
1717
working-directory: site
18-
- run: yarn run gatsby build
18+
- run: yarn build
1919
working-directory: site
2020
- run: npm install
2121
working-directory: blc
@@ -24,7 +24,7 @@ jobs:
2424
set -o pipefail
2525
(TARGET=../site PRODUCT=telepresenceio make -C . > blc.log) || ! (grep 'has a broken' blc.log)
2626
working-directory: blc
27-
- uses: actions/upload-artifact@v2
27+
- uses: actions/upload-artifact@v4
2828
with:
2929
name: blc.log
3030
path: blc/blc.log

.github/workflows/lint.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ jobs:
66
steps:
77
- uses: actions/setup-node@v4
88
- uses: actions/checkout@v4
9-
- run: yarn install
10-
- name: "yarn run gatsby build"
9+
- run: yarn
10+
- name: "yarn build"
1111
run: |
12-
# The sed part of this command removes terminal escape codes.
13-
NODE_ENV=development yarn run gatsby build
12+
yarn build
1413
- name: "Dirty check"
1514
run: |
1615
git add .

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
/.cache/
77
/public/
88

9+
# Docusaurus
10+
/.docusaurus/
11+
/build/
12+
913
# gatsby-plugin-extract-schema
1014
/schema.graphql
1115

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

bin/serve.js

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

docs-config.js

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

docs/dummy.md

Whitespace-only changes.

docs/latest

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)