Skip to content

Commit

Permalink
add technical support
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianthedev committed Aug 7, 2023
1 parent bd4245f commit 1a26479
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ const config = {
{text: "👉 Intro 👈", link: "/3.0/avo-3.html"},
{text: "Upgrade guide", link: "/3.0/upgrade.html"},
{text: "Avo 2 to Avo 3 upgrade", link: "/3.0/avo-2-avo-3-upgrade.html"},
{text: "Technical Support", link: "/3.0/technical-support"},
]
},
// {
Expand Down Expand Up @@ -222,6 +223,7 @@ const config = {
{text: "Avo, Rails & Hotwire", link: "/2.0/rails-and-hotwire.html"},
{text: "Licensing", link: "/2.0/licensing"},
{text: "Upgrade guide", link: "/2.0/upgrade"},
{text: "Technical Support", link: "/2.0/technical-support"},
],
},
{
Expand Down
1 change: 1 addition & 0 deletions docs/2.0/technical-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- @include: ./../common/technical-support.md-->
1 change: 1 addition & 0 deletions docs/3.0/technical-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- @include: ./../common/technical-support.md-->
56 changes: 56 additions & 0 deletions docs/common/technical-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Technical support

Avo is designed to be a self-serve product with [comprehensive documentation](https://docs.avohq.io) and the [demo app](https://main.avodemo.com/) as a reference.

But, even the best of us get stuck at some point and you might need a nudge in the right direction. There are a few places where you can get help.

## 1. These docs

We work hard to ensure these documentation pages express everything Avo can do and keep them up to date.

### Sidebar

From the sidebar you can check out the major sections where we grouped up similar pieces of information.

### Search

We use Algolia DocSearch so you can quickly find what you're looking for.

### Recipes and FAQ page

We compiled a list of helpful [recipes](./recipes.html) from ourselves and the community and a few [FAQ](./faq.html) items for you to check out.

## 2. GitHub Issues / GitHub Discussions

We are a source-available project and love to use GitHub's incredible features to offer support.

### I'm in trouble 😱

So, when you run into troubles, please go on the [issues](https://github.com/avo-hq/avo/issues?q=) section and search to see if anyone else encountered your issue and found a way to fix it.

Try out different queries as each person expresses themselves differently. Even if you don't find the exact same problem, it might give yout starting point.

### I found a bug 😱

This is the perfect occasion to open a [GitHub issue](https://avo.cool/new-issue). GH Issues is the perfect feature where one can ask questions, collaborate, reference other issues or PRs, or present screenshots and videos.

The second great thing about GH Isses is that they are searchable and enables self-help for others.

We prefer GH Issues over any other form of communication.

### I have some feedback

The next best way to send us your feedback and ideas si through GitHub Discussions. Think of GH Discussions like our forum where folks can share their thoughts.

## 3. Discord chat

Our [Discod Community](https://avo.cool/chat) is fantastic and it's growing everyday. Thank you for being a part of it.

### I have a quick question

We know that sometimes you just need to ask a quick question and a chat is the best place for that.
From our experience, few quick questions are actually quick. Most of the times the answer is "it depends", and we need more information about the problem.

The `#community-help` channel is the place to ask quick questions. When we have time we hang around there and answer some of them. We are lucky that other community members have experience and pitch in from time to time.

There are other more responsive private channels for our customers that need more support and are paying for that increased support. If you'd like to know more about that, please fill out [this form](https://forms.reform.app/ahahHs/technical-support-request/tk3fp0).

0 comments on commit 1a26479

Please sign in to comment.