NEOS-1109: Docs seo (#2023)

nucleuscloud · May 24, 2024 · e5b89c6 · e5b89c6
1 parent 994ddca
commit e5b89c6
Show file tree

Hide file tree

Showing 47 changed files with 72 additions and 4 deletions.
diff --git a/docs/cspell.json b/docs/cspell.json
@@ -77,7 +77,20 @@
     "Quickstart",
     "llms",
     "cust",
-    "VARCHAR"
+    "VARCHAR",
+    "llmprompt",
+    "datasubsetting",
+    "orches",
+    "DPDP",
+    "circref",
+    "circdeps",
+    "foreignkey",
+    "foreignkeyhover",
+    "fkhover",
+    "foreignkey",
+    "fkref",
+    "circref",
+    "subsetimg"
   ],
   "flagWords": ["hte"],
   "files": ["blog/**/*.md*", "docs/**/*.md*"],

diff --git a/docs/docs/cli/accounts/list.mdx b/docs/docs/cli/accounts/list.mdx
@@ -1,5 +1,6 @@
 ---
 title: List
+description: Learn how to list Neosync accounts with the neosync accounts list command.
 id: list
 hide_title: false
 slug: /cli/accounts/list

diff --git a/docs/docs/cli/accounts/switch.mdx b/docs/docs/cli/accounts/switch.mdx
@@ -1,5 +1,6 @@
 ---
 title: Switch
+description: Learn how to switch accounts with the neosync accounts switch command.
 id: switch
 hide_title: false
 slug: /cli/accounts/switch

diff --git a/docs/docs/cli/installing.mdx b/docs/docs/cli/installing.mdx
@@ -1,5 +1,6 @@
 ---
 title: Installing
+description: Learn how to trigger a Neosync job with the neosync jobs trigger command.
 id: installing
 hide_title: false
 slug: /cli/installing

diff --git a/docs/docs/cli/introduction.mdx b/docs/docs/cli/introduction.mdx
@@ -1,5 +1,6 @@
 ---
 title: Introduction
+description: This section details Neosync CLI and all of its available commands.
 id: intro
 hide_title: false
 slug: /cli/introduction

diff --git a/docs/docs/cli/jobs/list.mdx b/docs/docs/cli/jobs/list.mdx
@@ -1,5 +1,6 @@
 ---
 title: List
+description: Learn how to list Neosync jobs with the neosync jobs list command.
 id: list
 hide_title: false
 slug: /cli/jobs/list

diff --git a/docs/docs/cli/jobs/trigger.mdx b/docs/docs/cli/jobs/trigger.mdx
@@ -1,5 +1,6 @@
 ---
 title: Trigger
+description: Learn how to trigger a Neosync job with the neosync jobs trigger command.
 id: trigger
 hide_title: false
 slug: /cli/jobs/trigger

diff --git a/docs/docs/cli/login.mdx b/docs/docs/cli/login.mdx
@@ -1,5 +1,6 @@
 ---
 title: login
+description: Learn how to login to neosync via the neosync login command.
 id: login
 hide_title: false
 slug: /cli/login

diff --git a/docs/docs/cli/sync.mdx b/docs/docs/cli/sync.mdx
@@ -1,5 +1,6 @@
 ---
 title: sync
+description: Learn how to sync data to a local destination with the neosync sync CLI command.
 id: sync
 hide_title: false
 slug: /cli/sync

diff --git a/docs/docs/cli/version.mdx b/docs/docs/cli/version.mdx
@@ -1,5 +1,6 @@
 ---
 title: Version
+description: Learn how to view the Neosync CLI Version with the neosync version command and neosync --version flag.
 id: version
 hide_title: false
 slug: /cli/version

diff --git a/docs/docs/cli/whoami.mdx b/docs/docs/cli/whoami.mdx
@@ -1,5 +1,6 @@
 ---
 title: whoami
+description: Learn how to display the currently logged in user with the neosync whoami CLI command.
 id: whoami
 hide_title: true
 slug: /cli/whoami

diff --git a/docs/docs/connections/mysql.md b/docs/docs/connections/mysql.md
@@ -1,12 +1,15 @@
 ---
 title: Mysql
+description: Neosync supports most Mysql-compatible databases natively using the Mysql connection.
 id: mysql
 hide_title: false
 slug: /connections/mysql
 ---
 
 Neosync is an open-source, developer-first product that allows you to create anonymized, secure test data that you can sync across all of your environments for high quality local, stage and CI testing.
 
