Document a process for boosting pages in Algolia Docsearch #11111
Conversation
Signed-off-by: DanRoscigno <dan@roscigno.com>
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
I do not know how to fix the Lint and AutoFix failures. |
|
Hi @DanRoscigno and thanks for the valuable information. I wasn't aware of this Algolia technique and will probably use it on my own sites in the future, and consider implementing first-class features so that users can boost ranking of specific docs versions or plugins. However, I believe this information doesn't really belong on our website. Most of this information is framework-agnostic, and valuable to other Algolia/DocSearch users. The only thing related to Docusaurus is how to declare page metadata such as: <head>
<meta name="pageBoost" content="100"/>
</head>Also, Algolia is one search solution among many. We use it historically on Docusaurus, but I don't think it's fair for other solutions to bias too much against it, and write advanced guides. The rest of this docs is not related to Docusaurus. We can't document everything DocSearch has to offer in our own docs. I think it would be more valuable if the DocSearch team added this to their docs. They already document it here, but maybe not enough in-depth in your opinion? Maybe including some framework-specific guides. And using a metadata by convention across all default framework configs could be a nice idea so that it's simpler to implement for users? What do you think @shortcuts @millotp @randombeeper ? |
| @@ -128,6 +128,7 @@ const sidebars: SidebarsConfig = { | |||
| 'advanced/routing', | |||
| 'advanced/ssg', | |||
| 'advanced/client', | |||
| 'advanced/boosting', | |||
There was a problem hiding this comment.
This is very search/Algolia-specific, and doesn't really belong here.
At best, I'd prefer if we only add a little mention on this page: https://docusaurus.io/docs/search#using-algolia-docsearch
Preferably, it should be a very small section about Algolia boosting, linking to an external documentation written and kept up-to-date by the Algolia team itself.
There was a problem hiding this comment.
ok, I will talk to the Algolia folks. thanks.
There are several steps to boosting pages in Docsearch with metadata added to Markdown/MDX pages. This guide covers the steps.
Pre-flight checklist
Motivation
No bug, but this is (to me) a complicated workflow. This combines the existing information on metadata, Cheerio, and Algolia Crawler configuration in one place.
Test Plan
There are no code changes, so no unit tests. There is a section in the doc for the reader to test their changes.
Test links
Related links:
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs