Friendly.rb - Your friendly European Ruby Conference Technical support
Avo is designed to be a self-serve product with comprehensive documentation and demo apps to be used as references.
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 levels of how can get help.
Open Source Software Support
Avo's Open Source Software (OSS) support primarily revolves around assisting users with issues related to the Avo and other Avo libraries. This involves troubleshooting and providing solutions for problems originating from Avo or its related subcomponents.
However, it is crucial to understand that the OSS support does not extend to application-specific issues that do not originate from Avo or its related parts. This includes but is not limited to:
- Incorrect application configurations unrelated to Avo.
- Conflicts with other libraries or frameworks within your application.
- Deployment issues on specific infrastructure or platforms.
- Application-specific runtime errors.
- Problems caused by third-party plugins or extensions.
- Data issues within your application.
- Issues related to application performance optimization.
- Integration problems with other services or databases.
- Design and architecture questions about your specific application.
- Language-specific issues are unrelated to Avo or other Avo libraries.
We acknowledge that understanding your specific applications and their configuration is essential, but due to the time and resource demands, this goes beyond the scope of our OSS support.
Enhanced support
For users seeking assistance with application-specific issues, we offer a few paid technical support plans. These subscriptions provide comprehensive support, including help with application-specific problems.
- Priority chat support
- Advanced hands-on support
For more information about our support plans, please visit this page.
Self help
This is how you can help yourself.
-> 1. The docs
We work hard to ensure these documentation pages express everything Avo can do and keep them up to date.
👈 Left Sidebar
From the sidebar you can check out the major sections where we grouped up similar pieces of information.
🔎 Docs Search
We use Algolia DocSearch so you can quickly find what you're looking for.
📚 Guides and FAQ page
We compiled a list of helpful guides from ourselves and the community and a few FAQ items for you to check out.
-> 2. GitHub Issues & Discussions
Avo is LGPL-licensed and available on GitHub. We love to use GitHub Issues to report bugs and GitHub Discussions to receive feedback and suggestions.
There is no guarantee w.r.t. response time to the reports nor is there any guarantee that issues will be resolved (e.g., fixed) within any time frame.
😱 I'm in trouble
So, when you run into troubles, please go on the issues 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 oportunity to open a GitHub issue. GitHub Issues is the perfect feature where one can ask questions, collaborate, reference other issues or PRs, or present screenshots and videos.
It would be great if you could go through all the information that the issue asks of you (versions and others) as it will help us understand the problem better and shorten the back and forth of us asking that same information.
The second great thing about GitHub Issues is that they are searchable and enables self-help for others.
📣 I have some feedback
The next best way to send us your feedback and ideas si through GitHub Discussions. Think of GitHub Discussions like our forum where folks can share their thoughts.
INFO
We prefer GitHub Issues over any other form of communication.
-> 3. Demo apps
These apps have been made to showcase the technical abilities of Avo. You can browse their source-code to uncover many examples of how you can use Avo in many environments and with advanced use-cases.
The main demo app is a catch-all all that mimics an internal tool. It has multiple examples about Avo's support to all the edge-cases you might encounter.
The ticketing demo app is an example of how you could build a ticketing support app for your customers completely in Avo. It also features websockets integration for live commenting on tickets alongside a custom tool that serves as a "Settings" page.
Help from the official team
You sometimes need help from the authors. There are a few ways to do that.
-> 1. Thursday is community day
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 Discord server has a few channels marked #avo-2, #avo-3, #resources, #front-end, #fields, and more to try to narrow down the issues. There's a bot that will open up a thread after each question so please use those threads to make it easier to track the conversation.
Due to the nature of how time-consuming it is, we can't offer free tech support. We are lucky that other community members have experience and pitch in from time to time.
On Thursday we'll be present on the Discord server where we can answer your questions.
-> 2. Paid support
The paid support chat comes in different flavours.
If you'd like to know more about that, see our standard plans here or reach out to us on email.
Reproduction repository
The easiest way for us to troubleshoot and check on an issue is to send us a reproduction repository which we can install and run in our local environments.
# run this command to get a new Rails app with Avo installed
rails new -m https://avo.cool/new.rb APP_NAME
# run to install avo-pro
rails new -m https://avo.cool/new-pro.rb APP_NAME
# run to install avo-advanced
rails new -m https://avo.cool/new-advanced.rb APP_NAME