From 819a9fe80906b210d6ac5cd3dc45f2afb6ac5e1f Mon Sep 17 00:00:00 2001 From: Jason Zucchetto Date: Fri, 22 Nov 2024 13:31:48 -0800 Subject: [PATCH 1/4] improvements to tutorial --- docs/tutorials/quick-start.mdx | 75 ++++++++++++++++++++++++++++------ 1 file changed, 63 insertions(+), 12 deletions(-) diff --git a/docs/tutorials/quick-start.mdx b/docs/tutorials/quick-start.mdx index 7e2e412..0a09c59 100644 --- a/docs/tutorials/quick-start.mdx +++ b/docs/tutorials/quick-start.mdx @@ -12,28 +12,79 @@ import ImgKabob from '@site/static/img/data-explorer-kabob.png' Discover what Sort offers **in just 5 minutes** by following this brief guide. +--- + ## Getting Started -First, log-in to [Sort](https://sort.xyz) and [Create your first Organization](/docs/organizations/creating-an-organization). +1. **Log in to [Sort](https://sort.xyz)** and [Create your first Organization](/docs/organizations/creating-an-organization). + +2. **Add your database connection:** + Connect to your database by following the [Add a New Database Connection guide](/docs/database-connections/add-new-database-connection). + _If you're using Neon Serverless Postgres, [check out this specific guide](/docs/tutorials/neon-add-connection)._ + +3. **Access your Organization:** + Once connected, visit your [Organization page](/docs/organizations/organizations) by clicking your Org name in the top navigation bar. + + + +4. **Explore your database:** + Within 30 seconds of adding your connection, your database will show up. Click the `Explore` button to dive in! -Next, [add your database connection](/docs/database-connections/add-new-database-connection). _For Neon Serverless Postgres, [follow this guide](/docs/tutorials/neon-add-connection)._ + -After adding your connection, visit your [Organization](/docs/organizations/organizations) page by clicking your Org name in the top nav. +5. **Create an Issue:** + - In the [Data Explorer](/docs/data-explorer/data-explorer), click the Kabob button (the three dots). + - Select `Create Issue`, fill in the necessary details, and submit your first [Issue](/docs/category/issues). - + -Once your database shows up (usually within 30 seconds of adding your connection), click the `Explore` button. +--- + +## Managing Data + +### Proposing Changes - +1. **Visit the Data Explorer:** + Use the `Explore` button or navigate to 'Data Explorer' via the left-hand menu. -In the [Data Explorer](/docs/data-explorer/data-explorer), click the Kabob button (the three dots) and choose `Create Issue`. +2. **Editing Existing Data:** + - Click the `Edit` button next to the row you want to modify. + - Suggest your changes, then create a **Change Request**. - +3. **Adding New Rows:** + - Scroll to the bottom of the table and click `Add Row`. + - Fill in the new data and submit a **Change Request**. + +4. **Removing Data:** + - Use the `Edit` button on the relevant row, propose a removal, and submit a **Change Request**. + +--- -Fill in any additional details you like and then submit your first [Issue](/docs/category/issues). +### What Are Change Requests? 🎉 + +If you're familiar with GitHub Pull Requests, think of **Change Requests** as a similar workflow for making database changes. +- **Approval Required:** Changes are not applied to the database until a team member approves them. +- **Data Quality Matters:** By using **Change Requests**, Sort adopts engineering best practices to ensure your data remains accurate and reliable. + +--- + +## Fun Stuff! 🎉 + +- **Manage Workflows:** Relate Issues to Change Requests for streamlined operations. +- **Collaborate with Teams:** Use Sort's tools for Customer Support, Data Teams, Internal Operations, or Community Managers. + +--- + +## Need Help? + +- Use the chat icon in the bottom-right corner of the screen. +- Email us at [info@sort.xyz](mailto:info@sort.xyz). + +--- -Wow, that's the end of this walk-through already - Congrats! 😁 +## Next Steps -## Next steps +- **Try Editing an Issue:** Instead of creating a new one, modify an existing one to explore more functionality. +- **Add a New Row:** Challenge yourself by learning how to [submit a Change Request](/docs/change-requests/submit-a-change-request). -Try editing an issue instead of choosing `Create Issue`, or see if you can figure out how to [add a new row](/docs/change-requests/submit-a-change-request). +Congrats, you're all set to get started with Sort! 😁 From 7caedb2d88271aba021d97994138c056fd38e108 Mon Sep 17 00:00:00 2001 From: Jason Zucchetto Date: Mon, 25 Nov 2024 14:06:30 -0800 Subject: [PATCH 2/4] Update docs/tutorials/quick-start.mdx Co-authored-by: Aaron Heckmann --- docs/tutorials/quick-start.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/quick-start.mdx b/docs/tutorials/quick-start.mdx index 0a09c59..1033033 100644 --- a/docs/tutorials/quick-start.mdx +++ b/docs/tutorials/quick-start.mdx @@ -64,7 +64,7 @@ Discover what Sort offers **in just 5 minutes** by following this brief guide. If you're familiar with GitHub Pull Requests, think of **Change Requests** as a similar workflow for making database changes. - **Approval Required:** Changes are not applied to the database until a team member approves them. -- **Data Quality Matters:** By using **Change Requests**, Sort adopts engineering best practices to ensure your data remains accurate and reliable. +- **Data Quality Matters:** By using **Change Requests**, Sort adopts software engineering best practices to ensure your data remains accurate and reliable. --- From 50c008680c94eb17447d648bc7f56b906d199b93 Mon Sep 17 00:00:00 2001 From: Jason Zucchetto Date: Mon, 25 Nov 2024 14:06:50 -0800 Subject: [PATCH 3/4] Update docs/tutorials/quick-start.mdx Co-authored-by: Aaron Heckmann --- docs/tutorials/quick-start.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/quick-start.mdx b/docs/tutorials/quick-start.mdx index 1033033..e2468ee 100644 --- a/docs/tutorials/quick-start.mdx +++ b/docs/tutorials/quick-start.mdx @@ -63,7 +63,7 @@ Discover what Sort offers **in just 5 minutes** by following this brief guide. ### What Are Change Requests? 🎉 If you're familiar with GitHub Pull Requests, think of **Change Requests** as a similar workflow for making database changes. -- **Approval Required:** Changes are not applied to the database until a team member approves them. +- **Approval Required:** Changes cannot be applied to the database until a team member approves them. - **Data Quality Matters:** By using **Change Requests**, Sort adopts software engineering best practices to ensure your data remains accurate and reliable. --- From 2f65b08322751fb3e0fa13d0d618bbdc42b4b430 Mon Sep 17 00:00:00 2001 From: Jason Zucchetto Date: Mon, 25 Nov 2024 14:09:53 -0800 Subject: [PATCH 4/4] Remove fun stuff section --- docs/tutorials/quick-start.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/tutorials/quick-start.mdx b/docs/tutorials/quick-start.mdx index e2468ee..2d806d6 100644 --- a/docs/tutorials/quick-start.mdx +++ b/docs/tutorials/quick-start.mdx @@ -68,13 +68,6 @@ If you're familiar with GitHub Pull Requests, think of **Change Requests** as a --- -## Fun Stuff! 🎉 - -- **Manage Workflows:** Relate Issues to Change Requests for streamlined operations. -- **Collaborate with Teams:** Use Sort's tools for Customer Support, Data Teams, Internal Operations, or Community Managers. - ---- - ## Need Help? - Use the chat icon in the bottom-right corner of the screen.