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

Enforce knowledge schema constraints in the UI #138

Merged
merged 1 commit into from
Aug 30, 2024

Conversation

vishnoianil
Copy link
Member

@vishnoianil vishnoianil commented Aug 28, 2024

Knowledge v3 schema has following contraints
. The yaml file must include a minimum of 5 context fields, each with 3 Q&A pairs relating to the context
. Length constraints:
500 words for context
250 words for Q&A pairs
750 total
. Document_outline is a new field that replaces task_description. It should describe the information noting specifics from each context hunk.

Commit also adds delete button to delete the whole seed example.

Fixes #93
Fixes #120

@vishnoianil vishnoianil requested a review from nerdalert August 28, 2024 09:23
@vishnoianil
Copy link
Member Author

Few snapshot with this PR
Screenshot 2024-08-28 at 2 24 37 AM
Screenshot 2024-08-28 at 2 24 59 AM
Screenshot 2024-08-28 at 2 26 11 AM
Screenshot 2024-08-28 at 2 26 38 AM
Screenshot 2024-08-28 at 2 27 16 AM

@vishnoianil vishnoianil changed the title Enforce knowledge schema constraints in the UI Hold:Enforce knowledge schema constraints in the UI Aug 29, 2024
@vishnoianil vishnoianil force-pushed the knowledge-constraints branch 3 times, most recently from 1280c88 to eaa071d Compare August 29, 2024 21:35
Knowledge v3 schema has following contraints
*.* The yaml file must include a minimum of 5 context fields,
each with 3 Q&A pairs relating to the context
*.* Length constraints:
500 words for context
250 words for Q&A pairs
750 total
*.* Document_outline is a new field that replaces task_description.
It should describe the information noting specifics from each context hunk.
*.* Mark all the mandatory field with red asterisk
*.* Add breadcrum navigation to the knowledge page
*.* Add title to the Knowledge contribution page.
*.* Add delete button to delete the whole seed example.
*.* Add validation for each knowledge input
*.* Don't allow to delete mandatory seedexamples as well as minimum Q&A
pairs.
*.* Optional seed examples and Q&A pairs are allowed to delete
*.* Disable submit/download buttons till all the required fields in the
form is submitted.

Signed-off-by: Anil Vishnoi <[email protected]>
@vishnoianil vishnoianil force-pushed the knowledge-constraints branch from eaa071d to ac8bf08 Compare August 30, 2024 09:47
@vishnoianil vishnoianil changed the title Hold:Enforce knowledge schema constraints in the UI Enforce knowledge schema constraints in the UI Aug 30, 2024
@nerdalert nerdalert merged commit 9f70518 into instructlab:main Aug 30, 2024
5 checks passed
@vishnoianil vishnoianil deleted the knowledge-constraints branch September 5, 2024 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants