Update design for Create Knowledge Contribution wizard

[Misjohns]

To improve the contribution experience, UXD recommends dividing the contribution form into wizard steps. The current contribution task is long and complex and would benefit from being broken into smaller, more manageable steps. This allows the user to focus on smaller tasks and not feel overwhelmed and allows us to provide more detailed instructions and tailored contextual help.

UXD is working with the content team to finalize the microcopy. Another issue will be created to capture those changes.

The initial step is to select which contribution type the user wants to submit: Knowledge or Skill. Clicking the card kicks off the appropriate wizard flow, loading the appropriate fields and sections for input.

Step 1: Details

The user details should be pulled in from Git if possible. The user can add contributors. Once the wizard is submitted, the newly added contributor(s) will receive a notification. The Submission summary should include a brief description of the purpose of this contribution. The Directory path determines the domain/subdomain in the taxonomy this contribution will appear.

Step 2: Resource documents

Sub-step 2a: Upload documents
The next step in the process is to add the resource documents that contain the facts, data, or references used to answer questions asked of the model. Users can upload documents, such as textbook, technical manual, encyclopedia, journal, or magazine in the supported formats.

The user has the option to directly upload files by dragging and dropping them into the specified drop zone area or manually uploading files from a git repo or from your computer by clicking one of the buttons inside the drop zone. Clicking on the Upload from device button prompts a file selector dialog to open. Once users select 1 or more files from the dialog, the files will populate below the drop zone on the page. The file(s) may display a loading state before uploading is completed.

Clicking on the Upload from git repository button opens a modal for the user to enter in their information.

The system should display loading states-waiting, in progress, and uploaded, as well as validate the file and provide clear guidance to help the user resolve any error state.

Sub-step 2b: Attribution details
We are hoping most of the attribution details could be pulled in during the document ingestion process. A warning icon alerts the user of something that needs their attention.

Users can click edit to modify the details.

Step 3: Create training data

Sub-step 3a: Create context
To enter a context, the user selects the resource document and copy/paste the excerpt into the context field. The system validates that the context can be found in the document and that it meets the requirements. As they add each context, the UI displays their progress. The Next button will remain disabled until the required number of contexts have been entered.

Sub-step 3b: Create Q&A pairs
The user fills out 3 question and answer pairs for each selected context. The Next button is enabled once the user has entered all the required question and answer pairs.

Step 4: Review

The last step in the wizard includes a summary of what the user has input so they may confirm them before submitting their contribution. Clicking Submit sends a notification to the InstructLab triager to review the submission.

The user lands on their Dashboard view where they receive a toast alert to inform them that their submission was received. The new submission appears at the top of their submission list view showing a Pending status.

In-app documentation

The user can access in-app documentation to learn more about relevant topics. In-app documentation is displayed in a side panel and contains content for product-specific terms or topics and an optional list of links to provide the user with other relevant information. In this sample, the user clicked "Learn about Creative Commons licenses" to launch the article.

[Misjohns]

Iterated the add contributor flow based on user feedback

Add contributor modal

Clicking on Add contributor button on Details step would open this dialog

• User should be able to add multiple contributors and select their permission level.
• Clicking Save would return the user to the Details step with the newly added contributor.
• User should be able to remove the added contributor(s) from the details view.