Skip to content

Commit 11b6891

Browse files
committed
docs: prepare 1.12.0 release
1 parent d859d95 commit 11b6891

13 files changed

+12538
-20374
lines changed

docs/faq.md

Lines changed: 51 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -100,18 +100,23 @@ Be sure to enable fully qualified names ([`use-fqn`](configuration/configuration
100100
101101
Spring Security allows to limit access to authorized users.
102102
103-
### Consumers are detected multiple times (with different payloads)
103+
### Classes have fully qualified names (`io.springwolf.package.ClassName`)
104104
105-
When Springwolf finds multiple consumers/producers for the same channel/topic, these are merged together.
106-
This is expected, as there are use-cases where different payloads are sent via the same channel/topic.
107-
108-
Springwolf uses on scanners to find all consumer and producers in your application.
109-
Most likely two scanners found your consumer/producer each.
110-
See [configuration](configuration/configuration.mdx) to disable scanners.
105+
Disable the [fully qualified class name (FQN) option (`springwolf.use-fqn=false`)](configuration/configuration.mdx).
111106
112107
### Only one of multiple classes with the same name (different package) is detected
113108
114-
Enable the fully qualified class name (FQN) option (`springwolf.use-fqn=true`) so that Springwolf uses the FQN internally.
109+
Enable the [fully qualified class name (FQN) option (`springwolf.use-fqn=true`)](configuration/configuration.mdx).
110+
111+
### Springwolf interferes with OpenAPI documentation
112+
113+
Springwolf uses `swagger-core` to analyze classes, which is used by some OpenAPI libraries like `springdoc-openapi`.
114+
`swagger-core` configuration is partly global and can't be isolated.
115+
116+
Options:
117+
118+
1. Use the same settings in Springwolf and the other library (including the [fully qualified class name (FQN) option (`springwolf.use-fqn=false`)](configuration/configuration.mdx)).
119+
2. Don't run Springwolf and the other library at the same time, for example by generating the documentation at build time.
115120

116121
### Generic types (List) don't contain item properties
117122

@@ -133,40 +138,25 @@ class ListWrapper extends ArrayList<String> {}
133138
public void sendMessage(ListWrapper<String> msg) {}
134139
```
135140

136-
## Release Notes / Migration Guide / Updating / Upgrading
137-
138-
Releases are managed in [GitHub Releases](https://github.com/springwolf/springwolf-core/releases),
139-
which feature noteworthy changes, the full changelog and notes on how to migrate.
140-
141-
Since each release has a git _tag_, the [Springwolf examples for each plugin](https://github.com/springwolf/springwolf-core/blob/master/springwolf-examples) showcase the use of Springwolf for any previous version.
142-
143-
### How to migrate from Springwolf 0.18.0 to 1.0.0
144-
145-
See [Release 1.0.0](https://github.com/springwolf/springwolf-core/releases/tag/v1.0.0).
146-
147-
### How to migrate from the deprecated `AsyncApiDocket` bean to Spring properties
148-
149-
See [Issue #445](https://github.com/springwolf/springwolf-core/issues/445).
150-
151-
### Is Spring Boot 2.X supported
152-
153-
You can use an older version of Springwolf, which is build to support Spring Boot 2.X.
154-
However, these versions don't get any updates.
141+
### Consumers are detected multiple times (with different payloads)
155142

156-
Last versions to support Spring Boot 2.X:
143+
When Springwolf finds multiple consumers/producers for the same channel/topic, these are merged together.
144+
This is expected, as there are use-cases where different payloads are sent via the same channel/topic.
157145

158-
- `springwolf-amqp:0.6.0`
159-
- `springwolf-cloud-stream:0.1.0`
160-
- `springwolf-core:0.6.0`
161-
- `springwolf-kafka:0.10.0`
162-
- `springwolf-ui:0.6.0`
146+
Springwolf uses on scanners to find all consumer and producers in your application.
147+
Most likely two scanners found your consumer/producer each.
148+
See [configuration](configuration/configuration.mdx) to disable scanners.
163149

164150
## Usage Patterns
165151

166152
### How to access the generated documentation within java
167153

168154
Use the `AsyncApiService` to access the generated documentation.
169155

156+
### How to customize the generated documentation
157+
158+
See the [customization page](configuration/customizing.md)
159+
170160
### How to generate the documentation at build time
171161

172162
#### With Gradle
@@ -190,3 +180,31 @@ from the given `apiDocsUrl` and store it in the `outputDir` and with the given `
190180

191181
If your application is unable to start up with the `bootRun` task, see if [customBootRun](https://github.com/springdoc/springdoc-openapi-gradle-plugin#customization)
192182
properties can help you.
183+
184+
## Release Notes / Migration Guide / Updating / Upgrading
185+
186+
Releases are managed in [GitHub Releases](https://github.com/springwolf/springwolf-core/releases),
187+
which feature noteworthy changes, the full changelog and notes on how to migrate.
188+
189+
Since each release has a git _tag_, the [Springwolf examples for each plugin](https://github.com/springwolf/springwolf-core/blob/master/springwolf-examples) showcase the use of Springwolf for any previous version.
190+
191+
### How to migrate from Springwolf 0.18.0 to 1.0.0
192+
193+
See [Release 1.0.0](https://github.com/springwolf/springwolf-core/releases/tag/v1.0.0).
194+
195+
### How to migrate from the deprecated `AsyncApiDocket` bean to Spring properties
196+
197+
See [Issue #445](https://github.com/springwolf/springwolf-core/issues/445).
198+
199+
### Is Spring Boot 2.X supported
200+
201+
You can use an older version of Springwolf, which is build to support Spring Boot 2.X.
202+
However, these versions don't get any updates.
203+
204+
Last versions to support Spring Boot 2.X:
205+
206+
- `springwolf-amqp:0.6.0`
207+
- `springwolf-cloud-stream:0.1.0`
208+
- `springwolf-core:0.6.0`
209+
- `springwolf-kafka:0.10.0`
210+
- `springwolf-ui:0.6.0`

docs/add-ons.mdx renamed to docs/introduction/add-ons.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 50
2+
sidebar_position: 20
33
---
44
import Tabs from '@theme/Tabs';
55
import TabItem from '@theme/TabItem';
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)