search

asyncapi / generator

Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
https://asyncapi.com/docs/tools/generator
Apache License 2.0
767 stars 232 forks source link

Deprecate Nunjucks and Create Migration Guide to React #1255

Open Gmin2 opened 3 months ago

Gmin2 commented 3 months ago

We're planning to depreciate Nunjucks in favor of React for our templating system. This issue is to create a comprehensive migration guide and outline our deprecation process.

  1. Migration Guide:

    • A detailed guide is created in #1253 to help users transition from Nunjucks to React.

  2. Gradual Deprecation:

    • We'll start by adding deprecation warnings to all Nunjucks-related features.
    • Each Nunjucks feature will be marked for removal in future versions.
    • The timeline for removing each feature is mentioned below.

  3. React Alternatives:

    • For each deprecated Nunjucks feature, we have provided a React-based alternative in the migration guide.
    • Examples is included in the guide to show how to achieve the same results with React.

  4. Documentation Updates:

    • All mentions of Nunjucks in our docs will be updated to reference the deprecation.

  5. User Communication:

    • We'll encourage users to start migrating their templates and provide feedback.

  6. Timeline:

    • Deprecation warnings added: []
    • Begin removing Nunjucks features: []
    • Complete removal of Nunjucks support: []
derberg commented 2 months ago

We'll start by adding deprecation warnings to all Nunjucks-related features

what do you mean? in case of cli.js it is easy as we will drop a message in cli, but in case of nunjucks features?

Each Nunjucks feature will be marked for removal in future versions.

what is your proposal on how to do that?

Timeline

I'm guessing timeline is the same as for CLI deprecation? 1.09?

toffee-k21 commented 2 months ago

I like this idea. I want to take part and contribute to this transition, please tell me that I have to do it in only one single PR ?

Gmin2 commented 2 months ago

I like this idea. I want to take part and contribute to this transition, please tell me that I have to do it in only one single PR ?

Hey @toffee-k21, there is nothing need to be done here accept for depreciation notice, you can look up to some other issues