Skip to content

docs: document aggregateContent, make API ref clearer#1328

Merged
shortcuts merged 2 commits intonextfrom
docs/aggregateContent
Mar 17, 2022
Merged

docs: document aggregateContent, make API ref clearer#1328
shortcuts merged 2 commits intonextfrom
docs/aggregateContent

Conversation

@shortcuts
Copy link
Copy Markdown
Member

Summary

This PR documents the new aggregateContent option available on the crawler.

This option allows users to reduce the number of records outputted by the crawler by aggregating all the records of type content in a single record.

@shortcuts shortcuts requested a review from bodinsamuel March 17, 2022 09:47
@shortcuts shortcuts self-assigned this Mar 17, 2022
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 17, 2022

✔️ Deploy Preview for docsearch ready!

🔨 Explore the source changes: 559baa8

🔍 Inspect the deploy log: https://app.netlify.com/sites/docsearch/deploys/62331aa48e9077000851648a

😎 Browse the preview: https://deploy-preview-1328--docsearch.netlify.app

@codesandbox-ci
Copy link
Copy Markdown

codesandbox-ci bot commented Mar 17, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 559baa8:

Sandbox Source
Vanilla Configuration

Contains values that can be used as [`facetFilters`][15]
Custom variables are used to [`filter your search`](/docs/DocSearch-v3#filtering-your-search), you can define them in the [`recordProps`](#indexing-content-for-faceting)

## `helpers.docsearch` API Reference
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be merged as-is but belongs into official documentation not here
https://www.algolia.com/doc/tools/crawler/apis/configuration/actions/#parameter-param-recordextractor

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not found any mention of it on the Algolia doc so I've only added here for now. To avoid duplicate, a doc should point to the other, feel free to decide!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well it's already decided, official doc first :D
but can be done later don't worry

Comment thread packages/website/docs/record-extractor.md
@shortcuts shortcuts merged commit fca7347 into next Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants