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

Migration Doc Revision: Getting a Nautobot App v2.0 Ready #3387

Closed
HanlinMiao opened this issue Mar 2, 2023 · 2 comments · Fixed by #4156
Closed

Migration Doc Revision: Getting a Nautobot App v2.0 Ready #3387

HanlinMiao opened this issue Mar 2, 2023 · 2 comments · Fixed by #4156
Assignees
Labels
type: documentation Improvements or additions to documentation type: housekeeping Changes to the application which do not directly impact the end user
Milestone

Comments

@HanlinMiao
Copy link
Contributor

Proposed Changes

We should add a guide as a part of our migration docs to teach users how to upgrade their Nautobot Apps (how to squash migrations and etc) so that they can be installed correctly in a Nautobot V2.0 environment.

Justification

There are many existing Nautobot apps out there that rely on v1.X Nautobot Core models (Site, Region, Aggregate...). Some of these core models are removed in 2.0.0 and their information is only retained and transferred by correct migrations. We need to publish a guide to allow Nautobot App developers to upgrade their apps to be v2.0 compatible.

@HanlinMiao HanlinMiao added type: documentation Improvements or additions to documentation type: housekeeping Changes to the application which do not directly impact the end user labels Mar 2, 2023
@HanlinMiao HanlinMiao added this to the v2.0.0 milestone Mar 2, 2023
@bryanculver bryanculver changed the title Migration Doc Revision: Install a Nautobot app in v2.0 environment Migration Doc Revision: Getting a Nautobot App v2.0 Ready May 17, 2023
@bryanculver
Copy link
Member

bryanculver commented Jun 12, 2023

A Core team member should work with an app maintainer and document anything that is missing in our current documentation around migrating those apps. This will be done once we ship an RC for apps to be able to start migrating against but deliverable before 2.0.0.

Plan is to reserve a full sprint of time for the core team member to be working with the app maintainer.

@glennmatthews
Copy link
Contributor

Would be good to look at current app PRs for 2.0 to see what changes they've had to make and make sure they're documented appropriately as necessary tasks:

@HanlinMiao HanlinMiao linked a pull request Jul 25, 2023 that will close this issue
7 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation type: housekeeping Changes to the application which do not directly impact the end user
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants