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

docs: add migration guide from 0.12 to bonsai #4007

Merged
merged 5 commits into from
Mar 28, 2023
Merged

Conversation

Walther
Copy link
Contributor

@Walther Walther commented Mar 28, 2023

This adds a rudimentary migration guide from 0.12 to Bonsai.

This is a bit of a minimum viable tutorial for pre-release purposes only. We should replace this with better documentation and a blog post later on.

Squash before merging to clean up the history.

Copy link
Collaborator

@vvagaytsev vvagaytsev left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

Very good initial version! Let's apply further improvements on top of it.
I've let a couple of comments, feel free to address/discuss :)

Copy link
Contributor

@Orzelius Orzelius left a comment

Choose a reason for hiding this comment

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

I think the following is worth mentioning:

  • Where is the reference documentation for actions
  • Modules can't depend on actions
  • Modules can't reference actions
  • Actions can reference and depend on modules, by referencing the actions that are generated from modules
  • Converting your project to the actions config can be performed gradually by starting from the end of the dependency tree

I think adding this resolution flow might make it more understandable:

  1. modules are resolved
  2. modules are converted to actions
  3. actions are resolved

docs/tutorials/migrating-to-bonsai.md Outdated Show resolved Hide resolved
@vvagaytsev
Copy link
Collaborator

Should we also include #3512 in the breaking changes list?

@Walther Walther requested review from vvagaytsev and Orzelius March 28, 2023 11:12
Copy link
Collaborator

@vvagaytsev vvagaytsev left a comment

Choose a reason for hiding this comment

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

Great job, thanks! 🚀

@Walther Walther merged commit fd22084 into 0.13 Mar 28, 2023
@Walther Walther deleted the migrating-to-bonsai branch March 28, 2023 11:28
This was referenced May 11, 2023
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

Successfully merging this pull request may close these issues.

3 participants