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

Introduce Finished state for Explorative Annotations? #5087

Closed
fm3 opened this issue Jan 26, 2021 · 3 comments · Fixed by #7801
Closed

Introduce Finished state for Explorative Annotations? #5087

fm3 opened this issue Jan 26, 2021 · 3 comments · Fixed by #7801
Assignees

Comments

@fm3
Copy link
Member

fm3 commented Jan 26, 2021

When publishing annotations, you do not want to accidentally edit them again later.

The current Finished state is really "Archived". We should rename it to make this distinction. The new "Finished" state should make it read-only, but it should still be in the normal annotation list.

@philippotto
Copy link
Member

From our discussion:

  • (potentially, rename "finished" state to "archived". however, maybe we can also keep it as is. especially, since "archived" wouldn't be a perfect fit for tasks.)
  • add a "lockedByUser" (naming up for debate) property to the annotation object. only the owner should be able to mutate this.
  • update actions for layers of an annotation will be rejected if lockedByUser is true
  • the front-end should show locked annotations as "read-only" in the dashboard (look into how other read-only annotations are rendered)
  • a tooltip should explain the reason
  • opening an annotation that is read-only, should render as such with an explanation
  • for the owner, the possibility to change read-only could be:
    • everywhere where "read-only" is rendered (e.g., in a popover)
    • for not locked annotations, the dropdown menu in the annotation view should allow to do the locking

Two questions I just had:

  • Can an annotation layer be referenced by multiple annotations? If so: What happens if one annotation is locked, and the other annotation is mutated that references the same layer? Ideally, this should not be allowed.
  • Changing the metadata of an annotation should still be allowed, even when the annotation is locked, right? Otherwise, one wouldn't be able to unlock it. Or should the locked property be the only exception for that? If all meta data can be edited, the UI should explain well that the locking only refers to the actual content of the annotation.

@fm3
Copy link
Member Author

fm3 commented Mar 11, 2024

Can an annotation layer be referenced by multiple annotations?

Please don’t do that :D (With the current data model, you can’t, since it’s actually the annotation layer that references exactly one annotation)

Changing the metadata of an annotation should still be allowed, even when the annotation is locked, right? Otherwise, one wouldn't be able to unlock it. Or should the locked property be the only exception for that? If all meta data can be edited, the UI should explain well that the locking only refers to the actual content of the annotation.

Good question, I have no strong preference here. Maybe the locked boolean should really be the only thing, that would certainly be easier to explain to users.

@MichaelBuessemeyer
Copy link
Contributor

Good question, I have no strong preference here. Maybe the locked boolean should really be the only thing, that would certainly be easier to explain to users.

I think that is a good approach. In case some metadata needs to be edited, the owner can unlock it, change the metadata settings as wanted, and then lock it again

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

Successfully merging a pull request may close this issue.

3 participants