Skip to content

Improve the attribution experience and clarify requirements for InstructLab UI #637

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

Open
Misjohns opened this issue Mar 4, 2025 · 0 comments
Labels
UX Related to the user experience
Milestone

Comments

@Misjohns
Copy link
Collaborator

Misjohns commented Mar 4, 2025

Summary of issue

It's not clear what a user needs to include in the attribution file for contributing to the upstream InstructLab taxonomy. The samples captured in the documentation only show an attribution for a single document. Since we support the ability for the user to upload multiple documents we need to collect the attribution details for each document to ensure all sources are appropriately being cited. Most documents include data for authors, publication, copyright, etc. that can be used to generate the attribution.

In the current implementation of the UI, the following fields display for each uploaded document. If a user uploads many documents, the time and effort to populate these fields could be overwhelming. Although the attribution step is optional, it is important to provide these sources credit.

Image

Old mockup of auto-populated attribution details with ability to edit:

Image

UXD recommendation

  • Automatically populate the attribution details for each document and give the user the ability to modify these details.
  • Combine all document attribution details into a single attribution.txt file when the user submits their contribution.
  • Include an example in the documentation of an attribution file that shows multiple documents in a single attribution.txt file.

Reference

attribution.txt in documentation

An important part of contributing to the InstructLab project is citing your sources of information. This comes in the form of your attribution.txt that you add to the pull requests. Almost all instances of attribution can be covered by the parameters required for Creative Commons Attribution licenses...

creating an attribution file called attribution.txt that provides licensing information for source data, and

@Misjohns Misjohns added the UX Related to the user experience label Mar 4, 2025
@Misjohns Misjohns added this to UI Mar 4, 2025
@vishnoianil vishnoianil moved this to Backlog in UI Mar 26, 2025
@vishnoianil vishnoianil added this to the release-1.2 milestone Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
UX Related to the user experience
Projects
Status: Backlog
Development

No branches or pull requests

2 participants