Skip to content

Commit d84d1be

Browse files
committed
docs: list deployments in contribution guidelines
1 parent 70b1544 commit d84d1be

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,25 @@ function someMethod(): void {
270270

271271
We deploy our documentations and applications to [Vercel](https://vercel.com/docs). Vercel is a cloud platform for static sites and serverless functions. Applications are deployed using the SCION collaborator account ([email protected]) under the [SCION organization](https://vercel.com/scion).
272272

273-
We have the following workbench related projects:
273+
**Vercel Deployment Projects:**
274274
- https://vercel.com/scion/scion-workbench-client-api
275275
- https://vercel.com/scion/scion-workbench-testing-app
276276
- https://vercel.com/scion/scion-workbench-client-testing-app
277277
- https://vercel.com/scion/scion-workbench-getting-started-app
278278

279+
**Applications**
280+
- https://workbench-testing-app.scion.vercel.app (latest)
281+
- https://workbench-testing-app-vX-X-X.scion.vercel.app (versioned)
282+
<p>
283+
- https://workbench-client-testing-app1-vX-X-X.scion.vercel.app (versioned)
284+
- https://workbench-client-testing-app2-vX-X-X.scion.vercel.app (versioned)
285+
<p>
286+
- https://workbench-getting-started.scion.vercel.app
287+
288+
**Documentation Sites**
289+
- https://workbench-client-api.scion.vercel.app (latest)
290+
- https://workbench-client-api-vX-X-X.scion.vercel.app (versioned)
291+
279292
</details>
280293

281294
<details>
@@ -323,11 +336,7 @@ This chapter describes the tasks to publish a new release for `@scion/workbench`
323336
- Creates a Git release tag
324337
- Publishes `@scion/workbench` package to NPM (https://www.npmjs.com/package/@scion/workbench)
325338
- Creates a release on GitHub (https://github.com/SchweizerischeBundesbahnen/scion-workbench/releases)
326-
- Deploys following apps to Vercel:
327-
- https://workbench-getting-started.scion.vercel.app
328-
- https://workbench-testing-app.scion.vercel.app
329-
- https://workbench-client-testing-app1.scion.vercel.app (contributes microfrontends)
330-
- https://workbench-client-testing-app2.scion.vercel.app (contributes microfrontends)
339+
- Deploys Getting Started App and Testing App to Vercel
331340

332341
</details>
333342

@@ -345,14 +354,9 @@ This chapter describes the tasks to publish a new release for `@scion/workbench-
345354
- Creates a Git release tag (prefixed with workbench-client-)
346355
- Publishes `@scion/workbench-client` package to NPM (https://www.npmjs.com/package/@scion/workbench-client)
347356
- Creates a release on GitHub (https://github.com/SchweizerischeBundesbahnen/scion-workbench/releases)
348-
- Deploys following apps to Vercel:
349-
- https://workbench-getting-started.scion.vercel.app
350-
- https://workbench-testing-app.scion.vercel.app
351-
- https://workbench-client-testing-app1.scion.vercel.app (contributes microfrontends)
352-
- https://workbench-client-testing-app2.scion.vercel.app (contributes microfrontends)
353-
- Publishes API documentation (TypeDoc) to Vercel:
354-
- https://workbench-client-api.scion.vercel.app
355-
- https://workbench-client-api-vX-X-X.scion.vercel.app
357+
- Deploys Getting Started App and Testing App to Vercel
358+
- Publishes TypeDoc of `@scion/workbench-client` to Vercel
359+
356360
</details>
357361

358362
[link-github-actions-workflow]: https://github.com/SchweizerischeBundesbahnen/scion-workbench/actions

0 commit comments

Comments
 (0)