diff --git a/content/docs/manage/slack-app.md b/content/docs/manage/slack-app.md new file mode 100644 index 0000000000..6a8db16074 --- /dev/null +++ b/content/docs/manage/slack-app.md @@ -0,0 +1,118 @@ +--- +title: Neon Slack App +enableTableOfContents: true +subtitle: Track your Neon projects and organizations from Slack +--- + + +The Neon Slack App is coming soon! If you've already expressed interest, we'll email you as soon as it's ready. Otherwise, watch for it in our weekly [Changelog](/docs/changelog). + + +The Neon Slack App allows you to monitor your Neon usage and manage organization membership directly from Slack. Get quick access to project information and resource usage metrics without leaving your workspace. + + + +## Setup + + + +## Install the Neon Slack App + +1. Open Slack and navigate to the **Apps** section in the left sidebar. +2. Click **Add apps** and search for **Neon**. +3. Select the Neon Slack App and follow the prompts to install it. + +Once the app is installed, open a direct message with the Neon Slack App and type `/neon auth` to connect your Neon account. + + +If your Slack workspace is company-managed and doesn't allow third-party apps, you may need to request admin approval to install the Neon Slack App. Slack will notify you if admin approval is required. + + +## Authenticate with Neon + +1. Open a DM with the Neon Slack App in Slack. +2. Type `/neon auth` and follow the prompts to log in to your Neon account. + +Once authenticated, you're ready to use all available commands. + + + +## Available commands + +| **Command** | **Description** | +| ----------------------- | --------------------------------------------------------------------- | +| `/neon auth` | Log in to your Neon account | +| `/neon projects` | List all your accessible projects | +| `/neon usage` | View your overall resource usage (compute, storage, transfer) | +| `/neon help` | Show all available commands | +| `/neon status` | Check Neon's system status | +| `/neon feedback` | Share your thoughts to improve the Neon Slack App | +| `/neon projects usage` | View resource usage for a specific project | +| `/neon projects shared` | See projects others have shared with you | +| `/neon set org` | Set which organization's data you want to view in subsequent commands | +| `/neon find org` | Display which organization is currently set as your active context | +| `/neon clear org` | Reset your context back to your personal account view | +| `/neon invite user` | Invite a user to your organization. | + +## Example workflows + +### Check your Neon usage statistics + +Open a DM with the Neon Slack App and run the following command to instantly view your current data transfer, compute time, and storage usage across all projects: + +``` +/neon usage +``` + +results of /neon usage showing compute, storage, and data transfer + +### Switching between organizations + +To take actions on behalf of a specific organization, set your context using the following command: + +```bash +/neon set org +``` + +When finished, you can return to your personal view by clearing your defaults: + +```bash +/neon clear org +``` + +### Usage notifications + +In addition to checking usage on demand, the Neon Slack App will automatically notify you when you approach or reach your resource limits for compute hours, storage, or data transfer. + +## FAQs + +
+**What can I do with the Neon Slack App?** + +The Neon Slack App allows you to: + +- View project information and resource usage +- Monitor system status +- Manage organization membership +- Access shared projects +- Switch between organizations + +
+ +
+**Does this app allow me to modify databases or projects?** + +No, the Neon Slack App is primarily for viewing usage details and managing organization membership, not for direct database management. + +
+ +
+**Can I control which notifications I receive?** + +Currently, all users receive usage limit notifications. There's no way to customize notification preferences within the Slack App. + +
diff --git a/public/docs/manage/slack_app_overview.png b/public/docs/manage/slack_app_overview.png new file mode 100644 index 0000000000..0ebc314e1b Binary files /dev/null and b/public/docs/manage/slack_app_overview.png differ diff --git a/public/docs/manage/slack_app_usage.png b/public/docs/manage/slack_app_usage.png new file mode 100644 index 0000000000..5becfadc80 Binary files /dev/null and b/public/docs/manage/slack_app_usage.png differ