diff --git a/README.md b/README.md index bc30d2cc..0b48e16f 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ docker run --rm -it --name functions -v ${PWD}/data:/app/data -v /var/run/docker *where ${PWD}/data is the directory where the functions application data files will be stored* This will start IronFunctions in single server mode, using an embedded database and message queue. You can find all the -configuration options [here](docs/options.md). If you are on Windows, check [here](docs/operating/windows.md). +configuration options [here](docs/operating/options.md). If you are on Windows, check [here](docs/operating/windows.md). ### CLI tool diff --git a/docs/README.md b/docs/README.md index c406cd89..cf88ebda 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,8 +22,9 @@ If you are a developer using IronFunctions through the API, this section is for If you are operating IronFunctions, this section is for you. * [Running in Production Overview](operating/production.md) -* [Databases](databases/README.md) -* [Message Queues](mqs/README.md) +* [Runtime Options](operating/options.md) +* [Databases](operating/databases/README.md) +* [Message Queues](operating/mqs/README.md) * [UI](operating/ui.md) * [Logging](operating/logging.md) * [Metrics](operating/metrics.md) @@ -34,5 +35,3 @@ If you are operating IronFunctions, this section is for you. * Running IronFunctions on: * [Kubernetes](operating/kubernetes/README.md) * [Docker Swarm](operating/docker-swarm/README.md) - - diff --git a/docs/mqs/README.md b/docs/operating/mqs/README.md similarity index 100% rename from docs/mqs/README.md rename to docs/operating/mqs/README.md diff --git a/docs/options.md b/docs/operating/options.md similarity index 100% rename from docs/options.md rename to docs/operating/options.md diff --git a/docs/operating/production.md b/docs/operating/production.md index 05e08914..d0f92372 100644 --- a/docs/operating/production.md +++ b/docs/operating/production.md @@ -1,6 +1,6 @@ # Running IronFunctions in Production -The [QuickStart guide](/README.md) is intended to quickly get started and kick the tires. To run in production and be ready to scale, you need +The [QuickStart guide](/README.md#quickstart) is intended to quickly get started and kick the tires. To run in production and be ready to scale, you need to use more production ready components. * Put the IronFunctions API behind a load balancer and launch run several instances of them (the more the merrier). @@ -21,14 +21,14 @@ Any load balancer will work, put every instance of IronFunctions that you run be We've done our best to keep the database usage to a minimum. There are no writes during the request/response cycle which where most of the load will be. -The database is pluggable and we currently support a few options that can be [found here](/docs/databases/). We welcome pull requests for more! +The database is pluggable and we currently support a few options that can be [found here](databases/README.md). We welcome pull requests for more! ## Message Queue The message queue is an important part of asynchronous functions, essentially buffering requests for processing when resources are available. The reliability and scale of the message queue will play an important part in how well IronFunctions runs, in particular if you use a lot of asynchronous function calls. -The message queue is pluggable and we currently support a few options that can be [found here](/docs/mqs/). We welcome pull requests for more! +The message queue is pluggable and we currently support a few options that can be [found here](mqs/README.md). We welcome pull requests for more! ## Logging, Metrics and Monitoring