Documentation

Doc index page

Integrate SymfonyInsight in your workflow

Note

The manager features are only available on Business plans (Pro, Enterprise, and Premium). You can manage your current plan on your account page.

By providing features such as project collaborators, notifications and statistics reports, SymfonyInsight is well suited to be used as a way to get a daily overview of your project's quality.

Before being able to leverage these features, though, your team need to get up and running with SymfonyInsight. This document explains how to configure SymfonyInsight in a team working on multiple projects in order to let you track the progress and quality of each of these project easily.

First, to get started on SymfonyInsight as a team, have a look at the Getting started as a team tutorial that will guide you through the basic configuration of the product and how to add your team as collaborators on your projects.

Once ready, there are several features you can use in order to get an overview of your projects and be alerted when necessary.

1. Add all your projects to SymfonyInsight

In order to create a useful overview of your projects and to know when to alert you about them, SymfonyInsight needs to be used on all your projects.

There are documentation sections specifically written to help you with each platform where the code of your application may be hosted:

2. Add automatic analysis on each of your project's

SymfonyInsight works much better when it has a complete overview of your project's code and improvements. To get this complete overview, it needs to be triggered each time the code of your application changes. This is where automatic analyses are useful.

Automatic analysis works by asking the platform hosting the code of your application to notify SymfoynInsight when the code changes. Each documentation section for specific platforms has a part about how to configure automatic analysis:

Enabling it on every project helps SymfonyInsight be aware of the code changes, which it uses to notify you and give you a better picture of your projects.

Note

In addition to automatic analyses, you can also enable Pull Requests analysis if you use GitHub. This will help your team get quality feedbacks directly in GitHub, reducing the amount of technical debt at its source.

3. Be notified about your project's quality

Once all your projects are monitored by SymfonyInsight, you are able to access the dashboard of the product to see the quality of each project quickly.

However, sometimes being notified when something goes wrong is better than having to look at the data yourself.

There are several ways to do so, each described in a dedicated documentation section:

4. Get statistics and create reports about your projects quality

In addition to the detailed information SymfonyInsight is able to provide to developers, it also creates a global overviews of your project's quality.

There are two features related to this: statistics and reporting. You can read the dedicated documentation section to learn more about how to use these features.