-
Notifications
You must be signed in to change notification settings - Fork 34
docs: launch v2 Help & Support experience for snow docs
#435
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.
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
e2b3051
v2 Help & Support experience in snow docs
quetzalliwrites 8eb4cf2
fix metadata bug
quetzalliwrites 8e07ad3
fix nav
quetzalliwrites 8a7171b
docs: restructure Help & Support into task-oriented pages (draft 2)
quetzalliwrites cc0e08d
Merge branch 'main' into docs-snow-help-support-improved-devex
quetzalliwrites 5c1ee2f
fix hyperlinks
quetzalliwrites 68d1e69
fix hyperlinks
quetzalliwrites d7844fe
fix build
HarshCasper 9139d25
Update index.md
remotesynth 6b1861c
delete old index file + update doc order numbers in meta data
quetzalliwrites 0d5421d
Apply suggestion from @quetzalliwrites
quetzalliwrites 28e1a7f
Add icon for new help section
remotesynth 4fe0f73
replace gh issues for support email
quetzalliwrites 5d8655c
replace gh issues for support email
quetzalliwrites 0a992c8
replace gh issues for discussions
quetzalliwrites 14b705f
spacing fix
quetzalliwrites 0250f60
improve order of elements
quetzalliwrites af90e5f
updated nav directory order in astro config
quetzalliwrites File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
src/content/docs/snowflake/help-support/enterprise-support.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| title: Enterprise Support | ||
|
quetzalliwrites marked this conversation as resolved.
|
||
| description: How to request Enterprise Support for LocalStack for Snowflake. | ||
| template: doc | ||
| sidebar: | ||
| order: 1 | ||
| tags: ["Enterprise"] | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Enterprise support offers organizations personalized resources, direct communication channels with the LocalStack team, and flexible service level agreements (SLAs) to meet specific business requirements. | ||
|
|
||
| The key components of our enterprise support offering include: | ||
|
|
||
| - **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. | ||
| This setup ensures quick issue resolution and streamlined collaboration, improving overall service efficiency. | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
| - **Dedicated Customer Success Manager (CSM) and Technical Account Manager (TAM)**: Enterprise customers are assigned a CSM and SA. | ||
| 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. | ||
| - **Custom Service Level Agreements (SLAs)**: Tailor your service levels and response times to meet your organization's requirements. | ||
| Custom SLAs can be negotiated to align with your business objectives and ensure optimal system performance. | ||
| - **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. | ||
| - **Real-time Chat Support**: Real-time Level 1 (L1) chat support is available during support operating hours. | ||
| While immediate resolutions are prioritized, complex issues may require additional time and resources for thorough handling. | ||
|
|
||
| ## Customer portal | ||
|
|
||
| A customer portal is a home behind a login where customers can view, open, and reply to their support tickets. | ||
| Currently, the **customer portal** is only **available to Enterprise customers**. | ||
|
|
||
| You can find the customer portal here: [https://support.localstack.cloud/portal](https://support.localstack.cloud/portal). | ||
|
|
||
|  | ||
|
|
||
| ## Signing up for Enterprise Support | ||
|
|
||
| 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. | ||
|
|
||
| Follow the instructions in the email and set up your account by clicking on the **Sign up** button. | ||
| You will be asked to create a password. | ||
|
|
||
| Once you do so, you will be able to log in and start using the customer portal to create, view, and engage with tickets. | ||
|
|
||
| ## Creating a Support Ticket | ||
|
|
||
| You can open a new ticket with LocalStack support by going to the **Create a Support Ticket** link. | ||
|
|
||
| You will be redirected to a form where you will have to provide certain information to file a new support ticket. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| ### Basic Information | ||
|
|
||
| You need to fill out the following fields, which are mandatory to open a new ticket: | ||
|
|
||
| - **Type**: Choose the type of your query from the following options: | ||
| - **Issue**: Select this when you are facing an issue using LocalStack. | ||
| - **General inquiry**: Select this when you have a general question regarding LocalStack. | ||
| - **Feature request**: Select this when you are looking for a feature that is not yet implemented in LocalStack. | ||
| - **Ticket name**: Provide a descriptive name for the ticket that summarizes your inquiry. | ||
| - **Description**: Provide a comprehensive description of your inquiry, explaining all the details that will help us understand your query. | ||
|
|
||
| ### Additional Information | ||
|
|
||
| - **CI Issue?** If the query is related to a CI issue, select the one that best fits your query from the dropdown. | ||
| - **Operating system**: From the dropdown, select the operating system you are using. | ||
| - **Affected Services**: From the dropdown, select the AWS service that is affected in your query. | ||
| - **File upload**: Here you can provide any additional files that you believe would be helpful for LocalStack support (e.g., screenshots, log files, etc.). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| --- | ||
| title: Overview | ||
| description: How to request Help & Support for LocalStack for Snowflake. | ||
| template: doc | ||
| sidebar: | ||
| order: 1 | ||
| --- | ||
|
|
||
|
|
||
| LocalStack provides various support channels to help users troubleshoot issues and integrate the platform into their workflows. The level of support available depends on the plan associated with your account. | ||
|
|
||
| Our team assists with: | ||
|
|
||
| - Troubleshooting LocalStack-specific issues | ||
| - Feature usage and functionality questions | ||
| - Integration guidance for using LocalStack in your application | ||
| - Best practices for working with LocalStack services | ||
|
|
||
| For non-technical issues, such as billing or account inquiries, please contact support via [support@localstack.cloud](mailto:support@localstack.cloud). | ||
|
|
||
| We welcome any feedback as we continue to improve LocalStack for all users. | ||
|
|
||
| :::note | ||
| At the moment, we only provide support in `English`, as we are an international team with members from various regions. This allows us to maintain clear and consistent internal communication across all our locations. | ||
| ::: | ||
|
|
||
|
|
||
| ## Support Coverage | ||
|
|
||
| | **Plan** | **Tier** | | ||
| | --- | --- | | ||
| | Trial | [**Standard Support**](https://docs.localstack.cloud/snowflake/help-support/#standard-support) | | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
| | Base | [**Priority Support**](https://docs.localstack.cloud/snowflake/help-support/#priority-support) | | ||
| | Enterprise | [**Enterprise Support**](https://docs.localstack.cloud/snowflake/help-support/#enterprise-support) | | ||
|
|
||
|
|
||
|
|
||
| ## Support features | ||
|
|
||
| | **Features** | **Standard** | **Priority** | **Enterprise** | | ||
| | --- | --- | --- | --- | | ||
| | LocalStack for Snowflake documentation | ✅ | ✅ | ✅ | | ||
| | Community support | ✅ | ✅ | ✅ | | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
| | Operational support | ✅ | ✅ | ✅ | | ||
| | 1v1 technical support | ✅ | ✅ | ✅ | | ||
| | Screen sharing sessions | | ✅ | ✅ | | ||
| | Third-Party Tools | | ✅ | ✅ | | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
| | Faster response times | | ✅ | ✅ | | ||
| | Real-time chat support* | | | ✅ | | ||
| | Support ticketing portal | | | ✅ | | ||
| | SLAs | | | ✅ | | ||
| | Direct Slack connect channel | | | ✅ | | ||
| | Dedicated CSM and TAM | | | ✅ | | ||
|
|
||
|
|
||
| ## Support channels | ||
|
|
||
| | **Channels** | **Standard** | **Priority** | **Enterprise** | | ||
| | --- | --- | --- | --- | | ||
| | Slack community | ✅ | ✅ | ✅ | | ||
| | GitHub Issues | ✅ | ✅ | ✅ | | ||
| | Support email | ✅ | ✅ | ✅ | | ||
| | Web Application chat | ✅ | ✅ | ✅ | | ||
| | Ticketing portal | | | ✅ | | ||
| | Slack connect channel | | | ✅ | | ||
|
|
||
|
|
||
| ## Support Resources | ||
|
|
||
| Our support team comprises highly qualified experts who possess extensive expertise in Snowflake and other pertinent tools. We utilize a range of resources, including documentation, knowledge bases, and industry best practices, to provide you with accurate and reliable guidance. | ||
|
|
||
| However, please note that our support is provided only in `English`, and our resources are subject to availability. Therefore, our best effort support is provided asynchronously, and inquiries may be prioritized based on urgency and impact. | ||
|
|
||
| ## Support plans | ||
|
|
||
| ### Basic support | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
|
|
||
| Basic Support is available to all LocalStack users and includes access to documentation, community support, and account management (operational support). | ||
|
|
||
| Community support is available through the following channels: | ||
|
|
||
| - [LocalStack Slack Community](https://localstack.cloud/slack) | ||
| - [GitHub Issue](https://github.com/localstack/localstack/issues/new) | ||
|
|
||
| Note that community support is provided on a best-effort basis and is not guaranteed. Users are encouraged to help others by sharing their knowledge and experiences. | ||
|
|
||
| #### LocalStack Slack Community | ||
|
|
||
| LocalStack Slack Community includes LocalStack users, contributors, and maintainers. You can engage with the community of LocalStack through the `#help` channel once subscribed to the [LocalStack Slack Community](https://localstack.cloud/slack). | ||
|
|
||
| #### GitHub Issue | ||
|
|
||
| You can use GitHub Issue to: | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
|
|
||
| - [Request new features](https://github.com/localstack/localstack/issues/new?assignees=&labels=type%3A+feature%2Cstatus%3A+triage+needed&template=feature-request.yml&title=feature+request%3A+%3Ctitle%3E) | ||
| - [Report existing bugs](https://github.com/localstack/localstack/issues/new?assignees=&labels=type%3A+bug%2Cstatus%3A+triage+needed&template=bug-report.yml&title=bug%3A+%3Ctitle%3E) | ||
|
|
||
| Make sure to follow the issue templates and provide as much information as possible. | ||
|
|
||
|
|
||
| ### Standard support | ||
|
|
||
| Standard support is available to users with a Trial subscription. This includes 1v1 support on a best-effort basis, without guaranteed response times. However, the support team aims to respond to inquiries within 24–48 hours during [regular business hours](https://docs.localstack.cloud/aws/getting-started/help-support/#support-business-hours). | ||
|
|
||
|
|
||
| #### Scope | ||
|
|
||
| Our objective is to respond to your inquiries and provide guidance on using LocalStack environment with all its features to the best of our abilities. It is important to note that our best effort support may have certain limitations. | ||
|
|
||
| LocalStack’s usage is subject to various factors such as the complexity of your IT environment, specific integrations, and dependencies. While we strive to provide comprehensive support for LocalStack, there are certain areas that fall outside our scope: | ||
|
|
||
| - **Third-Party Tools**: We do not offer support for third-party tools or software that integrate with or work alongside LocalStack. This includes, but is not limited to external monitoring tools, third-party plugins, development environments and build tools. | ||
| - **Customer-Specific Code**: Our support does not extend to the custom code that customers build using LocalStack. This includes debugging, optimizing, or modifying customer-written scripts, applications, or workflows. | ||
| - **Snowflake in Production**: We do not provide support for the deployment, management, or troubleshooting of Snowflake and it’s features in a production environment. Our focus is solely on the emulated services within LocalStack for Snowflake. | ||
|
|
||
| #### Channels | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
|
|
||
| Standard support can be accessed through the following channels: | ||
|
|
||
| - [support@localstack.cloud](mailto:support@localstack.cloud) | ||
| - [LocalStack Web Application](https://app.localstack.cloud/?__hstc=108988063.db1b9f760546de73c4f730e19a429eb1.1767872511999.1767885552451.1767972766856.3&__hssc=108988063.1.1767972766856&__hsfp=3587568261) | ||
|
|
||
| Providing [detailed information](https://www.notion.so/Snowflake-help-and-support-doc-2e3fc2a234318068aacdf6c1b55e434e?pvs=21) upfront helps our team respond more quickly and efficiently. After submitting, the support team will respond as soon as possible. | ||
|
quetzalliwrites marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### LocalStack Web Application | ||
|
|
||
| To create a support ticket: | ||
|
|
||
| - Navigate to the [LocalStack Web Application](http://app.localstack.cloud/?__hstc=108988063.db1b9f760546de73c4f730e19a429eb1.1767872511999.1767885552451.1767972766856.3&__hssc=108988063.1.1767972766856&__hsfp=3587568261). | ||
| - Click on the chat icon in the bottom right corner of the page. | ||
| - Select **Technical Question** from the menu. | ||
| - Fill in the required details and send your message. | ||
|
|
||
| ### Priority support | ||
|
|
||
| Priority support is available for users with active Base LocalStack for Snowflake subscription, offering dedicated 1v1 assistance and fast response times: | ||
|
|
||
| - **First response**: within 24 hours | ||
| - **Follow-up responses:** within 24 hours | ||
|
|
||
| Please note that all responses are provided during our normal operating hours. While we strive to respond within a 24-hour timeframe, we cannot guarantee that every response will meet this timeline. | ||
|
|
||
| #### Scope | ||
|
|
||
| As part of our Priority support plan, we offer limited support for third-party tools that integrate with LocalStack. This support is provided on a best-effort basis and covers tools that are officially supported and mentioned in our documentation. | ||
|
|
||
| We aim to enhance your development experience by assisting with the integration and basic troubleshooting of these tools. While we strive to provide comprehensive assistance, there are certain limitations to our third-party tools support: | ||
|
|
||
| - **Best Effort Basis:** Support for third-party tools is provided on a best-effort basis, meaning that while we will do our utmost to assist, we cannot guarantee resolution for all issues. | ||
| - **Officially Supported Tools Only:** Our support is limited to officially integrated third-party tools with LocalStack. For other tools, we recommend consulting the tool’s official support channels or resources. | ||
| - **Basic Troubleshooting:** Our support focuses on basic troubleshooting and integration guidance. We do not provide in-depth support for advanced configurations, customizations, or optimization of third-party tools. | ||
|
|
||
| ## Screen sharing sessions** | ||
|
|
||
| To enhance issue identification and provide a more efficient troubleshooting experience, our support engineers may offer scheduled live screen sharing sessions. During these sessions, our support engineers can directly observe and diagnose the issues you are encountering, ensuring a quicker and more effective resolution. | ||
|
|
||
| ## Enterprise support | ||
|
|
||
| To learn more about the support available to **Enterprise** plan users, refer to our [Enterprise Support Guide](https://docs.localstack.cloud/snowflake/help-support/enterprise-support). | ||
|
|
||
|
|
||
| ## Support Business Hours | ||
|
|
||
| Our support team operates in the CET and ET timezone, Monday to Friday, from 6 AM to 9 PM UTC, excluding the following holidays: | ||
|
|
||
| - January 1st, | ||
| - May 1st, | ||
| - November 1st, | ||
| - December 24th, 25th and 31st | ||
|
|
||
| ## Troubleshooting Guidelines | ||
|
|
||
| In case you encounter any issues with LocalStack for Snowflake, follow these troubleshooting guidelines: | ||
|
|
||
| - Review the documentation and FAQs for possible solutions. | ||
| - Check the system requirements to ensure compatibility. | ||
| - Verify the configuration settings against the documentation. | ||
| - Consult the error logs for any relevant error messages or warnings. | ||
| - Seek guidance from the community through the user forum. | ||
|
|
||
| ## Reporting an issue | ||
|
|
||
| To speed up the issue identification and resolution, we kindly ask you to provide the following information when reaching out: | ||
|
|
||
| - Snowflake emulator container logs with | ||
| the environment variables `SF_LOG=trace` and `DEBUG=1` enabled | ||
| - The query that triggered the issue (Optional, but helpful) | ||
| - Client tool or driver used | ||
| - Connection parameters (excluding sensitive information) | ||
| - Client tool or driver logs if available | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.