Skip to content

docs: add documents and postinstallation scripts for ag deprecation #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

docs: add documents and postinstallation scripts for ag deprecation #1251

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3b2002a
add postinstall.js and a deprecation markdown
lmgyuan Aug 10, 2024
d5402c8
update homepage ReadMe
lmgyuan Aug 10, 2024
ef5e6b4
Create start_clijs_deprecation.md
lmgyuan Aug 10, 2024
709b694
Merge branch 'master' into cli.js-deprecation
Florence-Njeri Aug 26, 2024
3a8f015
Merge branch 'master' into cli.js-deprecation
Florence-Njeri Sep 9, 2024
e063238
update PR
lmgyuan Sep 16, 2024
6ab60db
Update postinstall.js
lmgyuan Sep 16, 2024
9e7f010
Merge branch 'master' into cli.js-deprecation
Florence-Njeri Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update homepage ReadMe
  • Loading branch information
@lmgyuan
lmgyuan committed Aug 10, 2024
commit d5402c8fed7d4c74af8225dc7984fd4ff7d7202e
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ This is a Monorepo managed using [Turborepo](https://turbo.build/) and contains

> 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.

> **Deprecation Notice**: The use of `cli.js` for documentation generation is deprecated and will be removed in future releases. We strongly encourage migrating to the new AsyncAPI CLI. The migration process is straightforward, and you can find the necessary steps in our [migration guide](/apps/generator/docs/deprecate-cli.sj-ag.md). Please ensure that your projects are updated accordingly to avoid any disruptions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remember that users do not understand waht cli.js is, only maintainers. This notice is for users and they only know that cli is ag or asyncapi-generator

also please use one of GH supported markdown alerts -> https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts. Probably warning is what we need.

and last but no least:

  • link /apps/generator/docs/deprecate-cli.sj-ag.md transform to a link pointing to https://asyncapi.com/docs/tools/generator/cli-deprecation - yes, link is 404 but will not be after we merge this PR. Of course you need to renamedeprecate-cli.sj-ag.md file to cli-deprecation.md
  • please provide precise information to this note that removal of functionality will be done in September 2025

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the GH supported markdown alerts, do you mean this?
Screenshot 2024-09-16 at 2 26 27 PM



<!-- toc is generated with GitHub Actions do not remove toc markers -->

<!-- toc -->
Expand Down