Skip to content
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.

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

[DOC]: Add migration guide for YAMLs #338

Open
synchon opened this issue Apr 30, 2024 · 0 comments
Open

[DOC]: Add migration guide for YAMLs #338

synchon opened this issue Apr 30, 2024 · 0 comments

Comments

@synchon
Copy link
Member

synchon commented Apr 30, 2024

We have a strict deprecation cycle!

Gotta move fast 🏎️

Anyways, let's force users to adapt. Maybe we can add a "deprecation" section on the DOCs? So users can somehow know easily how to adapt their old YAMLs?

There is a dedicated section in the changelog docs. But after the examples are improved, should be straightforward for users to adapt.

The changelogs have the information, but my take is that this is not enough. For me it happens that I might start working on a version that it does not even warns a deprecation and then update to a one that already removed the feature or changed the api.

My idea was to create a "guide", that is starts like:

Updating your yamls from Junifer v0.0.3:

  • If you use a BoldWarper, then now you need to change it to this: (code)
  • If you call function X with parameter y then you need to do it like this: (code)

Updating your yamls from Junifer v0.0.4:
...

and so on.

So if you had a Yaml that worked in v0.0.3 and now we are at v0.0.5, then you follow the two steps and you are done.

Originally posted by @fraimondo in #336 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant