updated docs for local deployment

OpenFn · Sep 18, 2023 · eca497c · eca497c
1 parent 2edee0e
commit eca497c
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 36 deletions.
diff --git a/docs/deploy/options.md b/docs/deploy/options.md
@@ -100,3 +100,13 @@ proven, and you're ready to scale it up.
 5. Re-configure your credentials (credential secrets will _not_ be included in
    the export).
 6. Test your locally deployed project.
+
+## Technical Guidelines
+
+For detailed deployment documentation instructions, head to the Lightning
+[developer docs page](https://openfn.github.io/Lightning/readme.html), paying
+special attention to several sections:
+
+1. [Getting Started](https://openfn.github.io/Lightning/readme.html#getting-started)
+2. [Deployment Considerations](https://openfn.github.io/Lightning/deployment.html)
+3. [Benchmarking](https://openfn.github.io/Lightning/benchmarking.html)
diff --git a/docs/deploy/requirements.md b/docs/deploy/requirements.md
@@ -41,7 +41,7 @@ your deployment partner can better estimate your total cost of ownership.
 | Javascript | The OpenFn **job processing workers** and OpenFn workflows themselves are Javascript-based. With knowledge of how NodeJs works you can build workflows that do _anything_.                                                                                                   |
 | Postgres   | The default **database** for OpenFn is PostgreSQL                                                                                                                                                                                                                            |
 | Docker     | We publish all **OpenFn [images](https://hub.docker.com/repository/docker/openfn/lightning/general)** on Docker Hub. Whether you're streamlining developer setup or using container orchestration technologies, understanding docker and containerized computing is helpful. |
-| Kubernetes | For high-availability deployments, Kubernetes services provide **load balancing** and simplify **container management** on multiple hosts. They make it easy for an enterprise's apps to have greater scalability and be flexible, portable and more productive.              |
+| Kubernetes | For high-availability deployments, Kubernetes services provide **load balancing** and simplify **container management** on multiple hosts. They make it easy for an enterprise's apps to have greater scalability and be flexible, portable and more productive.             |
 
 ## Machine Requirements
 

diff --git a/docs/getting-started/automation-inspiration.md b/docs/getting-started/automation-inspiration.md
diff --git a/docs/getting-started/deployment-options.md b/docs/getting-started/deployment-options.md
diff --git a/docs/getting-started/designing-integrations.md b/docs/getting-started/designing-integrations.md
diff --git a/docs/getting-started/use-cases.md b/docs/getting-started/use-cases.md