From b86823121cce09fc765f1c6e9915eb8943255e76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Vannicatte?= Date: Wed, 10 Aug 2022 11:20:50 +0200 Subject: [PATCH] docs: clearer support policy (#1496) --- packages/website/docs/DocSearch-program.md | 10 ++++++++++ packages/website/docs/crawler.mdx | 2 +- packages/website/src/components/ApplyForm.js | 13 ++++++------- 3 files changed, 17 insertions(+), 8 deletions(-) diff --git a/packages/website/docs/DocSearch-program.md b/packages/website/docs/DocSearch-program.md index 2b154df1..4988529f 100644 --- a/packages/website/docs/DocSearch-program.md +++ b/packages/website/docs/DocSearch-program.md @@ -78,6 +78,16 @@ The information of the initially applied project is used everywhere when we depl This allow us to easily scope issues when reaching out for support. +## Support + +Please make sure to **first read the documentation (or [the Algolia one](https://www.algolia.com/doc/)) before reaching out** and take a look at [the Algolia academy](https://academy.algolia.com/trainings). + +We do not provide implementation support for DocSearch, but only for the products that are used by the program: + +- The DocSearch library, please report it via [GitHub issues](https://github.com/algolia/docsearch/issues). +- The Algolia Crawler, reach out [via the support page](https://algolia.com/support). +- The Algolia Dashboard, reach out [via the support page](https://algolia.com/support). + [1]: mailto:docsearch@algolia.com [2]: https://www.algolia.com/ [3]: /docs/legacy/run-your-own diff --git a/packages/website/docs/crawler.mdx b/packages/website/docs/crawler.mdx index fd75ba9b..df7e7ecb 100644 --- a/packages/website/docs/crawler.mdx +++ b/packages/website/docs/crawler.mdx @@ -96,7 +96,7 @@ We provide [config templates](/docs/templates) for many website generators, but 2. Your index settings are up to date (you'll see a banner in [the search preview](/docs/manage-your-crawls/#search-preview) if not) -The Crawler only applies `index settings` at index creation index, to keep the Algolia dashboard as the source of truth. If you have drastically changed your config, or moved to a website generator, we recommend your to delete your index from the Algolia dashboard before starting a new crawl. +The Crawler only applies `index settings` at index creation index, to keep the Algolia dashboard as the source of truth. If you have drastically changed your config, or moved to a website generator, we recommend you to delete your index from the Algolia dashboard before starting a new crawl. ## Links related to the migration diff --git a/packages/website/src/components/ApplyForm.js b/packages/website/src/components/ApplyForm.js index 3fdfbed5..c7e02e8b 100644 --- a/packages/website/src/components/ApplyForm.js +++ b/packages/website/src/components/ApplyForm.js @@ -255,14 +255,13 @@ function ApplyForm() { - Only apply if you don't have a DocSearch application yet. DocSearch - offers best effort support, make sure to first read the - documentation and the GitHub issues. + Only apply if you don't have a DocSearch application yet.
+ For support requests, make sure to first{' '} + + read our policy + + .
{' '} - Ultimately, you can reach out via{' '} - - our support page. -