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 support for navigating the taxonomy path through input box #85

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

vishnoianil
Copy link
Member

@vishnoianil vishnoianil commented Jul 23, 2024

This PR adds support for navigating the taxonomy tree for skill and knowledge contribution through the form's input box itself. User don't have to leave the skill or knowledge form to navigate through the taxonomy github repo to determine the path where they can place the skill or knowledge.

Fixes #89

@vishnoianil vishnoianil force-pushed the nav-path branch 6 times, most recently from e19ee5b to 74c4f1e Compare July 24, 2024 08:02
@vishnoianil vishnoianil marked this pull request as ready for review July 24, 2024 08:03
@vishnoianil vishnoianil force-pushed the nav-path branch 3 times, most recently from b222f7c to 479841d Compare July 24, 2024 09:02
@@ -10,6 +10,8 @@ env:
GHCR_UI_IMAGE_NAME: ${{ github.repository }}/ui
QUAY_REGISTRY: quay.io
QUAY_UI_IMAGE_NAME: instructlab-ui/ui
GHCR_PATHSERVICE_IMAGE_NAME: ${{ github.repository }}/pathservice
Copy link
Member

Choose a reason for hiding this comment

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

If I understand the functionality properly. This service provides people with the directory structure of the taxonomy so they can identify where there new contribution sits. I am not sure pathservice is the best description of this? taxonomy-descripion-service?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it's basically provides you a list of first level directories within given directory in taxonomy repo. Which will be used by the pathservice ui component to provide the navigation feature. Naming is hard. This service helps user to find the path where they can place their files, hence the pathservice. Not sure if taxonomy-description-service fits the intent as well. But i am open to any name that makes sense.

Copy link
Member

Choose a reason for hiding this comment

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

Yeh see what you mean. Maybe taxonomy-path-service?

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, that's what i started with, but taxonomy is repo name, and it might change, so didn't bind the name with it.

@aevo98765
Copy link
Member

I think there would be a strong argument for this service sitting outside of the UI. Could/should this be it's own repo within the InstructLab organisation?

@vishnoianil
Copy link
Member Author

I think there would be a strong argument for this service sitting outside of the UI. Could/should this be it's own repo within the InstructLab organisation?

This is a backend component for the UI service, so in my opinion it makes sense for it to be part of UI project. Also I don't see any other project in instructlab that would like to consume this service at this point of time. If we see interest from outside of the UI project, i think it would be good to explore how best we can expose it as a full fledge service with stable APIs.

skill and knowledge contribution.

This introduces a new service named pathservice.
This service returns the first level directories
in a specific directory in the tree.

This commit also implements
- Manifest file to deploy the service
- Github jobs to publish the image for the new service
- Makefile target to deploy the entire stack locally on
your machine.
- Dev doc updates with the instruction on the entire
UI stack can be deployed on local machine as well as
on kind cluster.

Signed-off-by: Anil Vishnoi <vishnoianil@gmail.com>
Copy link
Member

@aevo98765 aevo98765 left a comment

Choose a reason for hiding this comment

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

LGTM

@aevo98765 aevo98765 merged commit a9ea6ce into instructlab:main Jul 31, 2024
5 checks passed
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.

Enhance file path to navigate through the taxonomy tree for skill and knowledge
2 participants