docs: improves nav.

outofcoffee · Dec 21, 2023 · 9e27453 · 9e27453
1 parent b1d4b19
commit 9e27453
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 55 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -16,79 +16,93 @@ Imposter is a mock server for REST APIs, OpenAPI (and Swagger) specifications, S
 
 ## Getting started
 
-To begin, check out the [Getting started](getting_started.md) guide. See the _User documentation_ section below, or read a [product summary](./summary.md).
+To begin, check out the [Getting started](getting_started.md) guide. See the _Core concepts_ section below, or read a [product summary](./summary.md).
 
-## User documentation
+### Core concepts
 
 - [Getting started](getting_started.md)
 - [Configuration guide](configuration.md)
 - [Response templates](templates.md)
 - [Scripting](scripting.md)
 - [Security](security.md)
 
+### Developing mocks
+
+- [Advanced request matching](request_matching.md)
+- [OpenAPI validation](openapi_validation.md)
+- [Template queries](template_queries.md)
+- [Performance simulation](performance_simulation.md)
+- [Failure simulation](./failure_simulation.md)
+- [Generating fake data](fake_data.md)
+- [CORS](cors.md)
+- [Groovy scripting tips](groovy_tips.md)
+- [Examples](https://github.com/outofcoffee/imposter/tree/main/examples)
+
 ### Data capture and storage
 
 - [Data capture](data_capture.md)
 - [Stores](stores.md)
 - [GraphQL](stores_graphql.md)
 
-### Advanced configuration
+### Configuration
 
+- [Configuration guide](configuration.md)
 - [Configuration location](config_location.md)
 - [Scaffolding configuration](scaffold.md)
 - [Environment variables](environment_variables.md)
 - [Proxy an existing endpoint](proxy_endpoint.md)
 - [Recursive configuration discovery](config_discovery.md)
 - [Bundling configuration](bundle.md)
 
-### Developing mocks
-
-- [Advanced request matching](request_matching.md)
-- [OpenAPI validation](openapi_validation.md)
-- [Template queries](template_queries.md)
-- [Performance simulation](performance_simulation.md)
-- [Failure simulation](./failure_simulation.md)
-- [Generating fake data](fake_data.md)
-- [CORS](cors.md)
-- [Groovy scripting tips](groovy_tips.md)
-- [Examples](https://github.com/outofcoffee/imposter/tree/main/examples)
+### Run and deploy
+- [Command line (CLI)](run_imposter_cli.md)
+- [Docker](run_imposter_docker.md)
+- [AWS Lambda](run_imposter_aws_lambda.md)
+- [Java JAR file](run_imposter_jar.md)
+- [Deployment patterns](./deployment_patterns.md)
 
 ### Operational topics
 
-- [Deployment patterns](./deployment_patterns.md)
 - [Metrics, health, logs and telemetry](metrics_logs_telemetry.md)
 - [Performance tuning](./performance_tuning.md)
 - [Benchmarks](./benchmarks.md)
 - [TLS/SSL](./tls_ssl.md)
 
+## Mock types
+
+Imposter provides specialised mocks for the following scenarios:
+
+- [OpenAPI](openapi_plugin.md) - Support for OpenAPI (and Swagger) API specifications.
+- [REST](rest_plugin.md) - Mocks RESTful or plain HTTP APIs.
+- [SOAP](soap_plugin.md) - Support for SOAP web services (and WSDL files).
+- [HBase](hbase_plugin.md) - Basic HBase mock implementation.
+- [SFDC (Salesforce)](sfdc_plugin.md) - Basic Salesforce mock implementation.
+- [WireMock](wiremock_plugin.md) - Support for WireMock mappings files.
+
+---
+
+## Learn more
+
 ### Other
 
 - [Plugins](./plugins.md)
 - [Features](./features.md)
 - [Tips and tricks](tips_tricks.md)
 - [Usage](usage.md)
 
-## Mock types
+### Product
 
-Imposter provides specialised mocks for the following scenarios:
+- [Summary](summary.md)
+- [Product home](https://www.imposter.sh)
 
-- **[OpenAPI](openapi_plugin.md)** - Support for OpenAPI (and Swagger) API specifications.
-- **[REST](rest_plugin.md)** - Mocks RESTful or plain HTTP APIs.
-- **[SOAP](soap_plugin.md)** - Support for SOAP web services (and WSDL files).
-- **[HBase](hbase_plugin.md)** - Basic HBase mock implementation.
-- **[SFDC (Salesforce)](sfdc_plugin.md)** - Basic Salesforce mock implementation.
-- **[WireMock](wiremock_plugin.md)** - Support for WireMock mappings files.
+### Tutorials
 
-> Learn more about [plugins](plugins.md).
+- [Mocking APIs with OpenAPI and Imposter](https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0)
+- [Mocking REST APIs with Imposter](https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5)
+- [Mocking SOAP web services with Imposter](https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4)
 
-## Developers
+### Developers
 
 - [GitHub](https://github.com/outofcoffee/imposter)
 - [Roadmap](roadmap.md)
 - [Build](build.md)
-
-## Tutorials
-
-- [Mocking APIs with OpenAPI and Imposter](https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0)
-- [Mocking REST APIs with Imposter](https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5)
-- [Mocking SOAP web services with Imposter](https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4)
diff --git a/docs/summary.md b/docs/summary.md
@@ -37,4 +37,3 @@ Imposter provides specialised mocks for the following scenarios:
 - **[HBase](hbase_plugin.md)** - Basic HBase mock implementation.
 - **[SFDC (Salesforce)](sfdc_plugin.md)** - Basic Salesforce mock implementation.
 - **[WireMock](wiremock_plugin.md)** - Support for WireMock mappings files.
-- 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -14,14 +14,15 @@ extra:
     property: G-K7GTJGJQ2S
 
 nav:
-  - Home: 'https://www.imposter.sh'
   - Introduction: 'index.md'
   - Getting started: 'getting_started.md'
-  - Configuration guide: 'configuration.md'
-  - Response templates: 'templates.md'
-  - Scripting: 'scripting.md'
-  - Security: 'security.md'
 
+  - Core concepts:
+    - Configuration guide: 'configuration.md'
+    - Response templates: 'templates.md'
+    - Scripting: 'scripting.md'
+    - Security: 'security.md'
+
   - Mock types:
     - OpenAPI (and Swagger): 'openapi_plugin.md'
     - REST: 'rest_plugin.md'
@@ -30,19 +31,6 @@ nav:
     - SFDC (Salesforce): 'sfdc_plugin.md'
     - WireMock: 'wiremock_plugin.md'
 
-  - Data capture and storage:
-    - Data capture: 'data_capture.md'
-    - Stores: 'stores.md'
-    - GraphQL: 'stores_graphql.md'
-
-  - Advanced configuration:
-    - Configuration location: 'config_location.md'
-    - Scaffolding configuration: 'scaffold.md'
-    - Environment variables: 'environment_variables.md'
-    - Proxy an existing endpoint: 'proxy_endpoint.md'
-    - Recursive configuration discovery: 'config_discovery.md'
-    - Bundling configuration: 'bundle.md'
-
   - Developing mocks:
     - Advanced request matching: 'request_matching.md'
     - OpenAPI validation: 'openapi_validation.md'
@@ -54,8 +42,28 @@ nav:
     - Groovy scripting tips: 'groovy_tips.md'
     - Examples: 'https://github.com/outofcoffee/imposter/tree/main/examples'
 
-  - Operational topics:
+  - Data capture and storage:
+    - Data capture: 'data_capture.md'
+    - Stores: 'stores.md'
+    - GraphQL: 'stores_graphql.md'
+
+  - Configuration:
+    - Configuration guide: 'configuration.md'
+    - Configuration location: 'config_location.md'
+    - Scaffolding configuration: 'scaffold.md'
+    - Environment variables: 'environment_variables.md'
+    - Proxy an existing endpoint: 'proxy_endpoint.md'
+    - Recursive configuration discovery: 'config_discovery.md'
+    - Bundling configuration: 'bundle.md'
+
+  - Run and deploy:
+    - 'Command line (CLI)': 'run_imposter_cli.md'
+    - Docker: 'run_imposter_docker.md'
+    - AWS Lambda: 'run_imposter_aws_lambda.md'
+    - Java JAR file: 'run_imposter_jar.md'
     - Deployment patterns: 'deployment_patterns.md'
+
+  - Operational topics:
     - Metrics, health, logs and telemetry: 'metrics_logs_telemetry.md'
     - Performance tuning: 'performance_tuning.md'
     - Benchmarks: 'benchmarks.md'
@@ -67,12 +75,16 @@ nav:
     - Tips and tricks: 'tips_tricks.md'
     - Usage: 'usage.md'
 
-  - Developers:
-    - GitHub: 'https://github.com/outofcoffee/imposter'
-    - Roadmap: 'roadmap.md'
-    - Build: 'build.md'
+  - Product:
+    - Summary: 'summary.md'
+    - Home: 'https://www.imposter.sh'
 
   - Tutorials:
     - Mocking APIs with OpenAPI and Imposter: 'https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0'
     - Mocking REST APIs with Imposter: 'https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5'
     - Mocking SOAP web services with Imposter: 'https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4'
+
+  - Developers:
+    - GitHub: 'https://github.com/outofcoffee/imposter'
+    - Roadmap: 'roadmap.md'
+    - Build: 'build.md'