Skip to content
This repository was archived by the owner on Aug 30, 2025. It is now read-only.

Commit 0bee4e4

Browse files
committed
updates to custom transformers page
1 parent 8baaf22 commit 0bee4e4

File tree

4 files changed

+49
-5
lines changed

4 files changed

+49
-5
lines changed

docs/docs/transformers/custom.mdx

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,45 @@ slug: /transformers/custom
77

88
import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
99

10+
import { DocsImage } from '@site/src/CustomComponents/DocsImage';
11+
1012
<DocPageHeader title="Custom" />
1113

12-
## More coming soon!
14+
## Introduction
15+
16+
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
17+
can be used across multiple jobs, saving your time during the schema configuration process.
18+
19+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-transformers-table.png" />
20+
21+
## Creating a Custom Transformer
22+
23+
In order to create a custom transformer, follow these steps:
24+
25+
1. Navigate to the **Transformers** page and click on **+ New Transformer**.
26+
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.
27+
28+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/base-transformer.png" />
29+
30+
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.
31+
32+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-string.png" />
33+
34+
4. Once you've filled out the form, you can click on **save** and then you will be routed to the newly created transformer.
35+
36+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-string-filled.png" />
37+
38+
## Using a Custom Transformer
39+
40+
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
41+
called `custom-string-transformer`, we can now see it both places.
42+
43+
In the transformers table under the Custom Transformer tab.
44+
45+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/custom-transformer-table-with-new-transsformer.png" />
46+
47+
In the Schema configuration page in the transformer select.
48+
49+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/schema-page-custom-transformer.png" />
50+
51+
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.

docs/docs/transformers/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { DocsImage } from '@site/src/CustomComponents/DocsImage';
2121

2222
Transformers are data-type specific modules that anonymize or generate data. Tranformers are defined in the job workflow and are applied to every piece of data in the column they are assigned. Neosync ships with a number of transformers that are already built to handle common data types such as email, addresses, ssn, strings, integers and more.
2323

24-
<DocsImage />
24+
<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/transformers-page.png" />
2525

2626
## Transformer Types
2727

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
import React, { ReactElement } from 'react';
22

3-
export function DocsImage(): ReactElement {
3+
interface Props {
4+
href: string;
5+
}
6+
7+
export function DocsImage(props: Props): ReactElement {
8+
const { href } = props;
49
return (
510
<div className="docsImage">
6-
<img src="https://assets.nucleuscloud.com/neosync/docs/transformers-page.png" />
11+
<img src={href} />
712
</div>
813
);
914
}

docs/src/css/custom.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,6 @@ this is the class for the sidebar categories that section headers
142142
}
143143

144144
.docsImage {
145-
@apply border border-gray-300 shadow-lg rounded-lg overflow-hidden;
145+
@apply border border-gray-300 shadow-lg rounded-lg overflow-hidden my-6;
146146
}
147147
}

0 commit comments

Comments
 (0)