Prettify algolia search

[balavec]

@loechel It seems I don't have the merge rights so you just go ahead when ready.

[acsr]

Add Better Fulltext Search to Docs (details from the Ferrara sprint wrapup)

Purpose: Refine the appearance and setup of the Algolia Docsearch on https://docs.plone.org

at https://github.com/plone/documentation

1. Fix appearance of the overlay at  https://docs.plone.org

   1. see Ticket: Search seems to be broken #1075

2. Add free Algolia docsearch to https://training.plone.org

   1. Armins CSS snippets (suitable for the sphinx-rtd-theme of the trainings only) 
   2. More on how we had setup a local Scraper for Sphinx to feed the Algolia Docsearch: https://stackoverflow.com/a/54960623 

Results 1 Day: 

• Robert Kuzma with help from Armin  

  • fixed the appearance of the Search overlay for the Sphinx theme: https://github.com/plone/sphinxtheme.plone/
  • 2 pull requests: The Plone Logo is now inline with the pagetitle saving space and the searchoverlay is now mobile ready!
  • Sven Strack & Alex Loechel did testing, Polyester deployed to the Plone docs.
  • It is live now!

• Armin and Philip

  • took over some code from Armins commercial repo for the Training Manual
  • add the Algolia docsearch javascript and css to page.html template and custom.css in the override of sphinx-rtd-theme documentation in a new branch.
  • A new API key for the Algolia Docsearch Program was initiated by Philip at https://community.algolia.com/docsearch/
  • ToDo after key arrives: 
    • Add final PI-Key and index names, do testing (Hints: https://community.algolia.com/docsearch/dropdown.html#testing)
    • adjust docsearch config.json in [3] if necessary related to and file a pull request to Algolia or
    • Setup your own scraper as described in [5]
    • merge branch
    • Deployment to training.plone.org

How Docsearch works

DocSearch is a SAAS based search service from a commercial company but offered to be operated for free on Documentation of OpenSource projects as a showcase for developers  (and even docs for commercial stuff depending if applying to the rules). 

The DocSearch code is managed in 3 Github repositories:

• [1] algolia/docsearch contains the docsearch.js code source and the documentation website.

• [2] algolia/docsearch-configs contains the JSON files representing all the configs for all the documentations DocSearch is powering

  • Use these direct links to the existing docs.plone.org docsearch configuration on github (, the list is long and too slow to load at the Sprint:
  • [3] Directory containing all existing configs (long!)
  • [4] Current configs/plone.json before the Sprint

• [5] algolia/docsearch-scraper contains the crawler we use to extract data from the documentation. The code is open-source and you can run it from a Docker image or a local Python install.

Champion: 

• Armin Stross-Radschinski

Participants:

• Philip Bauer (for training.plone.org)
• Robert Kuzma; (algolia PR: Prettify algolia search https://github.com/plone/sphinxtheme.plone/pull/68
• Alexander Loechel
• Sven Strack
• Paul Roeland