Graduate UI native mode (github detached mode) to stable feature. #412

vishnoianil · 2024-12-12T06:33:57Z

This PR addresses :

Refactor the code and move the experimental dashboard/knowledge/skill components of the native mode parallel to the github dashboard/knowledge/skill components.
Dev mode features (such as form auto fill) are now enabled using IL_ENABLE_DEV_MODE=true.
IL_UI_DEPLOYMENT flag is repurposed to define the deployment mode of the ui stack. It supports two values - github and native.
Based on the DEPLOYMENT type user set, UI will load the related dashboard, knowledge and skill forms.
Repository cloning page is removed. Native mode has it's own local taxonomy repository, where it maintains all the user contribution. UI will provide an option to publish these contribution to any other taxonomy if they want to test these contributions. This allows UI stack to have total control over it's own taxonomy instance and minimize the modification it needs to do the main taxonomy repo (for testing, merging contributions).
Updated the docs to provide details about native mode.
Enable feature to delete, and publish the contribution
Enable knowledge doc upload feature for the native mode
Update the github knowledge page to wizard based form.

Fixes #335
Fixes #325

*.* Refactor the code and move the experimental dashboard/knowledge/skill components of the native mode parallel to the github dashboard/knowledge/skill components. *.* Dev mode features (such as form auto fill) are now enabled using IL_ENABLE_DEV_MODE=true. *.* IL_UI_DEPLOYMENT flag is repurposed to define the deploment mode of the ui stack. It supports two values - github and native. *.* Based on the DEPLOYMENT type user set, UI will load the related dashboard, knowledge and skill forms. *.* Repository cloning page is removed. Native mode has it's own local taxonomy repository, where it maintains all the user contribution. UI will provide an option to publish these contribution to any other taxonomy if they want to test these contributions. This allows UI stack to have total control over it's own taxonomy instance and minimize the modification it needs to do the main taxonomy repo (for testing, merging contributions). *.* Updated the docs to provide details about native mode. Signed-off-by: Anil Vishnoi <[email protected]>

Signed-off-by: Anil Vishnoi <[email protected]>

In Native mode, taxonomy-knowledge-docs repo is cloned in the $HOME/.instructlab-ui/ directory and the docs are committed to the main branch. Commit sha of that branch is used in the knowledge contribution. In knowledge yaml, document url points to the filepath location of the taxonomy-knowledge-docs. Signed-off-by: Anil Vishnoi <[email protected]>

Signed-off-by: Anil Vishnoi <[email protected]>

If user deploy UI in github mode, login page shows on github login option If user deploy UI in native mode, login page shows only user/pass If user enable the dev mode, it shows both the options to login. Signed-off-by: Anil Vishnoi <[email protected]>

vishnoianil · 2024-12-12T21:14:15Z

@nerdalert Tested following scenario for the patch and works fine.

Github mode:

Creating, editing skill and knowledge contribution
Yaml and attribution download and view features

Native mode:

Creation, publishing and deleting of skill and knowledge contribution
Yaml and attribution download and view features
Show change feature

Chat feature works fine in both the scenarios.

Signed-off-by: Anil Vishnoi <[email protected]>

nerdalert · 2024-12-12T21:34:06Z

@vishnoianil fixup lint and will merge 🎉

Gregory-Pereira

Just some small things I found, awesome job

Gregory-Pereira · 2024-12-12T21:00:59Z

docs/development.md


-Set the .env in the ui directory and make sure you uncomment the `IL_UI_DEPLOYMENT=dev`. Once .env file is setup, run the following:
+To enable the native mode, set the `IL_UI_DEPLOYMENT=native` in the .env file. Once the flag is set, the UI will not push the knowledge and skill contribution to the github repository. Instead, it will keep the contribution in the local machine. In the `native` mode, the UI login page will show username and password input box to authenticate the user. You can setup the username and password in the .env file through the `IL_UI_ADMIN_USERNAME` and `IL_UI_ADMIN_USERNAME` flags.


Suggested change

To enable the native mode, set the `IL_UI_DEPLOYMENT=native` in the .env file. Once the flag is set, the UI will not push the knowledge and skill contribution to the github repository. Instead, it will keep the contribution in the local machine. In the `native` mode, the UI login page will show username and password input box to authenticate the user. You can setup the username and password in the .env file through the `IL_UI_ADMIN_USERNAME` and `IL_UI_ADMIN_USERNAME` flags.

