Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
evisdrenova committed Dec 5, 2023
1 parent 13c5c87 commit caa5cd8
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 23 deletions.
38 changes: 17 additions & 21 deletions docs/docs/transformers/user-defined.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Custom
title: User Defined
id: user-defined
hide_title: true
slug: /transformers/user-defined
Expand All @@ -9,43 +9,39 @@ import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';

import { DocsImage } from '@site/src/CustomComponents/DocsImage';

<DocPageHeader title="Custom Transformers" />
<DocPageHeader title="User Defined Transformers" />

## Introduction

Custom Transfomers are a great way to configure a system transformer with your own presets and publish it everywhere. Custom transformers are saved at the account level and
User defined Transfomers are a great way to configure a system transformer with your own presets and publish it everywhere. User defined transformers are saved at the account level and
can be used across multiple jobs, saving your time during the schema configuration process.

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-transformers-table.png" />
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/user-defined-transformers-home.png" />

## Creating a Custom Transformer
## Creating a User Defined Transformer

In order to create a custom transformer, follow these steps:
In order to create a user defined transformer, follow these steps:

1. Navigate to the **Transformers** page and click on **+ New Transformer**.
2. You'll be brought to the new transformer page where you can select a base transformer. A base transformer serves as the blueprint for the custom transformer. Select the base transformer for your custom transformer.
2. You'll be brought to the new transformer page where you can select a base transformer. A base transformer serves as the blueprint for the user defined transformer. Select the base transformer for your user defined transformer.

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/base-transformer.png" />
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/udt-new.png" />

3. Once you've selected a base transformer, you'll be prompted to give the transformer a name and description. Additionally, you can preset custom default configurations depending on the transformer.
3. Once you've selected a base transformer, you'll be prompted to give the transformer a name and description. Additionally, you can preset custom default configurations depending on the transformer. Fill out the details and click **save**.

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-string.png" />
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/udt-new-float.png" />

4. Once you've filled out the form, you can click on **save** and then you will be routed to the newly created transformer.
## Using a User Defined Transformer

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-string-filled.png" />
Once you've created a user defined transformer, you'll see it appear in the transformer list in Transformers main page as well as the Schema configuration page. Above, we created a user defined transformer
called `custom-float-transfomer`, we can now see it both places.

## Using a Custom Transformer
In the transformers table under the User Defined Transformer tab.

Once you've created a custom transformer, you'll see it appear in the transformer list in Transformers main page as well as the Schema configuration page. Above, we created a custom transformer
called `custom-string-transformer`, we can now see it both places.

In the transformers table under the Custom Transformer tab.

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-transformer-table-with-new-transsformer.png" />
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/udt-new-float-home-page.png" />

In the Schema configuration page in the transformer select.

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/schema-page-custom-transformer.png" />
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/udt-schema-page.png" />

Now we can finsih the rest of our job configuration and the newly created custom transformer will be used in the column that it's mapped to.
Now we can finsih the rest of our job configuration and the newly created user defined transformer will be used in the column that it's mapped to.
2 changes: 1 addition & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ const sidebars: SidebarsConfig = {
},
{
type: 'category',
label: 'System Transformers',
label: 'System',
collapsible: true,
collapsed: true,
items: [
Expand Down
2 changes: 1 addition & 1 deletion docs/src/CustomComponents/IconHandler.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export function IconHandler(name: string): ReactElement {
return <MdPassword />;
case 'User Defined':
return <GoCode />;
case 'System Transformers':
case 'System':
return <IoBuildOutline />;
case 'Use cases':
return <BsShieldCheck />;
Expand Down

0 comments on commit caa5cd8

Please sign in to comment.