Skip to content

Commit 9b0b788

Browse files
authored
Merge branch 'master' into menu-tab-capture
2 parents 808cc05 + 4865272 commit 9b0b788

7 files changed

Lines changed: 138 additions & 296 deletions

File tree

.buildkite/pipeline.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,15 +102,6 @@ steps:
102102
# agents:
103103
# queue: workers
104104

105-
- name: deploy-versioned-docs
106-
command: './deploy-versioned-docs.sh'
107-
if: build.branch == "master" && build.message =~ /^Release v[0-9]+\.[0-9]+\.[0-9]+/
108-
plugins:
109-
'docker-compose#v3.0.3':
110-
run: baseui
111-
agents:
112-
queue: workers
113-
114105
- name: create-github-release
115106
command: './scripts/github-release.js'
116107
if: build.branch == "master" && build.message =~ /^Release v[0-9]+\.[0-9]+\.[0-9]+/

DEPLOYMENTS.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,10 @@
22

33
As of today, we maintain a few deploy targets for the doc site. This document should serve as a source of truth for them.
44

5-
## For versions before v8
6-
7-
Before the v8 major version, we didn't deploy a doc site for all the minor and patch versions. Because of that, we only maintain the doc site of the latest version of each major version, pre v8.
8-
9-
These documentation sites are hosted from Netlify, and they don't need to be updated, as we don't backport and fixes to these old versions.
10-
11-
## For versions v8 and after
12-
13-
Starting v8, we started to deploy a doc site for all version of the Base Web library published to npm. On the high level, it works like this:
14-
15-
1. We deploy the doc site to Vercel
16-
2. We create a DNS CNAME record for the versioned doc site on Cloudflare
17-
3. We create an alias in Vercel to the Cloudflare CNAME record
18-
19-
This flow is implemented in [this deploy script](https://github.com/uber/baseweb/blob/master/deploy-versioned-docs.sh). This script is only triggered, when a new version is published to npm.
20-
21-
## Latest
22-
235
Whenever a new commit lands on master, we deploy the doc site to https://baseweb.design. Because of this, there may be times when a new feature is already shown on the doc site, but it's not available in the latest npm package. Usually, we cut releases every day, so it shouldn't be a big issue.
246

257
The configuration for this [lives here](https://github.com/uber/baseweb/blob/master/now.json).
8+
9+
The domain and docs are hosted at Cloudflare. All deployments logs can be found [here](https://t.uber.com/baseweb-cloudflare-pages).
10+
11+
To setup a custom subdomain for older version of docs, you have to add the custom domain [here](https://t.uber.com/baseweb-cloudflare-page-domain) and update the DNS record to match the branch name [here](https://t.uber.com/baseweb-cloudflare-dns).

deploy-versioned-docs.sh

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

0 commit comments

Comments
 (0)