To enable the native mode, set the `IL_UI_DEPLOYMENT=native` in the .env file. Once the flag is set, the UI will not push the knowledge and skill contribution to the github repository. Instead, it will keep the contribution in the local machine. In the `native` mode, the UI login page will show username and password input box to authenticate the user. You can setup the username and password in the .env file through the `IL_UI_ADMIN_USERNAME` and `IL_UI_ADMIN_PASSWORD` flags.

@Gregory-Pereira thanks for catching this, will fix it in follow-up PR.

Gregory-Pereira · 2024-12-12T21:11:28Z

src/app/api/native/git/branches/route.ts

+
+async function handleDelete(branchName: string, localTaxonomyDir: string) {
+  try {
+    if (!branchName || branchName === 'main') {


Should we also check against other protected branches? Since im not sure if we care about this I will not repeat the comment for every instance in the file, but there are multiple

UI workflows are triggered from the contributions, and all the contributions are created using it's own branch. Ideally branchName === 'main' condition should not even hit in UI case, so we can even remove this check, but kept it as a guardrails. In local taxonomy, main is the only protected branch at this point of time.

vishnoianil force-pushed the knowledge-docs branch from 057b84a to 4f5189d Compare December 12, 2024 06:35

vishnoianil added 2 commits December 11, 2024 22:45

Add feature to delete, and publish the contribution

d71c733

Signed-off-by: Anil Vishnoi <[email protected]>

vishnoianil force-pushed the knowledge-docs branch 4 times, most recently from 989e381 to 1bf55ca Compare December 12, 2024 10:09

vishnoianil force-pushed the knowledge-docs branch from 1bf55ca to 1f29e5f Compare December 12, 2024 10:09

vishnoianil requested review from nerdalert and Gregory-Pereira December 12, 2024 17:23

vishnoianil force-pushed the knowledge-docs branch from fb7f9c2 to f5ead4a Compare December 12, 2024 19:37

Updated github knowledge form to wizard based form.

101419c

Signed-off-by: Anil Vishnoi <[email protected]>

vishnoianil force-pushed the knowledge-docs branch from f5ead4a to 101419c Compare December 12, 2024 19:40

Bug fixes encountered during testing of this patch

bb0cfd6

Signed-off-by: Anil Vishnoi <[email protected]>

vishnoianil force-pushed the knowledge-docs branch from 30b8a3a to bb0cfd6 Compare December 12, 2024 21:34

vishnoianil marked this pull request as ready for review December 12, 2024 21:35

nerdalert merged commit c4be474 into instructlab:main Dec 12, 2024
6 checks passed

Gregory-Pereira reviewed Dec 12, 2024

View reviewed changes

This was referenced Dec 17, 2024

Local Taxonomy features to the current experimental feature #335

Closed

Determine how to handle knowledge file submissions in local git mode #325

Closed

Define the deployment pieces required for a local deployment #223

Closed

Decouple from GitHub #106

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Graduate UI native mode (github detached mode) to stable feature. #412

Graduate UI native mode (github detached mode) to stable feature. #412

vishnoianil commented Dec 12, 2024 •

edited

Loading

vishnoianil commented Dec 12, 2024

nerdalert commented Dec 12, 2024

Gregory-Pereira left a comment

Gregory-Pereira Dec 12, 2024

vishnoianil Dec 12, 2024

Gregory-Pereira Dec 12, 2024

vishnoianil Dec 12, 2024


		Set the .env in the ui directory and make sure you uncomment the `IL_UI_DEPLOYMENT=dev`. Once .env file is setup, run the following:
		To enable the native mode, set the `IL_UI_DEPLOYMENT=native` in the .env file. Once the flag is set, the UI will not push the knowledge and skill contribution to the github repository. Instead, it will keep the contribution in the local machine. In the `native` mode, the UI login page will show username and password input box to authenticate the user. You can setup the username and password in the .env file through the `IL_UI_ADMIN_USERNAME` and `IL_UI_ADMIN_USERNAME` flags.

Graduate UI native mode (github detached mode) to stable feature. #412

Graduate UI native mode (github detached mode) to stable feature. #412

Conversation

vishnoianil commented Dec 12, 2024 • edited Loading

vishnoianil commented Dec 12, 2024

nerdalert commented Dec 12, 2024

Gregory-Pereira left a comment

Choose a reason for hiding this comment

Gregory-Pereira Dec 12, 2024

Choose a reason for hiding this comment

vishnoianil Dec 12, 2024

Choose a reason for hiding this comment

Gregory-Pereira Dec 12, 2024

Choose a reason for hiding this comment

vishnoianil Dec 12, 2024

Choose a reason for hiding this comment

vishnoianil commented Dec 12, 2024 •

edited

Loading