diff --git a/.changeset/start_clijs_deprecation.md b/.changeset/start_clijs_deprecation.md new file mode 100644 index 000000000..bb89b341c --- /dev/null +++ b/.changeset/start_clijs_deprecation.md @@ -0,0 +1,7 @@ +--- +"@asyncapi/generator": minor +--- + +Start deprecating `ag` in the generator repository. The purpose of deprecating the `ag` option for documentation generation is to move people's +attention to use the `AsyncAPI CLI` in order to maintain a single entry point for all the AsyncAPI tools. +Otherwise, the maintainers need to manually update the `ag` option in the generator repository every time a new version of the `AsyncAPI CLI` is released. diff --git a/README.md b/README.md index 5fe3c6018..90ef6f18f 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ This is a Monorepo managed using [Turborepo](https://turbo.build/) and contains ![npm](https://img.shields.io/npm/v/@asyncapi/generator?style=for-the-badge) ![npm](https://img.shields.io/npm/dt/@asyncapi/generator?style=for-the-badge) -> warning: This package doesn't support AsyncAPI 1.x anymore. We recommend to upgrade to the latest AsyncAPI version using the [AsyncAPI converter](https://github.com/asyncapi/converter-js) (You can refer to [installation guide](/apps/generator//docs//installation-guide.md)). If you need to convert documents on the fly, you may use the [Node.js](https://github.com/asyncapi/converter-js) or [Go](https://github.com/asyncapi/converter-go) converters. +[!IMPORTANT] +Deprecation Notice: The use of ag for documentation generation is deprecated and will be removed in future releases. We strongly encourage migrating to the new AsyncAPI CLI. diff --git a/apps/generator/docs/deprecate-cli.js-ag.md b/apps/generator/docs/deprecate-cli.js-ag.md new file mode 100644 index 000000000..9a7244291 --- /dev/null +++ b/apps/generator/docs/deprecate-cli.js-ag.md @@ -0,0 +1,79 @@ +--- +title: "Deprecate ag" +weight: 170 +--- + +# Migration Guide from “ag/asyncapi-generator” to AsyncAPI CLI + +## Overview +With the introduction of the AsyncAPI CLI, the use of `ag` for documentation generation in the AsyncAPI generator repository is being deprecated. This guide provides detailed instructions on how to transition from `ag` to the new AsyncAPI CLI. + +## Why Migrate? +- **Enhanced Features:** The AsyncAPI CLI offers advanced features and improvements. +- **Consistency:** Ensures consistent command usage across different environments. +- **Support and Maintenance:** Future updates and support will focus on the AsyncAPI CLI. + +## Deprecated `ag/asyncapi-generator` Options and Their AsyncAPI CLI Equivalents +Here is a list of `ag/asyncapi-generator` options and their equivalents in the AsyncAPI CLI: + +- **-d, --disable-hook [hooks...]** + - **AsyncAPI CLI equivalent:** `asyncapi generate fromTemplate