Documentation updates (#70)

serverless-ca · Mar 18, 2024 · 7c52bf1 · 7c52bf1
1 parent 200ed04
commit 7c52bf1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 # Terraform module for Certificate Authority on AWS
 * Serverless Certificate Authority typically $50 per year
-* [Equivalent cost using AWS Private CA around $10,000 per year](./docs/faq.md#how-did-you-work-out-the-cost-comparison-with-aws-private-ca)
+* [Equivalent cost using AWS Private CA around $10,000 per year](https://serverlessca.com/faq/#how-did-you-work-out-the-cost-comparison-with-aws-private-ca)
 * 100% serverless
 * CA private keys stored in [FIPS 140-2 level 3 certified hardware](https://aws.amazon.com/about-aws/whats-new/2023/05/aws-kms-hsm-fips-security-level-3)
-* Wide range of [configuration options](./docs/options.md)
+* Wide range of [configuration options](https://serverlessca.com/options/)
 * Open source with [Apache 2.0 license](./LICENSE.md)
 
 ![Alt text](docs/images/ca-architecture-options.png?raw=true "CA architecture")
 
 ## Documentation
-Detailed documentation is on our [Docs](docs/index.md) site. If testing the Serverless CA for the first time, use the [Getting Started](docs/getting-started.md) guide.
+Detailed documentation is on our [Docs](https://serverlessca.com) site. If testing the Serverless CA for the first time, use the [Getting Started](https://serverlessca.com/getting-started/) guide.
 
 ## Contributing
 We welcome contributions! See the [Contributing Guide](CONTRIBUTING.md) for how to get started.

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,7 +1,7 @@
 # Getting Started
 
 ## Objectives
-By the end of this tutorial you will have:
+By the end of this How-to guide you will have:
 * created a serverless CA in your own AWS account
 * viewed the Root CA, Issuing CA certificates and CRLs
 * issued a client certificate

diff --git a/docs/options.md b/docs/options.md
@@ -48,4 +48,4 @@ To avoid certificate validation errors, it's essential that the CRL lifetime is
 * Similarly, Root CA CRL lifetime can be adjusted using the Terraform variables `root_crl_days` and `root_crl_seconds`
  * Generally there should be no need to change these values from their defaults
 
- *Default setting (Issuing and Root CRLs): 1 day with a 600 second overlap period*
+ *Default setting (Issuing and Root CA CRLs): 1 day with a 600 second overlap period*