Add Search Algorithm page to API docs

sarayourfriend commented 1 year ago

Fixes

Fixes #8 by @obulat

Description

Adds a new page to the API documentation site that describes the search algorithm. Openverse does not really have a strong "algorithmic" approach to search at the moment, though the document scoring section covers popularity data usage which is the closest to an algorithmic approach we have at the moment. Otherwise, the document describes our text analysis approach and the two different types of querying available via the API.

Here is the page in the doc preview: https://wordpress.github.io/openverse-api/_preview/1050/reference/search_algorithm.html

Testing Instructions

Read the documentation. Cross-reference it with search_controller.py and es_mapping.py and ensure it is as accurate as possible. Please note areas where further clarification would be helpful. Feel free to make suggestions for additional sections or different ways of explaining concepts that would be easier to understand.

Checklist

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the default branch of the repository (main) or a parent feature branch.
[x] My commit messages follow [best practices][best_practices].
[x] My code follows the established code style of the repository.
[x] I added or updated tests for the changes I made (if applicable).
[x] I added or updated documentation (if applicable).
[x] I tried running the project locally and verified that there are no visible errors.

[best_practices]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines

Developer Certificate of Origin

``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```

github-actions[bot] commented 1 year ago

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1050

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

sarayourfriend commented 1 year ago

I'm going to merge as is, @obulat. If the changes I made don't address your concerns about keyword fields or the technical accessibility of the text, we can iterate in further PRs and issues. Thanks for the reviews, y'all.

WordPress / openverse-api