Skip to content

[PLT-1201] Deprecate Project setup_editor and add Project connect_ontology #1713

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

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

vbrodsky
Copy link
Contributor

@vbrodsky vbrodsky commented Jul 5, 2024

Deprecate Project setup

Description

This story is part of the project sunset-custom-editor. It refactors Project setup and setup_editor methods to prevent users from injecting their own custom editors. Instead we will use or connect a default editor for all projects

  • setup_editor now has a deprecated note, we replace it with connect_ontology which is essentially what this method will be doing now
  • setup will only allow to create ontology, but instead of adding a labeling front end, it will create a default labeling front end if one is missing

This is inline with https://docs.google.com/document/d/1ME1EzyyMtX0viTr4F8LGA_hnAAPu7oZK1qCT3Q7RljA - the Python SDK section

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Document change (fix typo or modifying any markdown files, code comments or anything in the examples folder only)

All Submissions

  • Have you followed the guidelines in our Contributing document?
  • Have you provided a description?
  • Are your changes properly formatted?

New Feature Submissions

  • Does your submission pass tests?
  • Have you added thorough tests for your new feature?
  • Have you commented your code, particularly in hard-to-understand areas?
  • Have you added a Docstring?

Changes to Core Features

  • Have you written new tests for your core changes, as applicable?
  • Have you successfully run tests with your changes locally?
  • Have you updated any code comments, as applicable?

@vbrodsky vbrodsky requested a review from a team as a code owner July 5, 2024 17:29
@vbrodsky vbrodsky marked this pull request as draft July 5, 2024 17:29
@vbrodsky vbrodsky force-pushed the VB/remove-custom-editor_PLT-1201 branch 2 times, most recently from e389eca to f468aa0 Compare July 5, 2024 17:35
@vbrodsky vbrodsky marked this pull request as ready for review July 8, 2024 15:48
@@ -645,7 +646,8 @@ def configured_project(client, initial_dataset, ontology, rand_gen, image_url):

project.delete()

#TODO: Switch to setup_editor, setup might get removed in later releases

#TODO: Switch to connect_ontology, setup might get removed in later releases
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we have a tech debt ticket for these todos and put it in the comment?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vbrodsky vbrodsky merged commit 700f58e into develop Jul 8, 2024
17 of 22 checks passed
@vbrodsky vbrodsky deleted the VB/remove-custom-editor_PLT-1201 branch July 8, 2024 17:15
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.

2 participants