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

Inconsistency in ui, docs and python ui_server #3497

Closed
bjakubowskiVNSNY opened this issue Feb 15, 2023 · 1 comment
Closed

Inconsistency in ui, docs and python ui_server #3497

bjakubowskiVNSNY opened this issue Feb 15, 2023 · 1 comment
Labels
kind/bug priority/p2 wontfix This will not be worked on

Comments

@bjakubowskiVNSNY
Copy link

Expected Behavior

I would expect that the react app, python server, and docs are consistent in how they implement or (for the docs) describe how the registry is ingested.

Current Behavior

Right now:

  1. Docs: The docs suggest that the UI loads a JSON dump of the registry
  2. Python App: The python app appears to use get_registry_dump to produce a JSON dump of the registry, but get_registry_dump is never called. Instead the UI fetches the registry_proto from /registry (see here and here).
  3. UI: useLoadRegistry looks like it used to parse json -- as in feat: Initial merge of Web UI logic #2352 -- but then chore: Replace zod by protobufjs #3208 replaced the json with the protobuf registry

Steps to reproduce

NA

Specifications

  • Version: main

Possible Solution

If the intent of #3208 was to replace the json registry with the protobuf version, then the solution would be to:

  1. Update the docs to make this clear
  2. Update the python ui_server so it doesn't appear to produce the JSON dump via get_registry_dump

Of these solutions, the first (updating docs) is probably the most valuable to the community.

@stale
Copy link

stale bot commented Aug 10, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Aug 10, 2023
@stale stale bot closed this as completed Sep 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug priority/p2 wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant