Merge pull request #2056 from rocketstack-matt/feat/docs-search

feat(docs): add algolia docsearch configuration

Author: markscott-ms

docs/DEVELOPER_GUIDE.md

@@ -24,4 +24,14 @@ The [OWASP dependency check tool](https://jeremylong.github.io/DependencyCheck/)
 
 To use the dependency check tool locally, first install the tool following the instructions for your operating system [here](https://jeremylong.github.io/DependencyCheck/dependency-check-cli/index.html).
 
-Once that is done the tool is configured as a script in the package.json, run `npm run dependency-check`; the reports will be output to `cli/dependency-check-report`.
+Once that is done the tool is configured as a script in the package.json, run `npm run dependency-check`; the reports will be output to `cli/dependency-check-report`.
+
+## Search Configuration
+
+The documentation uses [Algolia DocSearch](https://docsearch.algolia.com/) for full-text search.
+
+To configure search locally or for production:
+1. Apply for DocSearch at https://docsearch.algolia.com/apply
+2. Once approved, Algolia will provide an `appId` and `apiKey`
+3. Update `docusaurus.config.js` with these credentials
+4. The crawler configuration is managed by Algolia, but runs weekly to index the content

docs/docusaurus.config.js

@@ -143,6 +143,36 @@ const config = {
                 theme: prismThemes.github,
                 darkTheme: prismThemes.dracula,
             },
+            algolia: {
+                // The application ID provided by Algolia
+                appId: '87IS6TKJAE',
+
+                // Public API key: it is safe to commit it
+                apiKey: 'dfdc380d6e179c38f558cb610645257a',
+
+                indexName: 'calm-finos',
+
+                // Optional: see doc section below
+                contextualSearch: true,
+
+                // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites
+                // externalUrlRegex: 'external\\.com|domain\\.com',
+
+                // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
+                // replaceSearchResultPathname: {
+                //   from: '/docs/', // or as RegExp: /\/docs\//
+                //   to: '/',
+                // },
+
+                // Optional: Algolia search parameters
+                searchParameters: {},
+
+                // Optional: path for search page that enabled by default (`false` to disable it)
+                searchPagePath: 'search',
+
+                // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
+                // insights: false,
+            },
         }),
 };