mirror of
https://github.com/zed-industries/zed.git
synced 2025-01-24 02:46:43 +00:00
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>
This commit is contained in:
parent
6563330239
commit
dccf6dae01
5 changed files with 42 additions and 14 deletions
35
.github/workflows/deploy_docs.yml
vendored
Normal file
35
.github/workflows/deploy_docs.yml
vendored
Normal file
|
@ -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
|
3
docs/.gitignore
vendored
3
docs/.gitignore
vendored
|
@ -1,2 +1 @@
|
||||||
book
|
book/
|
||||||
.vercel
|
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
[book]
|
[book]
|
||||||
authors = ["Nate Butler"]
|
authors = ["The Zed Team"]
|
||||||
language = "en"
|
language = "en"
|
||||||
multilingual = false
|
multilingual = false
|
||||||
src = "src"
|
src = "src"
|
||||||
title = "Zed App Docs"
|
title = "Zed"
|
||||||
|
site-url = "/docs2/"
|
||||||
|
|
|
@ -1,10 +0,0 @@
|
||||||
These docs are intendended to replace both docs.zed.dev and introduce people to how to build Zed from source.
|
|
||||||
|
|
||||||
1. `cd docs` from repo root
|
|
||||||
1. Install the vercel cli if you haven't already
|
|
||||||
- `pnpm i -g vercel`
|
|
||||||
1. `vercel` to deploy if you already have the project linked
|
|
||||||
1. Otherwise, `vercel login` and `vercel` to link
|
|
||||||
- Choose Zed Industries as the team, then `zed-app-docs` as the project
|
|
||||||
|
|
||||||
Someone can write a script for this when they have time.
|
|
3
docs/src/tasks.md
Normal file
3
docs/src/tasks.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Tasks
|
||||||
|
|
||||||
|
Tasks allow you to run certain actions from within Zed.
|
Loading…
Reference in a new issue