added zip code and utc to docs

nucleuscloud · Nov 13, 2023 · ba785ba · ba785ba
1 parent 28c1b28
commit ba785ba
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 1 deletion.
diff --git a/docs/docs/transformers/system/state.mdx b/docs/docs/transformers/system/state.mdx
@@ -17,7 +17,7 @@ import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx';
 
 ## Definition
 
-The state transformer generates a randomly selected US state. You can see the complete list of cities that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json).
+The state transformer generates a randomly selected US state. You can see the complete list of states that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json).
 
 If you'd rather not get back a real state value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value.
 

diff --git a/docs/docs/transformers/system/zipcode.mdx b/docs/docs/transformers/system/zipcode.mdx
@@ -0,0 +1,42 @@
+---
+title: Zipcode
+id: zipcode
+hide_title: true
+slug: /transformers/system/zipcode
+---
+
+import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx';
+
+import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx';
+
+<TransformerPageHeader
+  title="Zipcode"
+  type="string"
+  apiRef="https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/zipcode.go"
+/>
+
+## Definition
+
+The zipcode transformer generates a randomly selected US zipcode. You can see the complete list of zipcodes that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json).
+
+If you'd rather not get back a real zipcode value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value.
+
+## Configurations
+
+There are no configurations for the zipcode transformer.
+
+## Examples
+
+Here are some examples of what an output zipcode value may look like.
+
+<DocsTable
+  headers={['Example Input', 'Example Output']}
+  rowData={[
+    {
+      data: ['87932', '27563'],
+    },
+    {
+      data: ['78232', '90237'],
+    },
+  ]}
+/>
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -216,6 +216,11 @@ const sidebars = {
           id: 'transformers/system/uuid',
           label: 'UUID',
         },
+        {
+          type: 'doc',
+          id: 'transformers/system/zipcode',
+          label: 'Zipcode',
+        },
       ],
     },
     {

diff --git a/docs/src/theme/DocSidebarItem/Link/index.js b/docs/src/theme/DocSidebarItem/Link/index.js
@@ -23,6 +23,7 @@ import {
   BsFillKeyFill,
   BsFunnel,
   BsGenderAmbiguous,
+  BsPinMap,
   BsShieldCheck,
 } from 'react-icons/bs';
 import {
@@ -169,6 +170,8 @@ export const RenderIcon = (name) => {
       return <BsCalendarDate />;
     case 'UUID':
       return <BsFillKeyFill />;
+    case 'Zipcode':
+      return <BsPinMap />;
     default:
       return <LayersIcon />;
   }