Skip to content

improvements to getting started tutorial #5

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

improvements to getting started tutorial #5

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
819a9fe
improvements to tutorial
zuketo Nov 22, 2024
7caedb2
Update docs/tutorials/quick-start.mdx
zuketo Nov 25, 2024
50c0086
Update docs/tutorials/quick-start.mdx
zuketo Nov 25, 2024
2f65b08
Remove fun stuff section
zuketo Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 63 additions & 12 deletions docs/tutorials/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<img style={{marginLeft:'15px', marginBottom: '5px', height: '40px'}} src={ImgConnectionNav} />

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)._
<img style={{marginLeft:'15px', marginBottom: '5px', height: '140px'}} src={ImgDatabaseCard} />

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).

<img style={{marginLeft:'15px', marginBottom: '5px', height: '40px'}} src={ImgConnectionNav} />
<img style={{marginLeft:'15px', marginBottom: '5px', height: '140px'}} src={ImgKabob} />

Once your database shows up (usually within 30 seconds of adding your connection), click the `Explore` button.
---

## Managing Data

### Proposing Changes

<img style={{marginLeft:'15px', marginBottom: '5px', height: '140px'}} src={ImgDatabaseCard} />
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**.

<img style={{marginLeft:'15px', marginBottom: '5px', height: '140px'}} src={ImgKabob} />
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.
Copy link
Member

@aheckmann aheckmann Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Fun Stuff section should be deleted b/c it is not actionable.

Copy link
Member Author

@zuketo zuketo Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Removed


---

## 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! 😁