Skip to content

Commit

Permalink
docs: adds example dataset
Browse files Browse the repository at this point in the history
  • Loading branch information
@micheleriva
micheleriva committed Oct 30, 2023
1 parent 999bddf commit b442a3c
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 46 deletions.
13 changes: 13 additions & 0 deletions packages/docs/pages/cloud/data-sources/custom/json-file.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
import { Card, Cards } from 'nextra-theme-docs'
import { AiOutlineDownload } from 'react-icons/ai'
import { Screenshot } from '../../../../components/Screenshot'

# Import a JSON file to Orama Cloud

With Orama Cloud, you can upload a JSON file as a data source.
Once you upload it to Orama Cloud, it will be distributed in our Global Search Network, making it available in 300 global locations worldwide.

You can follow along with this guide by downloading the following example JSON file:

<Cards>
<Card
icon={<AiOutlineDownload style={{ width: 22, height: 22 }} />}
title="Download dataset"
href="https://docs.oramasearch.com/cloud/guides/json-file/dog_breeds.json"
target='_blank'
/>
</Cards>

## Creating the index

As always, you can create a new Orama Cloud index by going to [https://cloud.oramasearch.com/indexes/new](https://cloud.oramasearch.com/indexes/new).
Expand Down
92 changes: 46 additions & 46 deletions packages/docs/public/sitemap-0.xml
View file
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
<url><loc>https://docs.oramasearch.com</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/csv-file</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/introduction</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/json-file</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/rest-api</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/webhooks</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/docusaurus</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/introduction</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/nextra</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/shopify</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/indexes/create-a-new-index</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/indexes/delete-an-index</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/indexes/edit-an-existing-index</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/integrating-orama-cloud/javascript-sdk</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/understanding-orama</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/understanding-orama/indexes</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/internals/components</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/internals/utilities</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-astro</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-docusaurus</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-match-highlight</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-nextra</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-parsedoc</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/text-analysis/stemming</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/text-analysis/stop-words</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/create</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/insert</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/remove</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/BM25-algorithm</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/facets</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/fields-boosting</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/filters</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/geosearch</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/grouping</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/introduction</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/preflight</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/sorting</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/threshold</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/vector-search</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/typescript</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/update</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/utilities</loc><lastmod>2023-10-30T16:33:35.467Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/csv-file</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/introduction</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/json-file</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/rest-api</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/custom/webhooks</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/docusaurus</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/introduction</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/nextra</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/data-sources/native-integrations/shopify</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/indexes/create-a-new-index</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/indexes/delete-an-index</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/indexes/edit-an-existing-index</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/integrating-orama-cloud/javascript-sdk</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/understanding-orama</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/cloud/understanding-orama/indexes</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/internals/components</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/internals/utilities</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-astro</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-docusaurus</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-match-highlight</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-nextra</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/plugins/plugin-parsedoc</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/text-analysis/stemming</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/text-analysis/stop-words</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/create</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/insert</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/remove</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/BM25-algorithm</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/facets</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/fields-boosting</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/filters</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/geosearch</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/grouping</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/introduction</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/preflight</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/sorting</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/threshold</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/search/vector-search</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/typescript</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/update</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
<url><loc>https://docs.oramasearch.com/open-source/usage/utilities</loc><lastmod>2023-10-30T16:34:42.441Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
</urlset>

1 comment on commit b442a3c

@vercel
Copy link

@vercel vercel bot commented on b442a3c Oct 30, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

orama-docs – ./

orama-docs-oramasearch.vercel.app
orama-docs.vercel.app
orama-docs-git-main-oramasearch.vercel.app
docs.oramasearch.com

Please sign in to comment.