Skip to content

Commit 09a2e29

Browse files
quetzalliwritesHarshCasperremotesynth
authored
docs: launch v2 Help & Support experience for snow docs (#435)
Co-authored-by: HarshCasper <erbeusgriffincasper@gmail.com> Co-authored-by: Brian Rinaldi <brian.rinaldi@gmail.com>
1 parent 754027b commit 09a2e29

File tree

11 files changed

+411
-197
lines changed

11 files changed

+411
-197
lines changed

astro.config.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,11 @@ export default defineConfig({
560560
label: 'Changelog',
561561
slug: 'snowflake/changelog',
562562
},
563+
{
564+
label: 'Help & Support',
565+
collapsed: true,
566+
autogenerate: { directory: '/snowflake/help-support' },
567+
},
563568
],
564569
},
565570
{

public/js/icon-loader.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
Changelog: 'change-icon',
1919
'SQL Functions': 'sql-icon',
2020
'Licensing & Tiers': 'pricing-icon',
21+
'Help & Support': 'help-icon',
2122
};
2223

2324
let sidebarRaf = 0;
@@ -144,7 +145,7 @@
144145
return true;
145146
}
146147
const leftNavSelect = document.querySelector(
147-
'starlight-multi-sidebar-select select'
148+
'starlight-multi-sidebar-select select',
148149
);
149150
if (!leftNavSelect) {
150151
return false;
Lines changed: 3 additions & 0 deletions
Loading

src/content/docs/snowflake/getting-started/faq.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,6 @@ If you are encountering network issues and your Snowflake client drivers are una
4646

4747
## Support FAQs
4848

49-
### How can I get help with LocalStack for Snowflake?
49+
### How can I get help or support with LocalStack for Snowflake?
5050

51-
LocalStack for Snowflake is now GA. To get help, you can join the [Slack community](https://localstack.cloud/slack) and share your feedback, questions, and suggestions with the LocalStack team on the `#help` channel.
52-
53-
If your team is using LocalStack for Snowflake, you can also request support by [contacting us](https://localstack.cloud/contact) or
54-
[opening a GitHub Discussion](https://github.com/orgs/localstack/discussions).
51+
If you're experiencing an issue with LocalStack for Snowflake, read our [Help & Support Guide](https://docs.localstack.cloud/snowflake/help-support/) for developers and enterprise teams.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Enterprise Support
3+
description: How to request Enterprise Support for LocalStack for Snowflake.
4+
template: doc
5+
sidebar:
6+
order: 4
7+
tags: ["Enterprise"]
8+
---
9+
10+
## Introduction
11+
12+
Enterprise support offers organizations personalized resources, direct communication channels with the LocalStack team, and flexible service level agreements (SLAs) to meet specific business requirements.
13+
14+
The key components of our enterprise support offering include:
15+
16+
- **Direct Slack Connect or Teams Channel**: A dedicated Slack Connect or Teams channel is available to maintain a direct communication link with the LocalStack engineering team. This setup ensures quick issue resolution and streamlined collaboration, improving overall service efficiency.
17+
- **Dedicated Customer Success Manager (CSM) and Technical Account Manager (TAM)**: Enterprise customers are assigned a CSM and SA.
18+
The CSM acts as a strategic advisor to help fully utilize LocalStack's offerings, while the SA provides expert technical assistance in designing and optimizing solutions tailored to your needs.
19+
- **Custom Service Level Agreements (SLAs)**: Tailor your service levels and response times to meet your organization's requirements.
20+
Custom SLAs can be negotiated to align with your business objectives and ensure optimal system performance.
21+
- **Support Ticketing Portal**: Access the [support ticketing portal](https://support.localstack.cloud/portal) to view, create, and respond to support tickets, ensuring organized tracking of all queries.
22+
- **Real-time Chat Support**: Real-time Level 1 (L1) chat support is available during support operating hours.
23+
While immediate resolutions are prioritized, complex issues may require additional time and resources for thorough handling.
24+
25+
## Customer portal
26+
27+
A customer portal is a home behind a login where customers can view, open, and reply to their support tickets.
28+
Currently, the **customer portal** is only **available to Enterprise customers**.
29+
30+
You can find the customer portal here: [https://support.localstack.cloud/portal](https://support.localstack.cloud/portal).
31+
32+
![Customer portal for enterprise support](/images/aws/customer-portal.png)
33+
34+
## Signing up for Enterprise Support
35+
36+
If you are a member of an organization with an enterprise LocalStack subscription, you will receive an invitation to create an account and join the LocalStack Support Portal via email.
37+
38+
Follow the instructions in the email and set up your account by clicking on the **Sign up** button.
39+
You will be asked to create a password.
40+
41+
Once you do so, you will be able to log in and start using the customer portal to create, view, and engage with tickets.
42+
43+
## Creating a Support Ticket
44+
45+
You can open a new ticket with LocalStack support by going to the **Create a Support Ticket** link.
46+
47+
You will be redirected to a form where you will have to provide certain information to file a new support ticket.
48+
49+
![Filing a support ticket](/images/aws/file-a-support-ticket.png)
50+
51+
The form consists of two parts. One is basic information, which is mandatory to fill out, and additional information, which adds more context to your issue but is not mandatory. Once all the mandatory fields are filled out, you can create a new support ticket by clicking on the Submit button.
52+
53+
When the ticket is submitted, it's reported to LocalStack support, who will get back to you on that query as soon as possible. A ticket will show up in the ticket list as soon as it’s submitted.
54+
55+
### Basic Information
56+
57+
You need to fill out the following fields, which are mandatory to open a new ticket:
58+
59+
- **Type**: Choose the type of your query from the following options:
60+
- **Issue**: Select this when you are facing an issue using LocalStack.
61+
- **General inquiry**: Select this when you have a general question regarding LocalStack.
62+
- **Feature request**: Select this when you are looking for a feature that is not yet implemented in LocalStack.
63+
- **Ticket name**: Provide a descriptive name for the ticket that summarizes your inquiry.
64+
- **Description**: Provide a comprehensive description of your inquiry, explaining all the details that will help us understand your query.
65+
66+
### Additional Information
67+
68+
- **CI Issue?** If the query is related to a CI issue, select the one that best fits your query from the dropdown.
69+
- **Operating system**: From the dropdown, select the operating system you are using.
70+
- **Affected Services**: From the dropdown, select the AWS service that is affected in your query.
71+
- **File upload**: Here you can provide any additional files that you believe would be helpful for LocalStack support (e.g., screenshots, log files, etc.).
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Get Help
3+
description: Choose the right support channel for your LocalStack issue or question.
4+
template: doc
5+
sidebar:
6+
order: 1
7+
---
8+
9+
If you need help with LocalStack, choosing the right support channel can help you get a faster and more effective response.
10+
11+
This guide explains when to use each available support option.
12+
13+
14+
## Choose the right support channel
15+
16+
### Community Slack
17+
18+
Use the [LocalStack Slack Community](https://localstack.cloud/slack) for:
19+
20+
- Quick questions
21+
- General guidance
22+
- Discussions with other users and maintainers
23+
24+
Best for:
25+
- Early-stage troubleshooting
26+
- Learning from others’ experiences
27+
28+
:::note
29+
Community support is provided on a best-effort basis and is not guaranteed.
30+
:::
31+
32+
### Support email
33+
34+
Contact [support@localstack.cloud](mailto:support@localstack.cloud) for:
35+
36+
- Reporting bugs
37+
- Requesting new features
38+
- Technical questions
39+
- Account-related inquiries
40+
- Issues requiring direct support
41+
42+
Best for:
43+
- Reproducible issues
44+
- Tracking known problems or feature requests
45+
- Ongoing issues that require follow-up
46+
- Questions that are not suited for public channels
47+
48+
49+
### Web application chat
50+
51+
Use the [LocalStack Web Application](https://app.localstack.cloud/) chat for:
52+
53+
- Submitting support requests
54+
- Asking technical questions directly
55+
56+
To create a support request:
57+
58+
1. Open the LocalStack Web Application
59+
2. Click the chat icon in the bottom right corner
60+
3. Select **Technical Question**
61+
4. Enter your details and submit
62+
63+
Best for:
64+
- Direct interaction with the support team
65+
- Submitting issues without leaving the app
66+
67+
68+
### Enterprise support channels
69+
70+
Enterprise customers have access to additional support options, including:
71+
72+
- Dedicated Slack or Teams channel
73+
- Support ticketing portal
74+
- Real-time chat support
75+
76+
For more details, see [Enterprise Support](/snowflake/help-support/enterprise-support/).
77+
78+
## Before you reach out
79+
80+
Before contacting support, we recommend:
81+
82+
- Reviewing the documentation and FAQs
83+
- Verifying your configuration settings
84+
- Checking logs for errors or warnings
85+
- Ensuring your setup meets system requirements
86+
87+
Providing clear and complete information helps us respond more quickly and effectively.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Overview
3+
description: How to get Help and Support for LocalStack for Snowflake.
4+
template: doc
5+
sidebar:
6+
order: 1
7+
---
8+
9+
LocalStack for Snowflake provides multiple support options to help you troubleshoot issues, understand features, and integrate the platform into your workflows.
10+
11+
The level of support available depends on your subscription plan.
12+
13+
Our support team can assist with:
14+
15+
- Troubleshooting LocalStack-specific issues
16+
- Understanding LocalStack features and functionality
17+
- Integration guidance for LocalStack in your application
18+
- Best practices for working with LocalStack services
19+
20+
For non-technical inquiries, such as billing or account-related questions, contact us at [support@localstack.cloud](mailto:support@localstack.cloud).
21+
22+
## Support options
23+
24+
LocalStack offers different support plans with varying levels of access, response times, and communication channels.
25+
26+
Use the following sections to find the support option that best fits your needs:
27+
28+
- [Get Help](/snowflake/help-support/get-help/): Learn which support channel to use based on your situation.
29+
- [Report an Issue](/snowflake/help-support/report-issue/): Submit a support request with the required details.
30+
- [Support Plans](/snowflake/help-support/support-plans/): Compare available plans and included features.
31+
- [Enterprise Support](/snowflake/help-support/enterprise-support/): Explore dedicated support options for enterprise customers.
32+
33+
:::note
34+
Support is currently provided in `English` only.
35+
As an international team, this ensures clear and consistent communication across all regions.
36+
:::

0 commit comments

Comments
 (0)