| title | showTitle | editPage | feedback |
|---|---|---|---|
Introduction |
false |
false |
false |
{{< home >}}
There are different kinds of documentation. Some docs are useful when you're just starting out, while others go into detail that's relevant only after you've deployed many projects on {{< vendor/name >}}.
This site is roughly split into categories based on where you are in your journey working with {{< vendor/name >}}, described below.
If you're still unfamiliar with {{< vendor/name >}} and how it works, but you're also looking to quickly start working with the platform, the Get started section is the right place to begin.
Learn the basics of how {{< vendor/name >}} leverages Git to produce reusable build images, identical-to-production environments in staging and development (including production data), as well as the basics of monitoring and troubleshooting your environments.
Ready to get started? Let's go!
After going through the Get started section, you may want to know more about how {{< vendor/name >}} works and the logic behind it. The Learn section is a collection of tutorials and conceptual guides to help you understand the ins and outs of {{< vendor/name >}}.
-
With this guide, find out which problem {{< vendor/name >}} is trying to solve. Learn how {{< vendor/name >}}'s configuration, build and deploy pipelines, and the structure of environments play into the broader philosophy behind reliably deploying applications.
-
Once you're familiar with {{< vendor/name >}}, its basic rules and philosophy, you may be curious about how you can replicate common workflows in other tools on our platform. From scheduling dependency updates and backups to exporting data, the Tutorials provides all the information you need.
-
{{< vendor/name >}} makes deploying and managing infrastructure no different than working with Git. As your work becomes more experimental, however, you may be interested in optimizing your workflows, and addressing common constraints of the platform. The Best practices documentation contains articles that address advanced use cases for caching, microservices, and more.
Now that you understand the basic rules of {{< vendor/name >}}, you're likely ready to deploy your own custom code in a chosen framework. The Frameworks section is a collection of framework-specific how-to guides - from best practices to configuration, local development, and more.
| Language | Frameworks |
|---|---|
| Python | Django |
| PHP | Drupal Ibexa Laravel Symfony TYPO3 WordPress |
| Javascript/Node.js | Gatsby Next.js Strapi |
| Java | Hibernate Jakarta Micronaut Quarkus Spring |
The Reference documentation section is the largest and most comprehensive. It includes details of configuration, environment variables, activities, and much more material you can use in your day-to-day work.
{{< home/table "services" >}} {{< home/table "languages" >}} {{< home/table "configuration" >}} {{< home/table "topics" >}}
The following resources are also helpful for working with {{< vendor/name >}}:
| Source | Links |
|---|---|
| {{< vendor/name >}} Blog | {{< home/links-blog >}} |
| Blackfire.io resources | {{< home/links-blackfire >}} |
| DDEV resources | {{< home/links-ddev >}} |
| YouTube | {{< home/links-youtube >}} |
| GitHub | {{< home/links-github >}} |
To stay informed of all the latest {{< vendor/name >}} news, join our newsletter.
The {{< vendor/name >}} community meets on both a Community forum and Slack for questions and discussion.
Have an experiment you'd like to share? Looking for a way to contribute?
Feel free to open an issue or pull request for any of the repositories below, or let us know on Slack if you find a problem we can help with:
{{< home/links-github >}}
If you're experiencing issues with your projects, don't hesitate to open a support ticket.