Skip to content

Commit

Permalink
Revert "docs: add deployment explanation to schema viewer readme" (#261)
Browse files Browse the repository at this point in the history
  • Loading branch information
jessicamcinchak authored Oct 17, 2024
1 parent 4ba8e8c commit 993cc69
Showing 1 changed file with 0 additions and 21 deletions.
21 changes: 0 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,3 @@ We're currently trying out [@stoplight/json-schema-viewer](https://github.com/st
pnpm i
pnpm dev
```

## Deployment

The docs viewer is currently deployable, but at the expense of the existing JSON files that are deployed from the `dist` branch.

### To deploy the schema viewer:

1. Go to Settings -> Pages
2. Under `Build and deployment` switch the `Source` to `GitHub Actions`.
3. This should trigger a deployment action.
4. Once finished, the schema viewer should be visible at `"https:/theopensystemslab.github.io/digital-planning-data-schemas"`.

### To deploy the JSON files:

1. Go to Settings -> Pages
2. Under `Build and deployment` switch the `Source` to `Deploy from a branch`.
3. Change the branch to `dist`.
4. Make sure you select `/root` for the folder, and press 'Save'.
5. This should trigger a deployment action.
4. Once finished, the JSON files should be visible at `https://theopensystemslab.github.io/digital-planning-data-schemas/<VERSION>/schemas/<SCHEMA>.json`.

0 comments on commit 993cc69

Please sign in to comment.