Improve copy in Search app (#428)

This commit is contained in:
Lukasz Ostrowski 2023-04-26 12:20:08 +02:00 committed by GitHub
parent da3da9d8b0
commit b33da7a70a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 90 additions and 4 deletions

View file

@ -0,0 +1,5 @@
---
"saleor-app-search": patch
---
Improved helping description - added supported events and links to docs

View file

@ -2,20 +2,101 @@ import { Box, Text } from "@saleor/macaw-ui/next";
import { AppSection } from "../../components/AppSection"; import { AppSection } from "../../components/AppSection";
import { AlgoliaConfigurationForm } from "../../components/AlgoliaConfigurationForm"; import { AlgoliaConfigurationForm } from "../../components/AlgoliaConfigurationForm";
import { ImportProductsToAlgolia } from "../../components/ImportProductsToAlgolia"; import { ImportProductsToAlgolia } from "../../components/ImportProductsToAlgolia";
import { actions, useAppBridge } from "@saleor/app-sdk/app-bridge";
const SALEOR_EVENTS_DOCS_URL =
"https://docs.saleor.io/docs/3.x/developer/extending/apps/asynchronous-webhooks#available-webhook-events";
const ALGOLIA_DASHBOARD_TOKENS_URL = "https://www.algolia.com/account/api-keys/all";
export const ConfigurationView = () => { export const ConfigurationView = () => {
const { appBridge } = useAppBridge();
return ( return (
<Box> <Box>
<Text variant={"hero"} size={"medium"} as={"h1"}> <Text variant={"hero"} size={"medium"} as={"h1"}>
Configuration Configuration
</Text> </Text>
<Text as="p" marginTop={4} __marginBottom={"100px"}> <Box marginTop={4} __marginBottom={"100px"}>
Configure the App - fill your Algolia settings to allow products indexing <Text as="p" marginBottom={4}>
</Text> To configure the App, fill in your Algolia settings to enable products indexing.
</Text>
<Text as="p" marginBottom={4}>
Once the App is configured, you will be able to perform initial index of your existing
Saleor database.
</Text>
<Text as="p">
The app supports following{" "}
<a
onClick={(e) => {
e.preventDefault();
/**
* TODO extract shared handler
*/
appBridge?.dispatch(
actions.Redirect({
to: SALEOR_EVENTS_DOCS_URL,
newContext: true,
})
);
}}
href={SALEOR_EVENTS_DOCS_URL}
>
events
</a>{" "}
that will synchronize Algolia in the background:
</Text>
<ul>
<li>
<code>- PRODUCT_CREATED</code>
</li>
<li>
<code>- PRODUCT_UPDATED</code>
</li>
<li>
<code>- PRODUCT_DELETED</code>
</li>
<li>
<code>- PRODUCT_VARIANT_CREATED</code>
</li>
<li>
<code>- PRODUCT_VARIANT_UPDATED</code>
</li>
<li>
<code>- PRODUCT_VARIANT_DELETED</code>
</li>
</ul>
</Box>
<AppSection <AppSection
heading="Algolia settings" heading="Algolia settings"
mainContent={<AlgoliaConfigurationForm />} mainContent={<AlgoliaConfigurationForm />}
sideContent={<Text>Provide Algolia settings. </Text>} sideContent={
<Box>
<Text as="p" marginBottom={4}>
Provide Algolia settings.{" "}
</Text>
<Text>
You can find your tokens in Algolia Dashboard{" "}
<a
href={ALGOLIA_DASHBOARD_TOKENS_URL}
onClick={(e) => {
e.preventDefault();
appBridge?.dispatch(
actions.Redirect({
to: ALGOLIA_DASHBOARD_TOKENS_URL,
newContext: true,
})
);
}}
>
here
</a>
</Text>
</Box>
}
/> />
<AppSection <AppSection
includePadding includePadding