Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NEOS-412: updated transformers intro page #737

Merged
merged 13 commits into from
Dec 5, 2023
2 changes: 1 addition & 1 deletion docs/docs/overview/use-cases/anonymization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ We've mapped each transformer to the right column which means that every time th

//screenshot of the output here

Since the transformers are customizable, you can anonymize or mask any source data by writing your own custom tranformer. Check out the [custom transformers](/transformers/custom) guide for more information. This gives you ultimate flexibility to control your data.
Since the transformers are customizable, you can anonymize or mask any source data by writing your own custom tranformer. Check out the [custom transformers](/transformers/user-defined) guide for more information. This gives you ultimate flexibility to control your data.

Lastly, you can decide to subset this data to reduce the size of it to make it fit in lower level environments like your local database.

Expand Down
51 changes: 0 additions & 51 deletions docs/docs/transformers/custom.mdx

This file was deleted.

15 changes: 9 additions & 6 deletions docs/docs/transformers/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,19 @@ import { DocsImage } from '@site/src/CustomComponents/DocsImage';

## Introduction

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.
Transformers are data-type specific modules that anonymize or generate data. For example, an email transformer can create a synthetic email address or anonymize an existing email address.

<DocsImage href="https://assets.nucleuscloud.com/neosync/docs/transformers-page.png" />
Tranformers are defined in the job workflow and are applied to every piece of data in the column they are assigned. Neosync ships with over 40 pre-defined transformers that make it fast and easy to get started.

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

## Transformer Types

There are two types of transformers:

1. **System Transformers** : Pre-built and configured transformers that automatically come with Neosync out of the box. These cannot be deleted but they can be cloned.
2. **Custom Transformers** : System transformers that have been cloned, re-configured and renamed. These transformers can be edited and deleted.

2. **User Defined Transformers** : These are system transformers that have been cloned, re-configured and renamed. These transformers can be edited and deleted.

## Transformers

Expand All @@ -39,13 +42,13 @@ You can browse our list of system transformers which come out of the box or you
{
title: 'System Transformers',
description: 'Pre-built transformers that are ready to use',
link: '/transformers/system/email',
link: '/transformers/system/reference',
icon: <IoBuildOutline />,
},
{
title: 'Custom Transformers',
title: 'User Defined Transformers',
description: 'Define your own transformers',
link: '/transformers/custom',
link: '/transformers/user-defined',
icon: <GoCode />,
},
]}
Expand Down
63 changes: 0 additions & 63 deletions docs/docs/transformers/system/card-number.mdx

This file was deleted.

42 changes: 0 additions & 42 deletions docs/docs/transformers/system/city.mdx

This file was deleted.

93 changes: 0 additions & 93 deletions docs/docs/transformers/system/email.mdx

This file was deleted.

66 changes: 0 additions & 66 deletions docs/docs/transformers/system/first-name.mdx

This file was deleted.

Loading