-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Setup docs deployments with mdBook (#11369)
This PR sets up deployments for the docs using mdBook. Right now the new docs are hosted at [zed.dev/docs2](https://zed.dev/docs2/). The docs are deployed to Cloudflare Pages on merges to `main`, and we have a Cloudflare Worker that routes traffic from `zed.dev/docs2` to the docs deployment. We can iterate on the docs for a bit, and then promote them to `zed.dev/docs` when we're all ready for the switchover. Release Notes: - N/A --------- Co-authored-by: Conrad Irwin <conrad.irwin@gmail.com>
- Loading branch information
1 parent
6563330
commit dccf6da
Showing
5 changed files
with
42 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
name: Deploy Docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
deploy-docs: | ||
name: Deploy Docs | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v4 | ||
with: | ||
clean: false | ||
|
||
- name: Setup mdBook | ||
uses: peaceiris/actions-mdbook@v2 | ||
with: | ||
mdbook-version: "0.4.37" | ||
|
||
- name: Build book | ||
run: | | ||
set -euo pipefail | ||
mkdir -p target/deploy | ||
mdbook build ./docs --dest-dir=../target/deploy/docs2/ | ||
- name: Deploy | ||
uses: cloudflare/wrangler-action@v3 | ||
with: | ||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} | ||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | ||
command: pages deploy target/deploy --project-name=docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1 @@ | ||
book | ||
.vercel | ||
book/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
[book] | ||
authors = ["Nate Butler"] | ||
authors = ["The Zed Team"] | ||
language = "en" | ||
multilingual = false | ||
src = "src" | ||
title = "Zed App Docs" | ||
title = "Zed" | ||
site-url = "/docs2/" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Tasks | ||
|
||
Tasks allow you to run certain actions from within Zed. |