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

Documentation Page needed for Bulk Search #9975

Open
benbdeitch opened this issue Nov 1, 2024 · 2 comments
Open

Documentation Page needed for Bulk Search #9975

benbdeitch opened this issue Nov 1, 2024 · 2 comments
Assignees
Labels
Lead: @cdrini Issues overseen by Drini (Staff: Team Lead & Solr, Library Explorer, i18n) [managed] Needs: Breakdown This big issue needs a checklist or subissues to describe a breakdown of work. [managed] Needs: Response Issues which require feedback from lead Priority: 3 Issues that we can consider at our leisure. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]

Comments

@benbdeitch
Copy link
Collaborator

Proposal

Currently, there is no easily accessible documentation from the Bulk Search page detailing how to properly use it. It would probably be best if it was linked to a 'help' page of some kind, to help users that might otherwise struggle with it.

Justification

This problem addresses a lack of well-explained instructions and guidance for Bulk Search. It will primarily impact audiences that are unfamiliar with API keys, and it will explain the reason behind the 'beta' tag that will soon be placed on that extraction option.

The predicted impact will likely be minor, but useful. Success will be a new page created that has detailed descriptions for any users that are struggling to make proper use of the UI, likely with some visual examples to go with a text-based explanation.

Breakdown

Requirements Checklist

  • [ ]

Related files

Stakeholders


Instructions for Contributors

Please run these commands to ensure your repository is up to date before creating a new branch to work on this issue and each time after pushing code to Github, because the pre-commit bot may add commits to your PRs upstream.

@benbdeitch benbdeitch added Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed] Needs: Breakdown This big issue needs a checklist or subissues to describe a breakdown of work. [managed] Needs: Triage This issue needs triage. The team needs to decide who should own it, what to do, by when. [managed] Needs: Lead labels Nov 1, 2024
@harpekar
Copy link

harpekar commented Nov 2, 2024

Hi, I am interested in working on this. Can you assign it to me? Thanks.

@github-actions github-actions bot added the Needs: Response Issues which require feedback from lead label Nov 3, 2024
@mekarpeles mekarpeles added Priority: 3 Issues that we can consider at our leisure. [managed] Lead: @cdrini Issues overseen by Drini (Staff: Team Lead & Solr, Library Explorer, i18n) [managed] and removed Needs: Triage This issue needs triage. The team needs to decide who should own it, what to do, by when. [managed] Needs: Lead labels Nov 4, 2024
@cdrini
Copy link
Collaborator

cdrini commented Nov 6, 2024

Hi @harpekar ! This likely needs to be done by staff; please feel free to look at another good first issues.

@cdrini cdrini assigned cdrini and unassigned benbdeitch Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lead: @cdrini Issues overseen by Drini (Staff: Team Lead & Solr, Library Explorer, i18n) [managed] Needs: Breakdown This big issue needs a checklist or subissues to describe a breakdown of work. [managed] Needs: Response Issues which require feedback from lead Priority: 3 Issues that we can consider at our leisure. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]
Projects
None yet
Development

No branches or pull requests

4 participants