From f9b2613f4ca493ed15692d1aa07998a82dbd28bd Mon Sep 17 00:00:00 2001 From: Timon Back Date: Fri, 21 Jun 2024 15:55:08 +0200 Subject: [PATCH] docs: add link to release notes (#88) Using multiple words so that users find this section when using the search. --- docs/configuration/documenting-bindings.md | 2 +- docs/faq.md | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/configuration/documenting-bindings.md b/docs/configuration/documenting-bindings.md index 78a54e0..6d729f7 100644 --- a/docs/configuration/documenting-bindings.md +++ b/docs/configuration/documenting-bindings.md @@ -167,7 +167,7 @@ The Message Binding Object is used to describe the Google Cloud Pub/Sub PubsubMe `OrderingKey`: If non-empty, identifies related messages for which publish order should be respected -`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 +`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 - name: The name of the schema diff --git a/docs/faq.md b/docs/faq.md index de7fac0..83d801a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -98,6 +98,13 @@ class ListWrapper extends ArrayList {} public void sendMessage(ListWrapper msg) {} ``` +## Release Notes / Migration Guide / Updating / Upgrading + +Releases are managed in [GitHub Releases](https://github.com/springwolf/springwolf-core/releases), +which feature noteworthy changes, the full changelog and notes on how to migrate. + +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. + ### How to migrate from Springwolf 0.18.0 to 1.0.0 See [Release 1.0.0](https://github.com/springwolf/springwolf-core/releases/tag/v1.0.0).