Add RTD Search Filters (#3581)

* add filters * correct search url * change search textbox * change search box text * remove AWS in AWS Dev Guide * cleanup * more cleanup
aws · Aug 31, 2022 · 4c67f59 · 4c67f59
1 parent 6e9c59d
commit 4c67f59
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 8 deletions.
diff --git a/_static/kendrasearchtools.js b/_static/kendrasearchtools.js
@@ -533,11 +533,19 @@ var KendraSearch = {
   _pulse_status : -1,
 
   init : function() {
+      var filters = {};
       var params = $.getQueryParameters();
       if (params.q) {
           var query = params.q[0];
           $('input[name="q"]')[0].value = query;
-          this.performSearch(query);
+
+          Object.keys(params).forEach(function(key) {
+            if(key.startsWith("filter")){
+              filters[key] = true;
+              $('input[name="' + key + '"]')[0].checked = true;
+            }
+          });
+          this.performSearch(query, filters=filters);
       }
   },
 
@@ -577,16 +585,16 @@ var KendraSearch = {
   /**
    * execute search (requires search index to be loaded)
    */
-   query : function(query, pageNumber, pageSize=10) {
-    var url = " https://9cs56celvj.execute-api.us-west-2.amazonaws.com/prod"
+   query : function(query, pageNumber, pageSize=10, filters={}) {
+    var url = "https://9cs56celvj.execute-api.us-west-2.amazonaws.com/prod"
 
     $('#search-progress').empty();
 
     query = KendraSearch.sanitize(query);
 
     fetch(url, {
       method: 'post',
-      body: JSON.stringify({ "queryText": query , "pageNumber": pageNumber, "pageSize": pageSize, "host": window.location.host}),
+      body: JSON.stringify({ "queryText": query , "pageNumber": pageNumber, "pageSize": pageSize, "filters": filters, "host": window.location.host}),
     }).then(response => response.json())
     .then(function(data) {
       var docs = data["ResultItems"];
@@ -602,7 +610,7 @@ var KendraSearch = {
           if(doc_url.includes("sagemaker-examples.readthedocs.io")){
             type_badge_html = '<span class="example-badge">Example</span>'
           }else if(doc_url.includes("docs.aws.amazon.com")){
-            type_badge_html = '<span class="aws-doc-badge">AWS Dev Guide</span>'
+            type_badge_html = '<span class="aws-doc-badge">Dev Guide</span>'
           }else if(doc_url.includes("sagemaker.readthedocs.io") || doc_url.includes("sagemaker-debugger.readthedocs.io")){
             type_badge_html = '<span class="sdk-doc-badge">SDK Guide</span>'
           }
@@ -656,7 +664,7 @@ var KendraSearch = {
           $(element).on('click', function() {
             KendraSearch.output.empty();
             paginationItem.remove();
-            KendraSearch.query(query, parseInt($(element).attr('id').split("-")[1]));
+            KendraSearch.query(query, parseInt($(element).attr('id').split("-")[1]), pageSize, filters);
           });
         });
       }     
@@ -670,7 +678,7 @@ var KendraSearch = {
   /**
    * perform a search for something (or wait until index is loaded)
    */
-   performSearch : function(query) {
+   performSearch : function(query, filters) {
     // create the required interface elements
     this.out = $('#search-results');
     this.title = $('<h2>' + _('Searching...') + '</h2>').appendTo(this.out);
@@ -682,7 +690,7 @@ var KendraSearch = {
     $('#search-progress').text(_('Preparing search...'));
     this.startPulse();
 
-    this.query(query, 1)
+    this.query(query, 1, pageSize=10, filters=filters)
   },
 
 };

diff --git a/_templates/searchbox.html b/_templates/searchbox.html
@@ -0,0 +1,14 @@
+<div role="search">
+    <form id ="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
+        <input type="text" name="q" placeholder="{% trans %}ex. train object detection model, pd.concat{% endtrans %}" title="{% trans %}Type search term here{% endtrans %}" />
+        <br />
+        <br />
+        <div style="text-align: left;">
+            <div style="font-size: 0.85rem;">Filters: </div>
+            <div style="display: inline-block;"><label style="color: white;" for="filterExample"><input type="checkbox" id="filterExample" name="filterExample">Example</label></div>
+            <div style="display: inline-block;"><label style="color: white;" for="filterAWSDevGuide"><input type="checkbox" id="filterAWSDevGuide" name="filterAWSDevGuide">Dev Guide</label></div>
+            <div style="display: inline-block;"><label style="color: white;" for="filterSDKGuide"><input type="checkbox" id="filterSDKGuide" name="filterSDKGuide">SDK Guide</label></div>
+        </div>
+
+    </form>
+</div>