This section will walk you through a simple example, to quickly give you insights about one of the most important data sources in your organization: your source control systems. You’ll be up and running with 3 simple steps:

  1. Connect your source control systems to Faros (we’ll use GitHub as an example)
  2. Organize your data
  3. Visualize your data

Start Importing Data

  1. Navigate to the Sources page
  2. Click Add Source. Select the source you want to connect. To narrow down the choices, select a category on the left hand side.
  3. Give your source a name and choose how you'll authenticate. Make any changes to the source's configuration (if you'd like) then press Submit!

You can examine logs from the latest sync by navigating to Sources in the navigation panel on the left, and selecting your newly created source. You can also enable/disable the source, edit it, or force a new sync by choosing the appropriate action under the icon.


GitHub Source

Including your Entities

Identify which boards and repos are of interest to your organization. These objects must be included before Faros will pull all of their associated data.

  1. Navigate to one of the ownership pages. These are found under Organization.
  2. Select items of interest and click 'Include Selected'
  3. When you're done, hit the Save button.
    1. Return to your Sources page and select the sync now menu item for the source you're working with. Faros pulls in more detailed data for entities that have been assigned.
  4. Repeat with the other entities you have set up!

Optional: Assigning Ownership

All data that is included will show up in the dashboards, but if you want to view insights broken down by teams you'll need to assign ownership. See this page for more details.

Refresh Data

  1. Remember to re-sync your sources after assigning ownership as described above.
  2. Navigate to Settings > Graphs and check when the last dashboard sync. Click the sync button, then monitor the logs to see when the sync has completed.

Inspect Data

At this point it is also possible to inspect your data by building simple dashboards.

  1. In the Dashboards menu, navigate to Create > New Question
  2. Select Faros Visualization Data as your data then play around with building out a chart

You need to have your organization structure set up in Faros before the pre-created dashboards will work. The next sections of this guide will walk you through organizing your data and give you more detailed information on dashboards.