diff options
| author | David O'Regan <doregan@gitlab.com> | 2022-04-20 00:40:12 +0300 |
|---|---|---|
| committer | David O'Regan <doregan@gitlab.com> | 2022-04-20 00:40:12 +0300 |
| commit | 4e2f13586af496dabcfde467159ca11f4e87378c (patch) | |
| tree | 28781d7df57f1b6fe8ec5aba7a965374d6a1c102 | |
| parent | 5baa0e2661fefb66fc7f4275a174109e8782c58e (diff) | |
| parent | 6087ee1711e6ea9ae4904503d1d9d0dc88b9a384 (diff) | |
Merge branch 'remove-duplicate-docsearch' into 'main'
Remove duplicate Docsearch configuration object
See merge request gitlab-org/gitlab-docs!2582
| -rw-r--r-- | content/frontend/home/index.js | 10 | ||||
| -rw-r--r-- | doc/docsearch.md | 23 | ||||
| -rw-r--r-- | layouts/home.html | 1 |
3 files changed, 7 insertions, 27 deletions
diff --git a/content/frontend/home/index.js b/content/frontend/home/index.js deleted file mode 100644 index 3815e1b3..00000000 --- a/content/frontend/home/index.js +++ /dev/null @@ -1,10 +0,0 @@ -document.addEventListener('DOMContentLoaded', () => { - // eslint-disable-next-line no-undef - docsearch({ - apiKey: '89b85ffae982a7f1adeeed4a90bb0ab1', - indexName: 'gitlab', - container: '#docsearch', - appId: '3PNCFOU757', - placeholder: 'Search the docs', - }); -}); diff --git a/doc/docsearch.md b/doc/docsearch.md index 0188d352..b0cd1244 100644 --- a/doc/docsearch.md +++ b/doc/docsearch.md @@ -10,26 +10,17 @@ and DocSearch provides a dropdown search experience on our website. ## DocSearch implementation details -DocSearch is defined in various places: - -- Home page: - - Javascript: [`content/frontend/home/index.js`](../content/frontend/home/index.js) - - Layout: [`content/index.erb`](../content/index.erb) -- Dedicated search page under `/search`: - - Javascript: [`content/frontend/search/index.js`](../content/frontend/search/index.js) - - Layout: [`layouts/instantsearch.html`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/layouts/instantsearch.html) -- Every other page: - - Javascript: [`content/assets/javascripts/docsearch.js`](../content/assets/javascripts/docsearch.js) - - Layout: [`layouts/docsearch.html`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/layouts/docsearch.html) +DocSearch layouts are defined in various places: + +- Home page: [`content/index.erb`](../content/index.erb) +- Dedicated search page under `/search`: [`layouts/instantsearch.html`](../layouts/instantsearch.html) +- Every other page: [`layouts/docsearch.html`](../layouts/docsearch.html) A Javascript snippet initiates docsearch by using an API key, app ID, and an index name that are needed for Algolia to show the results: -```js -apiKey: '89b85ffae982a7f1adeeed4a90bb0ab1', -indexName: 'gitlab', -appId: '3PNCFOU757' -``` +- Dedicated search page under `/search`: [`content/frontend/search/index.js`](../content/frontend/search/index.js) +- Every other page: [`content/assets/javascripts/docsearch.js`](../content/assets/javascripts/docsearch.js) ## Override DocSearch CSS diff --git a/layouts/home.html b/layouts/home.html index d5aefa52..2966b363 100644 --- a/layouts/home.html +++ b/layouts/home.html @@ -15,7 +15,6 @@ <% end %> <%= render '/schema-microdata.*' %> <script src="<%= @items['/frontend/header/index.*'].path %>"></script> - <script src="<%= @items['/frontend/home/index.*'].path %>"></script> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.bundle.min.js" integrity="sha384-LtrjvnR4Twt/qOuYxE721u19sVFLVSA4hf/rRt6PrZTmiPltdZcI7q7PXQBYTKyf" crossorigin="anonymous"></script> <script type="application/javascript" src="<%= @items['/assets/javascripts/badges.*'].path %>"></script> |