Skip to content

Commit 9e27453

Browse files
committed
docs: improves nav.
1 parent b1d4b19 commit 9e27453

File tree

3 files changed

+80
-55
lines changed

3 files changed

+80
-55
lines changed

docs/index.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,79 +16,93 @@ Imposter is a mock server for REST APIs, OpenAPI (and Swagger) specifications, S
1616

1717
## Getting started
1818

19-
To begin, check out the [Getting started](getting_started.md) guide. See the _User documentation_ section below, or read a [product summary](./summary.md).
19+
To begin, check out the [Getting started](getting_started.md) guide. See the _Core concepts_ section below, or read a [product summary](./summary.md).
2020

21-
## User documentation
21+
### Core concepts
2222

2323
- [Getting started](getting_started.md)
2424
- [Configuration guide](configuration.md)
2525
- [Response templates](templates.md)
2626
- [Scripting](scripting.md)
2727
- [Security](security.md)
2828

29+
### Developing mocks
30+
31+
- [Advanced request matching](request_matching.md)
32+
- [OpenAPI validation](openapi_validation.md)
33+
- [Template queries](template_queries.md)
34+
- [Performance simulation](performance_simulation.md)
35+
- [Failure simulation](./failure_simulation.md)
36+
- [Generating fake data](fake_data.md)
37+
- [CORS](cors.md)
38+
- [Groovy scripting tips](groovy_tips.md)
39+
- [Examples](https://github.com/outofcoffee/imposter/tree/main/examples)
40+
2941
### Data capture and storage
3042

3143
- [Data capture](data_capture.md)
3244
- [Stores](stores.md)
3345
- [GraphQL](stores_graphql.md)
3446

35-
### Advanced configuration
47+
### Configuration
3648

49+
- [Configuration guide](configuration.md)
3750
- [Configuration location](config_location.md)
3851
- [Scaffolding configuration](scaffold.md)
3952
- [Environment variables](environment_variables.md)
4053
- [Proxy an existing endpoint](proxy_endpoint.md)
4154
- [Recursive configuration discovery](config_discovery.md)
4255
- [Bundling configuration](bundle.md)
4356

44-
### Developing mocks
45-
46-
- [Advanced request matching](request_matching.md)
47-
- [OpenAPI validation](openapi_validation.md)
48-
- [Template queries](template_queries.md)
49-
- [Performance simulation](performance_simulation.md)
50-
- [Failure simulation](./failure_simulation.md)
51-
- [Generating fake data](fake_data.md)
52-
- [CORS](cors.md)
53-
- [Groovy scripting tips](groovy_tips.md)
54-
- [Examples](https://github.com/outofcoffee/imposter/tree/main/examples)
57+
### Run and deploy
58+
- [Command line (CLI)](run_imposter_cli.md)
59+
- [Docker](run_imposter_docker.md)
60+
- [AWS Lambda](run_imposter_aws_lambda.md)
61+
- [Java JAR file](run_imposter_jar.md)
62+
- [Deployment patterns](./deployment_patterns.md)
5563

5664
### Operational topics
5765

58-
- [Deployment patterns](./deployment_patterns.md)
5966
- [Metrics, health, logs and telemetry](metrics_logs_telemetry.md)
6067
- [Performance tuning](./performance_tuning.md)
6168
- [Benchmarks](./benchmarks.md)
6269
- [TLS/SSL](./tls_ssl.md)
6370

71+
## Mock types
72+
73+
Imposter provides specialised mocks for the following scenarios:
74+
75+
- [OpenAPI](openapi_plugin.md) - Support for OpenAPI (and Swagger) API specifications.
76+
- [REST](rest_plugin.md) - Mocks RESTful or plain HTTP APIs.
77+
- [SOAP](soap_plugin.md) - Support for SOAP web services (and WSDL files).
78+
- [HBase](hbase_plugin.md) - Basic HBase mock implementation.
79+
- [SFDC (Salesforce)](sfdc_plugin.md) - Basic Salesforce mock implementation.
80+
- [WireMock](wiremock_plugin.md) - Support for WireMock mappings files.
81+
82+
---
83+
84+
## Learn more
85+
6486
### Other
6587

6688
- [Plugins](./plugins.md)
6789
- [Features](./features.md)
6890
- [Tips and tricks](tips_tricks.md)
6991
- [Usage](usage.md)
7092

71-
## Mock types
93+
### Product
7294

73-
Imposter provides specialised mocks for the following scenarios:
95+
- [Summary](summary.md)
96+
- [Product home](https://www.imposter.sh)
7497

75-
- **[OpenAPI](openapi_plugin.md)** - Support for OpenAPI (and Swagger) API specifications.
76-
- **[REST](rest_plugin.md)** - Mocks RESTful or plain HTTP APIs.
77-
- **[SOAP](soap_plugin.md)** - Support for SOAP web services (and WSDL files).
78-
- **[HBase](hbase_plugin.md)** - Basic HBase mock implementation.
79-
- **[SFDC (Salesforce)](sfdc_plugin.md)** - Basic Salesforce mock implementation.
80-
- **[WireMock](wiremock_plugin.md)** - Support for WireMock mappings files.
98+
### Tutorials
8199

82-
> Learn more about [plugins](plugins.md).
100+
- [Mocking APIs with OpenAPI and Imposter](https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0)
101+
- [Mocking REST APIs with Imposter](https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5)
102+
- [Mocking SOAP web services with Imposter](https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4)
83103

84-
## Developers
104+
### Developers
85105

86106
- [GitHub](https://github.com/outofcoffee/imposter)
87107
- [Roadmap](roadmap.md)
88108
- [Build](build.md)
89-
90-
## Tutorials
91-
92-
- [Mocking APIs with OpenAPI and Imposter](https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0)
93-
- [Mocking REST APIs with Imposter](https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5)
94-
- [Mocking SOAP web services with Imposter](https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4)

docs/summary.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,3 @@ Imposter provides specialised mocks for the following scenarios:
3737
- **[HBase](hbase_plugin.md)** - Basic HBase mock implementation.
3838
- **[SFDC (Salesforce)](sfdc_plugin.md)** - Basic Salesforce mock implementation.
3939
- **[WireMock](wiremock_plugin.md)** - Support for WireMock mappings files.
40-
-

mkdocs.yml

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ extra:
1414
property: G-K7GTJGJQ2S
1515

1616
nav:
17-
- Home: 'https://www.imposter.sh'
1817
- Introduction: 'index.md'
1918
- Getting started: 'getting_started.md'
20-
- Configuration guide: 'configuration.md'
21-
- Response templates: 'templates.md'
22-
- Scripting: 'scripting.md'
23-
- Security: 'security.md'
2419

20+
- Core concepts:
21+
- Configuration guide: 'configuration.md'
22+
- Response templates: 'templates.md'
23+
- Scripting: 'scripting.md'
24+
- Security: 'security.md'
25+
2526
- Mock types:
2627
- OpenAPI (and Swagger): 'openapi_plugin.md'
2728
- REST: 'rest_plugin.md'
@@ -30,19 +31,6 @@ nav:
3031
- SFDC (Salesforce): 'sfdc_plugin.md'
3132
- WireMock: 'wiremock_plugin.md'
3233

33-
- Data capture and storage:
34-
- Data capture: 'data_capture.md'
35-
- Stores: 'stores.md'
36-
- GraphQL: 'stores_graphql.md'
37-
38-
- Advanced configuration:
39-
- Configuration location: 'config_location.md'
40-
- Scaffolding configuration: 'scaffold.md'
41-
- Environment variables: 'environment_variables.md'
42-
- Proxy an existing endpoint: 'proxy_endpoint.md'
43-
- Recursive configuration discovery: 'config_discovery.md'
44-
- Bundling configuration: 'bundle.md'
45-
4634
- Developing mocks:
4735
- Advanced request matching: 'request_matching.md'
4836
- OpenAPI validation: 'openapi_validation.md'
@@ -54,8 +42,28 @@ nav:
5442
- Groovy scripting tips: 'groovy_tips.md'
5543
- Examples: 'https://github.com/outofcoffee/imposter/tree/main/examples'
5644

57-
- Operational topics:
45+
- Data capture and storage:
46+
- Data capture: 'data_capture.md'
47+
- Stores: 'stores.md'
48+
- GraphQL: 'stores_graphql.md'
49+
50+
- Configuration:
51+
- Configuration guide: 'configuration.md'
52+
- Configuration location: 'config_location.md'
53+
- Scaffolding configuration: 'scaffold.md'
54+
- Environment variables: 'environment_variables.md'
55+
- Proxy an existing endpoint: 'proxy_endpoint.md'
56+
- Recursive configuration discovery: 'config_discovery.md'
57+
- Bundling configuration: 'bundle.md'
58+
59+
- Run and deploy:
60+
- 'Command line (CLI)': 'run_imposter_cli.md'
61+
- Docker: 'run_imposter_docker.md'
62+
- AWS Lambda: 'run_imposter_aws_lambda.md'
63+
- Java JAR file: 'run_imposter_jar.md'
5864
- Deployment patterns: 'deployment_patterns.md'
65+
66+
- Operational topics:
5967
- Metrics, health, logs and telemetry: 'metrics_logs_telemetry.md'
6068
- Performance tuning: 'performance_tuning.md'
6169
- Benchmarks: 'benchmarks.md'
@@ -67,12 +75,16 @@ nav:
6775
- Tips and tricks: 'tips_tricks.md'
6876
- Usage: 'usage.md'
6977

70-
- Developers:
71-
- GitHub: 'https://github.com/outofcoffee/imposter'
72-
- Roadmap: 'roadmap.md'
73-
- Build: 'build.md'
78+
- Product:
79+
- Summary: 'summary.md'
80+
- Home: 'https://www.imposter.sh'
7481

7582
- Tutorials:
7683
- Mocking APIs with OpenAPI and Imposter: 'https://medium.com/@outofcoffee/mocking-apis-with-swagger-and-imposter-3694bd1733c0'
7784
- Mocking REST APIs with Imposter: 'https://medium.com/@outofcoffee/mocking-apis-with-imposter-53bd908632e5'
7885
- Mocking SOAP web services with Imposter: 'https://medium.com/@outofcoffee/mocking-soap-web-services-with-imposter-da8e9666b5b4'
86+
87+
- Developers:
88+
- GitHub: 'https://github.com/outofcoffee/imposter'
89+
- Roadmap: 'roadmap.md'
90+
- Build: 'build.md'

0 commit comments

Comments
 (0)