Hello folks, I spend some time today mucking about trying to figure out how to make our documentation search a better experience. The short answer is, search kind of works now. Long answer: mkdocs creates a client side file which is used for search. RTD overrides this by referring people to Elasticsearch. However, that doesn't clear out stale entries and we're plagued with a whole lot of stale entries. I've made some changes that other consumers of RTD have done to override our search to use the JS file rather than Elasticsearch. -- nigelb -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.gluster.org/pipermail/gluster-users/attachments/20170828/da6570fc/attachment.html>
On 08/28/2017 04:44 PM, Nigel Babu wrote:> Hello folks, > > I spend some time today mucking about trying to figure out how to make > our documentation search a better experience. The short answer is, > search kind of works now. > > Long answer: mkdocs creates a client side file which is used for > search. RTD overrides this by referring people to Elasticsearch. > However, that doesn't clear out stale entries and we're plagued with a > whole lot of stale entries. I've made some changes that other > consumers of RTD have done to override our search to use the JS file > rather than Elasticsearch. > > -- > nigelb > > > _______________________________________________ > Gluster-users mailing list > Gluster-users at gluster.org > http://lists.gluster.org/mailman/listinfo/gluster-usersNice. Please version the generated search_index.json file so that it will be easy to invalidate the browser's cache once changed. -- regards Aravinda VK -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.gluster.org/pipermail/gluster-users/attachments/20170829/323f2e8b/attachment.html>
Great work, Nigel! This solves a problem that has bothered us for a while. Thank you! -Vijay On Mon, Aug 28, 2017 at 7:14 AM, Nigel Babu <nigelb at redhat.com> wrote:> Hello folks, > > I spend some time today mucking about trying to figure out how to make our > documentation search a better experience. The short answer is, search kind > of works now. > > Long answer: mkdocs creates a client side file which is used for search. > RTD overrides this by referring people to Elasticsearch. However, that > doesn't clear out stale entries and we're plagued with a whole lot of stale > entries. I've made some changes that other consumers of RTD have done to > override our search to use the JS file rather than Elasticsearch. > > -- > nigelb > > _______________________________________________ > Gluster-users mailing list > Gluster-users at gluster.org > http://lists.gluster.org/mailman/listinfo/gluster-users >-------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.gluster.org/pipermail/gluster-users/attachments/20170829/549af07c/attachment.html>
Shyam Ranganathan
2017-Aug-29 13:39 UTC
[Gluster-users] [Gluster-devel] Gluster documentation search
On 08/28/2017 07:14 AM, Nigel Babu wrote:> Hello folks, > > I spend some time today mucking about trying to figure out how to make > our documentation search a better experience. The short answer is, > search kind of works now.Awesome! thank you.> > Long answer: mkdocs creates a client side file which is used for search. > RTD overrides this by referring people to Elasticsearch. However, that > doesn't clear out stale entries and we're plagued with a whole lot of > stale entries. I've made some changes that other consumers of RTD have > done to override our search to use the JS file rather than Elasticsearch. > > -- > nigelb > > > _______________________________________________ > Gluster-devel mailing list > Gluster-devel at gluster.org > http://lists.gluster.org/mailman/listinfo/gluster-devel >