NEOS-146: added new docs table and rearranged docs layouts (#565)

nucleuscloud · Nov 13, 2023 · ce32d2d · ce32d2d
1 parent 2ca3157
commit ce32d2d
Show file tree

Hide file tree

Showing 42 changed files with 432 additions and 83 deletions.
diff --git a/docs/docs/connections/mysql.mdx b/docs/docs/connections/mysql.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /connections/mysql
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader
   title="Mysql"

diff --git a/docs/docs/connections/postgres.mdx b/docs/docs/connections/postgres.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /connections/postgres
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader
   title="Postgres"

diff --git a/docs/docs/connections/s3.mdx b/docs/docs/connections/s3.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /connections/s3
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader
   title="S3"

diff --git a/docs/docs/deploy/docker-compose.mdx b/docs/docs/deploy/docker-compose.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /deploy/docker-compose
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader
   title="Deploy with Docker Compose"

diff --git a/docs/docs/deploy/introduction.mdx b/docs/docs/deploy/introduction.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /deploy/intro
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader
   title="Deploy Neosync"

diff --git a/docs/docs/deploy/kubernetes.mdx b/docs/docs/deploy/kubernetes.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /deploy/kubernetes
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader
   title="Deploy on Kubernetes"

diff --git a/docs/docs/overview/Introduction.mdx b/docs/docs/overview/Introduction.mdx
@@ -5,28 +5,16 @@ hide_title: true
 slug: /
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
-import { HeroImage } from '@site/src/components/HomepageFeatures/HeroImage.tsx';
-import { CustomCardList } from '@site/src/components/HomepageFeatures/CustomCardList.tsx';
-import { CustomCard } from '@site/src/components/HomepageFeatures/CustomCard.tsx';
 import {
-  PiArrowsSplitLight,
-  PiFlaskLight,
-  PiPlugsLight,
-  PiRocketLaunchLight,
-} from 'react-icons/pi';
-import { BsFunnel } from 'react-icons/bs';
-import { FaSync } from 'react-icons/fa';
-import { GrConnect } from 'react-icons/gr';
-import {
-  LightningBoltIcon,
   LayersIcon,
+  LightningBoltIcon,
   LinkBreak1Icon,
   StackIcon,
 } from '@radix-ui/react-icons';
-import { LuNetwork } from 'react-icons/lu';
-
-<DocPageHeader title="Welcome to the Neosync Docs" />
+import { CustomCard } from '@site/src/CustomComponents/CustomCard.tsx';
+import { CustomCardList } from '@site/src/CustomComponents/CustomCardList.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
+<DocPageHeader title="Welcome to the Neosync Docs" />;
 
 Neosync is an open-source, developer-first way to create safe, anonymized test data from production data and sync it across all environments for high-quality local, stage and CI testing.
 

diff --git a/docs/docs/overview/platform.mdx b/docs/docs/overview/platform.mdx
@@ -5,8 +5,7 @@ hide_title: true
 slug: /platform
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
-import { HeroImage } from '@site/src/components/HomepageFeatures/HeroImage.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Platform Overview" />
 

diff --git a/docs/docs/overview/use-cases/anonymization.mdx b/docs/docs/overview/use-cases/anonymization.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: anonymization
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Anonymization" />
 

diff --git a/docs/docs/overview/use-cases/replication.mdx b/docs/docs/overview/use-cases/replication.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: replication
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Replicate Data" />
 

diff --git a/docs/docs/overview/use-cases/subsetting.mdx b/docs/docs/overview/use-cases/subsetting.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: subsetting
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Subset Data" />
 

diff --git a/docs/docs/overview/use-cases/synthetic-data.mdx b/docs/docs/overview/use-cases/synthetic-data.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: synthetic-data
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Synthetic Data" />
 

diff --git a/docs/docs/transformers/custom.mdx b/docs/docs/transformers/custom.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /transformers/custom
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Custom" />
 

diff --git a/docs/docs/transformers/introduction.mdx b/docs/docs/transformers/introduction.mdx
@@ -5,7 +5,7 @@ hide_title: true
 slug: /transformers/introduction
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Transformers" />
 

diff --git a/docs/docs/transformers/pre-built/email.mdx b/docs/docs/transformers/pre-built/email.mdx
diff --git a/docs/docs/transformers/pre-built/phone.mdx b/docs/docs/transformers/pre-built/phone.mdx
diff --git a/docs/docs/transformers/pre-built/ssn.mdx b/docs/docs/transformers/pre-built/ssn.mdx
diff --git a/docs/docs/transformers/system/email.mdx b/docs/docs/transformers/system/email.mdx
@@ -0,0 +1,93 @@
+---
+title: Email
+id: email
+hide_title: true
+slug: /transformers/system/email
+---
+
+import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx';
+
+import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx';
+
+<TransformerPageHeader
+  title="Email"
+  type="string"
+  apiRef="https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/email.go"
+/>
+
+## Definition
+
+The email transformer can anonymize an existing email address or completely generate a new one. An email is made up of three parts:
+
+`<username>@<domain>.<top-level-domain>`
+
+By default, the transformer randomizes the username, domain and top-level domain while always preserving the email format by retaining the @ and . characters.
+
+For example, the following input value:
+`[email protected]`
+
+Would produce the following ouput value:
+`[email protected]`
+
+You can see we generated new privacy-safe values for the username and the domain. You can update this structure using the configurations below. Lastly, the email transformer takes in a `string` and returns a `string`.
+
+## Configurations
+
+Depending on your validations, you may want to configure the output email. The email transformer has the following configurations:
+
+<DocsTable
+  headers={[
+    'Name',
+    'Description',
+    'Default',
+    'Example Input',
+    'Example Output',
+  ]}
+  rowData={[
+    {
+      data: [
+        'PreserveDomain',
+        'Preserve Domain carries over the input domain to the output email address. This includes the domain and top-level domain.',
+        'false',
+        '[email protected]',
+        '[email protected]',
+      ],
+    },
+    {
+      data: [
+        'PreserveLength',
+        'Preserve Length will ensure that the output email address is the same length as the input email address. This includes the domain as well.',
+        'false',
+        '[email protected]',
+        '[email protected]',
+      ],
+    },
+  ]}
+/>
+
+## Examples
+
+There are several ways you can mix-and-match configurations to get different potential email formats. Here are some possible combinations:
+
+<DocsTable
+  headers={[
+    'PreserveLength',
+    'PreserveDomain',
+    'Example Input',
+    'Example Output',
+  ]}
+  rowData={[
+    {
+      data: ['false', 'true', '[email protected]', '[email protected]'],
+    },
+    {
+      data: ['true', 'false', '[email protected]', '[email protected]'],
+    },
+    {
+      data: ['true', 'true', '[email protected]', '[email protected]'],
+    },
+    {
+      data: ['false', 'false', '[email protected]', '[email protected]'],
+    },
+  ]}
+/>
diff --git a/docs/docs/transformers/system/phone.mdx b/docs/docs/transformers/system/phone.mdx
@@ -0,0 +1,12 @@
+---
+title: Phone
+id: phone
+hide_title: true
+slug: /transformers/system/phone
+---
+
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
+
+<DocPageHeader title="Phone" />
+
+## More coming soon!
diff --git a/...ansformers/pre-built/physical-address.mdx → .../transformers/system/physical-address.mdx b/...ansformers/pre-built/physical-address.mdx → .../transformers/system/physical-address.mdx
@@ -2,10 +2,10 @@
 title: Physical Address
 id: physical-address
 hide_title: true
-slug: /transformers/pre-built/physical-address
+slug: /transformers/system/physical-address
 ---
 
-import { DocPageHeader } from '@site/src/components/HomepageFeatures/DocPageHeader.tsx';
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
 
 <DocPageHeader title="Physical Address" />
 

diff --git a/docs/docs/transformers/system/ssn.mdx b/docs/docs/transformers/system/ssn.mdx
@@ -0,0 +1,12 @@
+---
+title: SSN
+id: ssn
+hide_title: true
+slug: /transformers/system/ssn
+---
+
+import { DocPageHeader } from '@site/src/CustomComponents/DocPageHeader.tsx';
+
+<DocPageHeader title="ssn" />
+
+## More coming soon!
diff --git a/docs/knip.ts b/docs/knip.ts
@@ -4,7 +4,7 @@ const config = {
     'docusaurus.config.js',
     'sidebars.js',
     'static/sync-dark-mode.js',
-    'src/components/HomepageFeatures/**',
+    'src/**',
     'src/theme/**',
   ],
   ignoreDependencies: [
@@ -13,9 +13,13 @@ const config = {
     '@radix-ui/react-icons',
     'autoprefixer',
     'postcss',
+    'node',
+    '@docusaurus/theme-classic',
     'prism-react-renderer',
     'react-icons',
     'tailwindcss',
+    'class-variance-authority',
+    'tailwind-merge',
   ],
   ignoreBinaries: [],
 };