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

Search: API V3 #9625

Merged
merged 40 commits into from
Nov 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
59775aa
Convert api.py to module api/v2
stsewd Sep 21, 2022
af8b887
Black
stsewd Sep 21, 2022
9f219b8
Fix tests
stsewd Sep 21, 2022
485c200
Search: refactor serializer's context
stsewd Sep 26, 2022
4b98578
Search API V3
stsewd Sep 27, 2022
2ba58bc
Support new syntax in the dashboard
stsewd Sep 27, 2022
d63060f
Black
stsewd Sep 27, 2022
ae4dddf
Redirect to global search from project search
stsewd Sep 28, 2022
36be623
Black
stsewd Sep 28, 2022
74b9384
Refactor
stsewd Sep 28, 2022
d5d6248
Move server-side-search docs
stsewd Sep 28, 2022
a91456d
Add docs
stsewd Sep 28, 2022
9f1c52e
Fixes
stsewd Sep 28, 2022
77114f0
Update links
stsewd Sep 28, 2022
bb62ad1
Fixes
stsewd Sep 29, 2022
fe82da2
Fix tests
stsewd Sep 29, 2022
f0f89a2
Tests
stsewd Oct 4, 2022
efe56ed
Linter
stsewd Oct 4, 2022
ecbf9e3
Merge branch 'main' into search-api-v3-implementation
stsewd Oct 6, 2022
18f108b
Format
stsewd Oct 6, 2022
b027de4
This shouldn't be here
stsewd Oct 6, 2022
1539db6
Fix import
stsewd Oct 6, 2022
170b281
Merge branch 'main' into search-api-v3-implementation
stsewd Oct 11, 2022
ec30c8e
Fix tests
stsewd Oct 12, 2022
a27a6d4
Black
stsewd Oct 12, 2022
adec998
Fix test
stsewd Oct 12, 2022
e6e16d9
Updates from review
stsewd Nov 1, 2022
6327b01
Merge branch 'main' into search-api-v3-implementation
stsewd Nov 1, 2022
3eded3e
Inherit from API v3 settings
stsewd Nov 2, 2022
7210e6c
Add a note about using yield
stsewd Nov 2, 2022
2b02c36
Rename Backend -> SearchExecutor
stsewd Nov 3, 2022
5948cd2
More renaming
stsewd Nov 3, 2022
68b19fe
Merge branch 'main' into search-api-v3-implementation
stsewd Nov 7, 2022
bb6788e
Merge branch 'main' into search-api-v3-implementation
stsewd Nov 14, 2022
af54960
Don't depend on the order
stsewd Nov 14, 2022
52d1cfe
We can't use dicts in a set :(
stsewd Nov 15, 2022
ceadd85
False alarm, we just needed to set the version public
stsewd Nov 15, 2022
60324a6
Set privacy level explicitly
stsewd Nov 15, 2022
119ece2
Override global rate limit
stsewd Nov 15, 2022
3da8748
Comment
stsewd Nov 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user/analytics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ and then click on :guilabel:`Traffic Analytics`.

Traffic analytics demo

You can also access to analytics data from :ref:`search results <server-side-search:Search Analytics>`.
You can also access to analytics data from :ref:`search results <server-side-search/index:Search Analytics>`.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/user/api/v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1882,4 +1882,4 @@ Embed
Additional APIs
---------------

- :ref:`Server side search API <server-side-search:api>`.
- :doc:`Server side search API </server-side-search/api>`.
2 changes: 1 addition & 1 deletion docs/user/build-customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ Read the Docs will automatically index the content of all your HTML files,
respecting the :ref:`search <config-file/v2:search>` options from your config file.

You can access the search results from the :guilabel:`Search` tab of your project,
or by using the :ref:`search API <server-side-search:api>`.
or by using the :doc:`/server-side-search/api`.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/user/config-file/v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@ Do a recursive clone of the submodules.
search
~~~~~~

Settings for more control over :doc:`/server-side-search`.
Settings for more control over :doc:`/server-side-search/index`.

.. code-block:: yaml

Expand Down
6 changes: 3 additions & 3 deletions docs/user/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ We offer a number of search features:

* Search across :doc:`subprojects </subprojects>`
* Search results land on the exact content you were looking for
* Search across projects you have access to (available on |com_brand|)
* A full range of :doc:`search operators </guides/advanced-search>` including exact matching and excluding phrases.
* Search across projects you have access to
* A full range of :doc:`search operators </server-side-search/syntax>` including exact matching and excluding phrases.

Learn more about :doc:`/server-side-search`.
Learn more about :doc:`/server-side-search/index`.

Open Source and Customer Focused
--------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/user/flyout-menu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The flyout menu provides access to the following bits of Read the Docs functiona
* :doc:`Downloadable formats </downloadable-documentation>` for the current version, including HTML & PDF downloads that are enabled by the project.
* Links to the Read the Docs dashboard for the project.
* Links to your :doc:`VCS provider </integrations>` that allow the user to quickly find the exact file that the documentation was rendered from.
* A search bar that gives users access to our :doc:`/server-side-search` of the current version.
* A search bar that gives users access to our :doc:`/server-side-search/index` of the current version.

Closed
~~~~~~
Expand Down
1 change: 0 additions & 1 deletion docs/user/guides/administrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ have a look at our :doc:`/tutorial/index`.

technical-docs-seo-guide
manage-translations-sphinx
advanced-search
hiding-a-version
deprecating-content
pdf-non-ascii-languages
Expand Down
97 changes: 0 additions & 97 deletions docs/user/guides/advanced-search.rst

This file was deleted.

5 changes: 2 additions & 3 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ and some of the core features of Read the Docs.
:doc:`/versions` |
:doc:`/downloadable-documentation` |
:doc:`/hosting` |
:doc:`/server-side-search` |
:doc:`/server-side-search/index` |
:doc:`/analytics` |
:doc:`/pull-requests` |
:doc:`/build-notifications` |
Expand Down Expand Up @@ -111,7 +111,7 @@ and some of the core features of Read the Docs.
/versions
/downloadable-documentation
/hosting
/server-side-search
/server-side-search/index
/analytics
/pull-requests
/build-notifications
Expand Down Expand Up @@ -145,7 +145,6 @@ and how to write successful documentation.
* **For project administrators**:
:doc:`/guides/technical-docs-seo-guide` |
:doc:`/guides/manage-translations-sphinx` |
:doc:`/guides/advanced-search` |
:doc:`/guides/private-submodules` |
Setup Build Notifications <build-notifications> |
:doc:`More guides for administrators </guides/administrators>`
Expand Down
202 changes: 0 additions & 202 deletions docs/user/server-side-search.rst

This file was deleted.

Loading