Platform.sh Documentation

How the docs are organized

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 Platform.sh.

This site is roughly split into categories based on where you are in your journey working with Platform.sh, described below.

Get started

If you’re still unfamiliar with Platform.sh 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 Platform.sh 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!

Learn

After going through the Get started section, you may want to know more about how Platform.sh 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 Platform.sh.

• What is Platform.sh?

  With this guide, find out which problem Platform.sh is trying to solve. Learn how Platform.sh’s configuration, build and deploy pipelines, and the structure of environments play into the broader philosophy behind reliably deploying applications.

• Tutorials

  Once you’re familiar with Platform.sh, 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 provide all the information you need.

• Best practices

  Platform.sh 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.

Frameworks

Now that you understand the basic rules of Platform.sh, 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.

Reference

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.

API documentation

Find out more about Platform.sh’s GIT implementation and REST API, and how you can leverage them to manage every aspect of your projects, through Platform.sh’s API documentation.

More docs, found elsewhere

There are many resources available outside of the documentation that will help you work with Platform.sh, including demos, talks, and podcasts.

Check them out here.

To stay informed of all the latest Platform.sh news, join our newsletter.

Connect with us

Join the community

The Platform.sh community meets on both a Community forum and Discord for questions and discussion.

Have an experiment you’d like to share? Looking for a way to contribute?

Contribute

Feel free to open an issue or pull request for any of the repositories below, or let us know on Discord if you find a problem we can help with:

• Documentation
• CLI

Get support

If you’re experiencing issues with your projects, don’t hesitate to open a support ticket.