docs: more answers to FAQs (#1495)
This commit is contained in:
parent
d0d866ce6c
commit
a05d1c027c
6 changed files with 53 additions and 4 deletions
|
|
@ -63,6 +63,21 @@ Algolia apps come with a default search API key, which also allow you to list in
|
|||
|
||||
When your application is deployed, we provide a search **ONLY** API key, scoped to your production index, so you don't have to worry disclosing it in the frontend.
|
||||
|
||||
## Can I have multiple projects under the same Algolia application?
|
||||
|
||||
We recommend having a single Algolia application per project. Please [apply](/apply) if you'd like to use DocSearch in an other project of yours.
|
||||
|
||||
### Why ?
|
||||
|
||||
The information of the initially applied project is used everywhere when we deploy your app:
|
||||
|
||||
- The scope of your API keys
|
||||
- The name of your Algolia application/Crawler
|
||||
- The indices we generate
|
||||
- The allowed domains of your Crawler
|
||||
|
||||
This allow us to easily scope issues when reaching out for support.
|
||||
|
||||
[1]: mailto:docsearch@algolia.com
|
||||
[2]: https://www.algolia.com/
|
||||
[3]: /docs/legacy/run-your-own
|
||||
|
|
|
|||
|
|
@ -30,11 +30,9 @@ Ultimately, it is possible to set set the [`exclusionPatterns`](https://www.algo
|
|||
|
||||
We've deprecated our legacy infrastructure, but you can still use it to [run your own instance](/docs/legacy/run-your-own) and plug it to [DocSearch v3](/docs/DocSearch-v3)!
|
||||
|
||||
## Migration seems to have started, but I don't have received any emails
|
||||
## How to migrate
|
||||
|
||||
All of the indices from the [Legacy infrastructure](/docs/legacy/required-configuration) have been migrated, please search for emails from `docsearch@algolia.com`. If you were not part of the previous `index` owners, or the maintainer has changed, you can request access via [our support page](https://www.algolia.com/support/).
|
||||
|
||||
## What do I need to do to migrate?
|
||||
> Every owners should have received a migration email from `docsearch@algolia.com` with the details. If you were not part of the previous `index` owners, or the maintainer has changed, you can request access via [our support page](https://www.algolia.com/support/).
|
||||
|
||||
All the steps are detailed in the email you've received, but in order to use the new infrastructure you need to:
|
||||
|
||||
|
|
@ -86,6 +84,20 @@ You should use [the dedicated web interface][2] to make any changes to your inde
|
|||
|
||||
We did not remove access to the legacy DocSearch application (`BH4D9OD16A`) to give you the time to get familiar with our new infrastructure. `BH4D9OD16A` will remain available until the migration has been completed for all the DocSearch users.
|
||||
|
||||
## Search yield no results
|
||||
|
||||
If your search does not yield any results, but there is no error in [your browser developer tools](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools), there might be an issue with your index.
|
||||
|
||||
Make sure that:
|
||||
|
||||
1. [Your Crawler config](/docs/record-extractor) matches your website structure
|
||||
|
||||
We provide [config templates](/docs/templates) for many website generators, but you can also use them as a base. To debug your selectors, we recommend using [the URL tester](/docs/manage-your-crawls/#url-tester).
|
||||
|
||||
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.
|
||||
|
||||
## Links related to the migration
|
||||
|
||||
- [Docusaurus blog post](https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration)
|
||||
|
|
|
|||
|
|
@ -49,3 +49,14 @@ From the [`editor`](#update-your-config), you have access to a `Search preview`
|
|||
alt="Algolia Crawler creation page"
|
||||
/>
|
||||
</div>
|
||||
|
||||
## URL tester
|
||||
|
||||
From the [`editor`](#update-your-config), your can use the URL tester to [debug selectors](https://www.algolia.com/doc/tools/crawler/getting-started/crawler-configuration/#debugging-selectors) or how we crawl your website.
|
||||
|
||||
<div className="uil-ta-center">
|
||||
<img
|
||||
src={useBaseUrl('img/assets/crawler-url-tester.png')}
|
||||
alt="Algolia Crawler URL tester"
|
||||
/>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -30,6 +30,12 @@ We're receiving dozens of requests every day, and while we strive to answer them
|
|||
|
||||
- 🙁 If we need to render your website in the browser through JavaScript, it means that we'll have to crawl it through a much slower browser emulation. We highly recommend that you put in place server-side rendering for the useful textual content.
|
||||
|
||||
## Process duration
|
||||
|
||||
As stated in [the priority section](#priority), we receive a lot of requests every day. To ensure they all match [our checklist](#the-checklist), we manually review each of them, which means it can take a bit of time before you get an answer from us.
|
||||
|
||||
The full process (from application to deployment) can take **up to two weeks**, applying multiple times or opening issues **only slows the process**, please be patient 🙏.
|
||||
|
||||
[1]: /docs/DocSearch-v3
|
||||
[2]: /apply
|
||||
[3]: /docs/legacy/run-your-own
|
||||
|
|
|
|||
|
|
@ -65,6 +65,11 @@ const lightCodeTheme = require('prism-react-renderer/themes/github');
|
|||
to: 'docs/what-is-docsearch',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
label: 'Apply',
|
||||
to: 'apply',
|
||||
position: 'left',
|
||||
},
|
||||
// right
|
||||
{
|
||||
type: 'docsVersionDropdown',
|
||||
|
|
|
|||
BIN
packages/website/static/img/assets/crawler-url-tester.png
Normal file
BIN
packages/website/static/img/assets/crawler-url-tester.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 150 KiB |
Loading…
Reference in a new issue