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

Add ClassifAI v3 migration guide #726

Merged
merged 8 commits into from
Feb 26, 2024
Merged

Add ClassifAI v3 migration guide #726

merged 8 commits into from
Feb 26, 2024

Conversation

iamdharmesh
Copy link
Member

@iamdharmesh iamdharmesh commented Feb 22, 2024

Description of the Change

PR adds v3 migration guide docs to help users to upgrade to classifAI v3.

Closes #674

How to test the Change

Changelog Entry

Added - Migration guide for upgrading from v2 to v3

Credits

Props @iamdharmesh

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@github-actions github-actions bot added this to the 3.0.0 milestone Feb 22, 2024
@dkotter
Copy link
Collaborator

dkotter commented Feb 22, 2024

@iamdharmesh I've made a handful of changes, most importantly I've added some snippets that show how a third-party developer could add new Features or Providers. In putting this together, I found a few issues with the way we register those that was preventing that from working, so that has been fixed in this PR as well.

@dkotter dkotter mentioned this pull request Feb 22, 2024
19 tasks
@iamdharmesh iamdharmesh changed the title [WIP] Add ClassifAI v3 migration guide Add ClassifAI v3 migration guide Feb 23, 2024
@iamdharmesh iamdharmesh marked this pull request as ready for review February 23, 2024 05:43
@iamdharmesh iamdharmesh requested review from jeffpaul and a team as code owners February 23, 2024 05:43
@github-actions github-actions bot added the needs:code-review This requires code review. label Feb 23, 2024
@iamdharmesh
Copy link
Member Author

Thanks for making changes @dkotter. All looks good to me. The table layout looks like this to me in Chrome browser, may need some CSS updates. is it same for you? Thank you.

image

@dkotter
Copy link
Collaborator

dkotter commented Feb 23, 2024

Thanks for making changes @dkotter. All looks good to me. The table layout looks like this to me in Chrome browser, may need some CSS updates. is it same for you? Thank you.

Yeah, I added overflow: scroll on the table cells because otherwise the table was overlapping the navigation menu on the right. I'm open to other suggestions on how best to handle this but personally I'm fine with the scrolling

@jeffpaul
Copy link
Member

Agreed, for now, that scrolling cell is acceptable for a dev docs site.

@dkotter dkotter merged commit aaf9e4a into develop Feb 26, 2024
15 checks passed
@dkotter dkotter deleted the v3-migration-guide branch February 26, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:code-review This requires code review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a v2-v3 migration guide
3 participants