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

[MAINTENANCE] Improve documentation/usage of integration statuses #1545

Open
3 tasks
Swiddis opened this issue Mar 15, 2024 · 1 comment
Open
3 tasks

[MAINTENANCE] Improve documentation/usage of integration statuses #1545

Swiddis opened this issue Mar 15, 2024 · 1 comment
Labels
integrations Used to denote items related to the Integrations project maintenance

Comments

@Swiddis
Copy link
Collaborator

Swiddis commented Mar 15, 2024

Is your feature request related to a problem?
Coming from #1530, integration statuses aren't well-documented and also have some standing TODOs in code.

What solution would you like?
This is an issue to hit a couple tweaks:

  • Ideally, users should get information on a status if they hover over the badge
  • The status type should generally be an enum instead of a string -- refactor
  • Find a place to document the integration statuses and what they mean

What alternatives have you considered?
N/A

Do you have any additional context?
N/A

@Swiddis Swiddis self-assigned this Mar 15, 2024
@Swiddis Swiddis removed the untriaged label Mar 18, 2024
@Swiddis Swiddis added the integrations Used to denote items related to the Integrations project label May 1, 2024
@Swiddis
Copy link
Collaborator Author

Swiddis commented May 1, 2024

From the original plugin design doc, here's the intended meaning of the different statuses:

available The assets are available and functioning.
partially-available Some assets are available, but others may not be. Assets can be opened but may show errors.
unavailable The referenced assets are missing (possibly due to deletion).
corrupted If the integration is somehow in an inconsistent state. This may indicate a bug, but could also happen if a user manually changes some fields that should be constant in normal operation.
unknown IO error while querying for status.

@Swiddis Swiddis removed their assignment Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrations Used to denote items related to the Integrations project maintenance
Projects
None yet
Development

No branches or pull requests

1 participant