Skip to content

Commit 1b2e833

Browse files
committed
docs: Restructure documentation hierarchy
1 parent b00689f commit 1b2e833

13 files changed

+20
-13
lines changed

docs/configuration/_category_.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "Configuration",
3+
"position": 30,
4+
"link": {
5+
"type": "doc", "id": "configuration"
6+
}
7+
}
Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,6 @@ import CodeConfigurationAsyncApiDocket from '!!raw-loader!./snippets/_configurat
99

1010
# Configuration
1111

12-
## Activating
13-
14-
Springwolf is actived automatically as soon as one of the available plugin dependencies (e.g. `springwolf-kafka`)
15-
is added to the application classpath.
16-
17-
18-
19-
## Springwolf configuration
20-
2112
There are 2 ways to configure springwolf:
2213

2314
1. `application.properties`, which is simple and should suit most use-cases
@@ -34,6 +25,8 @@ There are 2 ways to configure springwolf:
3425
</TabItem>
3526
</Tabs>
3627

28+
## Properties
29+
3730
### basePackage (required)
3831

3932
It is recommended to structure the project such that all consumers and producers (classes containing listener/producer methods) are in the same package - it is not mandatory, and if they are scattered across multiple packages, just provide the highest in hierarchy package that contains all of them.

docs/documenting-consumers.md renamed to docs/configuration/documenting-consumers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 60
33
---
44

5-
# Documenting Consumers
5+
# Consumers
66

77
Springwolf comes with build-in support to auto-detect listeners of supported protocols.
88

docs/documenting-producers.md renamed to docs/configuration/documenting-producers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 64
33
---
44

5-
# Documenting Producers
5+
# Producers
66

77
Unlike consumers which are defined declaratively with an annotation, producers are defined imperatively, and there is no implementation uniform enough so that metadata can be picked up automatically.
88

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
88
import CodeSchemaGroovy from '!!raw-loader!./snippets/_schema_groovy.md';
99
import CodeSchemaMaven from '!!raw-loader!./snippets/_schema_maven.md';
1010

11-
# Documenting Schemas
11+
# Schemas
1212

1313
Under the hood springwolf relies on swagger-core `ModelConverters`.
1414

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If not, whether
3939
Publishing messages from the UI is disabled by default due to security concerns.
4040
Springwolf does not offer authentication nor authorization, anyone can publish messages to (production) channels.
4141

42-
Check the [configuration](configuration.md) to enable this feature.
42+
Check the [configuration](configuration/configuration.md) to enable this feature.
4343

4444
Spring Security allows to limit access to authorized users.
4545

0 commit comments

Comments
 (0)