integrate review comments

SimpleDataLabsInc · Dec 10, 2024 · f379ed1 · f379ed1
1 parent 0f563c7
commit f379ed1
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 9 deletions.
diff --git a/docs/architecture/self-hosted/installation-helm/install-on-aws.mdx b/docs/architecture/self-hosted/installation-helm/install-on-aws.mdx
@@ -83,13 +83,13 @@ Prophecy can install its own Nginx ingress controller to expose services externa
 
 ### Hostname resolution
 
-If you use a Prophecy domain in the format `*.cloud.prophecy.io`, Prophecy handles the hostname resolution. SSL certificates are managed using Let’s Encrypt and the DNS configuration is done for you.
+If you use a Prophecy domain in the format `*.cloud.prophecy.io`, Prophecy handles the hostname resolution. SSL certificates are managed using [Let's Encrypt](https://letsencrypt.org/how-it-works/), and the DNS configuration is done for you.
 
 If you want to use your own domain:
 
 1. Obtain SSL certificates for your domain.
 2. Install the certificates in your Kubernetes cluster.
-3. Add DNS entries for the services in your domain’s DNS zone.
+3. Add DNS entries for the services in your domain's DNS zone.
 4. Ensure the entries point to the external IP address of the Nginx ingress controller LoadBalancer.
 
 ## Install Prophecy with Helm {#helm-installation}

diff --git a/docs/architecture/self-hosted/installation-helm/installation-helm.mdx b/docs/architecture/self-hosted/installation-helm/installation-helm.mdx
@@ -16,12 +16,6 @@ Installation requirements and Helm chart values are outlined in this page.
 
 For an example step-by-step installation, visit [Installation on AWS](install-on-aws).
 
-:::caution
-
-The following documentation pertains to the Helm installer for Prophecy version 3.3 and above. If you're considering migrating your current Helm installer chart to this version, we encourage you to reach out to the Prophecy support team for personalized assistance and guidance.
-
-:::
-
 ## Requirements
 
 To install Prophecy, you need:

diff --git a/docs/architecture/self-hosted/self-hosted.md b/docs/architecture/self-hosted/self-hosted.md
@@ -8,7 +8,11 @@ tags:
   - self-hosted
 ---
 
-Prophecy is written as a set of microservices that run on a Kubernetes cluster. The most commonly used platforms to run Kubernetes are AWS, Azure, and GCP.
+Prophecy is written as a set of microservices that run on a Kubernetes cluster. Our recommended platforms to run Kubernetes are:
+
+- Amazon Web Services managed EKS
+- Microsoft Azure managed AKS
+- Google Cloud Platform managed GKE
 
 There are a couple of ways to install the self-managed version of Prophecy:
 

diff --git a/docs/architecture/self-hosted/upgrade-backup-restore.md b/docs/architecture/self-hosted/upgrade-backup-restore.md
@@ -74,6 +74,15 @@ Below is a list of supported variables that you can change.
 
 ### Additional backup APIs
 
+Here is a list of additional APIs for backups. One sample call may look like:
+
+```
+ curl --location --request POST 'https://{prophecy-url}/api/backup' \
+ --header 'Cookie: prophecy-token={api-key}' \
+ --header 'Content-Type: application/json' \
+ --data-raw '{}'
+```
+
 | API                                                | Description                                                                                                                                                                                                                                                                                 | Parameters    |
 | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
 | **GET** `https://{prophecy-url}/api/backup/latest` | This API returns the status current/last backup operation triggered.                                                                                                                                                                                                                        | None expected |
@@ -144,6 +153,15 @@ Sample response
 
 ### Additional restore APIs
 
+Here is a list of additional APIs for restore. One sample call may look like:
+
+```
+curl --location --request POST 'https://{prophecy-url}/api/backup'
+--header 'Cookie: prophecy-token={api-key}'
+--header 'Content-Type: application/json'
+--data-raw '{}'
+```
+
 | API                                                 | Description                                                                                                                                                                                     | Parameters  |
 | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
 | **GET** `https://{prophecy-url}/api/restore/status` | This API returns the status of the restore operation with a certain timestamp. If there is no timestamp passed and there is an ongoing restore, the status for the ongoing restore is returned. | `timestamp` |