+Neosync supports most Mysql-compatible databases natively using the Mysql connection.
+
 ## MySQL Database Connection Configuration
 
 ![mysql](https://assets.nucleuscloud.com/neosync/docs/mysql.png)

diff --git a/docs/docs/connections/postgres.md b/docs/docs/connections/postgres.md
@@ -1,5 +1,6 @@
 ---
 title: PostgreSQL
+description: Postgres is one of the most commonly used databases in the world and Neosync natively supports most postgres-compatible databases.
 id: postgres
 hide_title: false
 slug: /connections/postgres

diff --git a/docs/docs/connections/s3.md b/docs/docs/connections/s3.md
@@ -1,5 +1,6 @@
 ---
 title: S3
+description: Learn how to use Neosync to sync data from a database to AWS S3
 id: s3
 hide_title: false
 slug: /connections/s3

diff --git a/docs/docs/deploy/authentication.md b/docs/docs/deploy/authentication.md
@@ -1,5 +1,6 @@
 ---
 title: Authentication
+description: Learn how to configure and maintain authentication within Neosync open source
 id: auth
 hide_title: false
 slug: /deploy/authentication

diff --git a/docs/docs/deploy/docker-compose.md b/docs/docs/deploy/docker-compose.md
@@ -1,5 +1,6 @@
 ---
 title: Docker Compose
+description: Learn how to deploy Neosync using Docker compose for a better local developer experience
 id: docker-compose
 hide_title: false
 slug: /deploy/docker-compose

diff --git a/docs/docs/deploy/environment-variables.md b/docs/docs/deploy/environment-variables.md
@@ -1,5 +1,6 @@
 ---
 title: Environment Variables
+description: A listing of the environment variables that Neosync uses to work locally and in production
 id: env-vars
 hide_title: false
 slug: /deploy/environment-variables

diff --git a/docs/docs/deploy/introduction.mdx b/docs/docs/deploy/introduction.mdx
@@ -1,5 +1,6 @@
 ---
 title: Introduction
+description: Learn how to Deploy Neosync locally and in Production with hands-on guides
 id: intro
 hide_title: false
 slug: /deploy/introduction

diff --git a/docs/docs/deploy/kubernetes.md b/docs/docs/deploy/kubernetes.md
@@ -1,5 +1,6 @@
 ---
 title: Kubernetes
+description: The Kubernetes guide covers how to deploy Neosync specific resources.
 id: kubernetes
 hide_title: false
 slug: /deploy/kubernetes

diff --git a/docs/docs/guides/ai-synthetic-data-generation.md b/docs/docs/guides/ai-synthetic-data-generation.md
@@ -1,5 +1,6 @@
 ---
 title: AI Synthetic Data Generation
+description: Learn how to use AI to generate realistic synthetic data using any LLM provider such as OpenAI, Anthropic, Gemini and more
 id: ai-synthetic-data-generation
 hide_title: false
 slug: /guides/ai-synthetic-data-generation

diff --git a/docs/docs/guides/analytics.md b/docs/docs/guides/analytics.md
@@ -1,5 +1,6 @@
 ---
 title: Configuring Analytics
+description: Learn how to configure analytics within Neosync open source and turn it off or not based on your preferences
 id: analytics
 hide_title: false
 slug: /guides/analytics

diff --git a/docs/docs/guides/creating-a-custom-code-transformer.md b/docs/docs/guides/creating-a-custom-code-transformer.md
@@ -1,5 +1,6 @@
 ---
 title: Creating a Custom Code Transformer
+description: Learn how to create a custom code transformer that you can use to implement your own anonymization and synthetic data logic
 id: custom-code-transformers
 hide_title: false
 slug: /guides/custom-code-transformers

diff --git a/docs/docs/guides/creating-a-data-gen-job.md b/docs/docs/guides/creating-a-data-gen-job.md
@@ -1,5 +1,6 @@
 ---
 title: Creating a Data Generation Job
+description: Learn how to create a data generation job in Neosync which allows you to generate synthetic data from scratch
 id: creating-a-data-gen-job
 hide_title: false
 slug: /guides/creating-a-data-gen-job

diff --git a/docs/docs/guides/creating-a-sync-job.md b/docs/docs/guides/creating-a-sync-job.md
@@ -1,5 +1,6 @@
 ---
 title: Creating a Sync Job
+description: Learn how to create a data sync job to anonymize and transform data from a source database to one or multiple destination databases
 id: creating-a-sync-job
 hide_title: false
 slug: /guides/creating-a-sync-job
@@ -11,7 +12,7 @@ In this guide we will walk through how to create a [sync job](/core-concepts#job
 
 1. Syncing and anonymizing prod data to lower level environments
 2. Syncing data between two lower level environments with no transformations
-3. Syncing and anonymizing data to be used for analytical and machine learning usecases such as training a model
+3. Syncing and anonymizing data to be used for analytical and machine learning use cases such as training a model
 
 ## Creating a Sync Job
 

diff --git a/docs/docs/guides/initializing-schemas.md b/docs/docs/guides/initializing-schemas.md
@@ -1,5 +1,6 @@
 ---
 title: Initializing your Schema
+description: Learn how to use Neosync to initialize your schema in your destination database to make it easier to hydrate your database with data
 id: initializing-your-schema
 hide_title: false
 slug: /guides/initializing-schemas
@@ -18,7 +19,7 @@ This can potentially have some issues if you have a lot of migrations or if your
 If your migrations are any of the following you may run into issues:
 
 - Not Idempotent, meaning that running the migration multiple times (or against a completely blank/fresh database) will cause issues
-- Have hard coded database names (if you are choosing to run neosync against a separate logical database in your single instance)
+- Have hard coded database names (if you are choosing to run Neosync against a separate logical database in your single instance)
 - Edit database users, global configurations or other settings that are not related to the schema/data
 
 Some of the above issues can be resolved by choosing to run your migrations against a completely fresh database.

diff --git a/docs/docs/guides/neosync-local-dev.md b/docs/docs/guides/neosync-local-dev.md
@@ -1,5 +1,6 @@
 ---
 title: Developing Neosync Locally
+description: Learn how to develop with Neosync Open Source locally in order to get up to speed with how Neosync works
 id: neosync-local-dev
 hide_title: false
 slug: /guides/neosync-local-dev

diff --git a/docs/docs/guides/terraform.md b/docs/docs/guides/terraform.md
@@ -1,5 +1,6 @@
 ---
 title: Configuring Neosync with Terraform
+description: Learn how to use Neosync's Terraform provider within your GitOps flow to manage your Terraform infrastructure
 id: terraform
 hide_title: false
 slug: /guides/terraform

diff --git a/docs/docs/guides/troubleshooting.md b/docs/docs/guides/troubleshooting.md
@@ -1,5 +1,6 @@
 ---
 title: Troubleshooting Neosync Jobs
+description: Learn how to troubleshoot common errors in Neosync with this guide
 id: troubleshooting
 hide_title: false
 slug: /guides/troubleshooting

diff --git a/docs/docs/guides/using-custom-llm-transformer.md b/docs/docs/guides/using-custom-llm-transformer.md
@@ -1,5 +1,6 @@
 ---
 title: Using a Custom LLM Transformer
+description: Learn how to use a custom LLM transformer in Neosync in order to call an LLM on every row to generate data or anonymize existing data
 id: using-custom-llm-transformer
 hide_title: false
 slug: /guides/using-custom-llm-transformer

diff --git a/docs/docs/guides/using-neosync-in-your-CI.md b/docs/docs/guides/using-neosync-in-your-CI.md
@@ -1,5 +1,6 @@
 ---
 title: Using Neosync in CI
+description: Learn how to use Neosync in your CI pipelines in order to hydrate your CI databases with anonymized production data
 id: using-neosync-in-ci
 hide_title: false
 slug: /guides/using-neosync-in-ci

diff --git a/docs/docs/overview/core-concepts.mdx b/docs/docs/overview/core-concepts.mdx
@@ -1,5 +1,6 @@
 ---
 title: Core Concepts
+description: The best way to learn about Neosync is to understand the core concepts of the platform.
 id: core-concepts
 hide_title: false
 slug: /core-concepts

diff --git a/docs/docs/overview/core-features.mdx b/docs/docs/overview/core-features.mdx
@@ -1,5 +1,6 @@
 ---
 title: Core Features
+description: Learn about the core anonymization, synthetic data, orchestration and subsetting features of the Neosync platform
 id: core-features
 hide_title: false
 slug: /core-features

diff --git a/docs/docs/overview/introduction.mdx b/docs/docs/overview/introduction.mdx
@@ -1,5 +1,6 @@
 ---
 title: Introduction
+description: Neosync is an open-source, developer-first way to anonymize PII, generate synthetic data and sync environments for better testing, debugging and developer experience
 id: intro
 hide_title: false
 slug: /

diff --git a/docs/docs/overview/platform.mdx b/docs/docs/overview/platform.mdx
@@ -1,5 +1,6 @@
 ---
 title: Platform
+description: Learn about component in the Neosync system and where it fits in the overall architecture
 id: platform
 hide_title: false
 slug: /platform

diff --git a/docs/docs/overview/quickstart.mdx b/docs/docs/overview/quickstart.mdx
@@ -1,5 +1,6 @@
 ---
 title: Quick start
+description: Learn how to seed a PostgreSQL database with synthetic data for better data security and privacy
 id: quickstart
 hide_title: false
 slug: /quickstart

diff --git a/docs/docs/overview/security-overview.mdx b/docs/docs/overview/security-overview.mdx
@@ -1,5 +1,6 @@
 ---
 title: Neosync Cloud Security Overview
+description: Learn how Neosync Cloud is secured and the security principles of the Neosync Platform
 id: cloud-security-overview
 hide_title: false
 slug: /cloud-security-overview
@@ -8,6 +9,7 @@ slug: /cloud-security-overview
 At Neosync, we take as many security precautions as we can to ensure that any information saved on our server is safe.
 
 This section will document a few different things that we feel are worth mentioning from a security perspective.
+
 This page is mostly relevant to Neosync Cloud.
 
 ## Code

diff --git a/docs/docs/overview/use-cases.mdx b/docs/docs/overview/use-cases.mdx
@@ -1,5 +1,6 @@
 ---
 title: Use cases
+description: Learn about the main use-cases of Neosync from anonymizing production data to subsetting data
 id: usecases
 hide_title: false
 slug: /usecases

diff --git a/docs/docs/table-constraints/circular-dependencies.mdx b/docs/docs/table-constraints/circular-dependencies.mdx
@@ -1,5 +1,6 @@
 ---
 title: Circular Dependencies
+description: Learn how Neosync handles circular dependencies when anonymizing and subsetting data
 id: circular-dependencies
 hide_title: false
 slug: /table-constraints/circular-dependencies

diff --git a/docs/docs/table-constraints/foreign-keys.mdx b/docs/docs/table-constraints/foreign-keys.mdx
@@ -1,5 +1,6 @@
 ---
 title: Foreign Keys
+description: Learn how Neosync handles foreign keys when anonymizing and subsetting data
 id: foreign-keys
 hide_title: false
 slug: /table-constraints/foreign-keys

diff --git a/docs/docs/table-constraints/subsetting.mdx b/docs/docs/table-constraints/subsetting.mdx
@@ -1,5 +1,6 @@
 ---
 title: Subsetting
+description: Learn how Neosync subsets data for a better local development experience
 id: subsetting
 hide_title: false
 slug: /table-constraints/subsetting

diff --git a/docs/docs/transformers/introduction.mdx b/docs/docs/transformers/introduction.mdx
@@ -1,5 +1,6 @@
 ---
 title: Introduction
+description: Learn about Neosync transformers and how you can use them to anonymize data and generate synthetic data
 id: introduction
 hide_title: false
 slug: /transformers/introduction

diff --git a/docs/docs/transformers/system.md b/docs/docs/transformers/system.md
@@ -1,5 +1,6 @@
 ---
 title: System Transformers
+description: Learn about Neosync's system transformers that come out of the box and help anonymize data and generate synthetic data
 id: system
 hide_title: false
 slug: /transformers/system

diff --git a/docs/docs/transformers/user-defined.mdx b/docs/docs/transformers/user-defined.mdx
@@ -1,5 +1,6 @@
 ---
 title: User Defined Transformers
+description: Learn about Neosync's user defined transformers and how you can create one to implement custom anonymization logic
 id: user-defined
 hide_title: false
 slug: /transformers/user-defined

diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
@@ -6,7 +6,7 @@ import { themes } from 'prism-react-renderer';
 
 const config: Config = {
   title: 'Neosync',
-  tagline: 'Open source Test Data Management',
+  tagline: 'Open source Data Anonymization and Synthetic Data',
   favicon: 'img/logo_light_mode.png',
   headTags: [
     {
@@ -109,6 +109,13 @@ const config: Config = {
   ],
 
   themeConfig: {
+    metadata: [
+      {
+        name: 'keywords',
+        content:
+          'open source, anonymization, data anonymization, synthetic data, data privacy, data security',
+      },
+    ],
     image: 'img/docsOG.png',
     colorMode: {
       defaultMode: 'light',

diff --git a/docs/protos/go.md b/docs/protos/go.md
@@ -1,5 +1,6 @@
 ---
 title: Neosync for Go
+description: Learn about Neosync's Go SDK and how you can use it to anonymize data and generate synthetic data
 id: go
 hide_title: false
 slug: /go

diff --git a/docs/protos/home.md b/docs/protos/home.md
@@ -1,5 +1,6 @@
 ---
 title: APIs and SDKs
+description: Learn about Neosync's APIs and SDKs in order to anonymize data and generate synthetic data
 hide_title: false
 id: home
 slug: /

diff --git a/docs/protos/typescript.md b/docs/protos/typescript.md
@@ -1,5 +1,6 @@
 ---
 title: Neosync for TypeScript
+description: Learn about Neosync's Typescript SDK and how you can use it to anonymize data and generate synthetic data
 id: typescript
 hide_title: false
 slug: /typescript