Skip to content

Commit f9b2613

Browse files
authored
docs: add link to release notes (springwolf#88)
Using multiple words so that users find this section when using the search.
1 parent 4a34639 commit f9b2613

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/configuration/documenting-bindings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ The Message Binding Object is used to describe the Google Cloud Pub/Sub PubsubMe
167167

168168
`OrderingKey`: If non-empty, identifies related messages for which publish order should be respected
169169

170-
`Schema Definition`: The Schema Definition Object is used to describe the Google Cloud Pub/Sub Schema Object with AsyncAPI. While some of this information could be, or is, described using native AsyncAPI, for consistency it makes sense to provide this information here at all times, especially for cases where AsyncAPI doesn't natively support describing payloads using a supported Google Cloud Pub/Sub schema format like Protobuf
170+
`Schema Definition`: The Schema Definition Object is used to describe the Google Cloud Pub/Sub Schema Object with AsyncAPI. While some of this information could be, or is, described using native AsyncAPI, for consistency it makes sense to always provide this information here, especially for cases where AsyncAPI doesn't natively support describing payloads using a supported Google Cloud Pub/Sub schema format like Protobuf
171171

172172
- name: The name of the schema
173173

docs/faq.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,13 @@ class ListWrapper extends ArrayList<String> {}
9898
public void sendMessage(ListWrapper<String> msg) {}
9999
```
100100

101+
## Release Notes / Migration Guide / Updating / Upgrading
102+
103+
Releases are managed in [GitHub Releases](https://github.com/springwolf/springwolf-core/releases),
104+
which feature noteworthy changes, the full changelog and notes on how to migrate.
105+
106+
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.
107+
101108
### How to migrate from Springwolf 0.18.0 to 1.0.0
102109

103110
See [Release 1.0.0](https://github.com/springwolf/springwolf-core/releases/tag/v1.0.0).

0 commit comments

Comments
 (0)