Skip to content

Commit

Permalink
start on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tophtucker committed Oct 22, 2024
1 parent 8128173 commit 56e4d14
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@ npm run deploy -- --help

</div>

## Automated deploys
## Continuous deployment

After deploying an app manually at least once, Observable can handle subsequent deploys for you automatically. You can automate deploys both [on commit](https://observablehq.com/documentation/data-apps/github) (whenever you push a new commit to your project’s default branch) and [on schedule](https://observablehq.com/documentation/data-apps/schedules) (such as daily or weekly).
<!-- TODO: decide whether to primarily use “continuous deployment” or “automatic deploys” -->

You can connect your app to Observable to handle deploys automatically. You can automate deploys both [on commit](https://observablehq.com/documentation/data-apps/github) (whenever you push a new commit to your project’s default branch) and [on schedule](https://observablehq.com/documentation/data-apps/schedules) (such as daily or weekly).

Automatic deploys — also called _continuous deployment_ or _CD_ — ensure that your data is always up to date, and that any changes you make to your app are immediately reflected in the deployed version.

Expand Down Expand Up @@ -88,7 +90,7 @@ To create an API key:

1. Open the [API Key settings](https://observablehq.com/select-workspace?next=api-keys-settings) for your Observable workspace.
2. Click **New API Key**.
3. Check the **Deploy new versions of projects** checkbox. <!-- TODO apps -->
3. Check the **Deploy new versions of data apps** checkbox.
4. Give your key a description, such as “Deploy via GitHub Actions”.
5. Click **Create API Key**.

Expand Down Expand Up @@ -147,7 +149,8 @@ The contents of the deploy config file look like this:
{
"projectId": "0123456789abcdef",
"projectSlug": "hello-framework",
"workspaceLogin": "acme"
"workspaceLogin": "acme",
"continuousDeployment": true
}
```

Expand Down

0 comments on commit 56e4d14

Please sign in to comment.