Skip to content

Commit

Permalink
chore(release): Replace Jekyll docs with TypeDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gnarea committed Sep 6, 2024
1 parent 8c785c9 commit 6e34de9
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 33 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,5 @@ jobs:
release:
needs: ci
uses: relaycorp/shared-workflows/.github/workflows/nodejs-lib-release.yml@main
with:
jekyll_docs: true
secrets:
npm_token: ${{ secrets.NPM_TOKEN }}
16 changes: 12 additions & 4 deletions docs/gcp.md → api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
---
nav_order: 1
permalink: /gcp
---
# Overview

`@relaycorp/awala-keystore-cloud` is a Node.js library that implements
[Awala](https://awala.network/) private key stores across a range of cloud providers and open
source backing services, so that server-side apps can be deployed to a wide variety of platforms.

Most of this documentation is aimed at _operators_ of those server-side apps using this library.
To get help, learn how to integrate this library or contribute to this library, please refer to the
[GitHub project](https://github.com/relaycorp/awala-keystore-cloud-js).

The following platforms are currently supported:

# Google Cloud Platform (GCP)

The GCP key store only uses [Cloud KMS](https://cloud.google.com/kms), which is serverless and fully managed by Google, so you don't need to worry about up/down scaling or uptime/performance monitoring. We protect sensitive cryptographic material with Cloud KMS as follows:
Expand Down
14 changes: 0 additions & 14 deletions docs/_config.yml

This file was deleted.

12 changes: 0 additions & 12 deletions docs/index.md

This file was deleted.

3 changes: 2 additions & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"exclude": ["**/*.spec.ts"],
"excludePrivate": true,
"excludeProtected": true,
"theme": "minimal"
"theme": "default",
"readme": "api.md"
}

0 comments on commit 6e34de9

Please sign in to comment.