Getting Started with Cauldron Cloud

Welcome to Cauldron Cloud! This page provides some concepts used in the platform, which might be helpful, if you are new to the platform.

Cauldron community forum provides a set of topics to start doing basic things with their service. In this introduction we will cover some of them.

When you access to your Cauldron Cloud instance for the first time, you need to login with your account. To get access you need to be allowed by any of the administrators of the system.

Core features

Once you are logged in, there are several places where you can play with Cauldron. Most of them are linked in the top-side navigation menu. We will explain the core concepts and sections:

Explore reports

You can access to any report available in the platform from the menu. A report is a set of repositories from different data sources. Cauldron automatically collects and stores all the information for further analysis. You can filter them by name, so you should give them good names.

Create reports

You can always create a new report in the top right side of the page. We have a detailed topic about this process: Set up a project analysis.

Report overview

When all data has been collected, Cauldron provides a set of metrics and visualizations related with the activity, community and performance, we recommend to explore them all. You can filter these metrics by date or repository. We have a post explaining some of these metrics: Understanding the project metrics.

You can also access to more visualizations using the More details button, a new tab will be opened with a Kibana instance. It is important to know that you can’t edit dashboards available from that button, but you can create new ones from another option that will be explained later. We have a topic with more details about Kibana: Using Kibana in Cauldron.

If we go back to the report page and look at the left side of the screen, we can see a collapsible sidebar that contains many options:

  • Data sources: list of the repositories included in the report and the data collection status.
  • Data Workspace: Kibana instance where you can create your own dashboards and visualizations or edit existing ones.
  • Export data as CSV: in case you want to visualize the data collected in another platform you can use this button to download it as CSV.
  • Compare: if you want to compare your report with another, you can do it from this button. We will explain more about this later.
  • Settings: there is available an experimental feature to reset the report and add the data sources again. It could be useful if a GitHub user or organization has created/deleted repositories and you want to update the list of data sources of your report.

Create your own dashboard

Since Cauldron data is stored as Elasticsearch indexes, Cauldron provides a ODFE Kibana instance to let you built your own visualizations and dashboards from the data gathered. You can check Elastic’s Kibana guide for some documentation.

From your Data Workspace you can create your own visualizations, those can’t be shared with others, but you can use them for all your reports.

We provide, by default, a set of visualizations developed by Bitergia and Cauldron.

We have a post with more details about Kibana: Using Kibana in Cauldron.

Compare reports

From this section you can easily compare up to five reports. Let’s say you want to compare the evolution of two programming languages: Rust and Go. You can create a report for each one and then compare them:

Contributors

This section is only available for admin users of Cauldron Cloud

Cauldron Cloud version has personal information available, like names or usernames provided by Git, GitHub or any other data source.

SortingHat is a tool to manage identities. It stores and manages data about community members and enrollments information.

With the use of Hatstall you will be able to merge different profiles under a single one or affiliate people to companies using, for example, a domain address. You can access from the contributors button in the top navigation bar.

If you want to know more about Hatstall and how to use it, you can refer to the specific documentation.

Questions

We are here as a resource for you and to answer any questions you may have! Please don’t hesitate to
ask or reply here if you have any question about getting started.

Every release we create a new user guide talking about new features that comes, like UI changes, new data sources. Take a look, you might find interesting some topics.

Make sure you connect with us on Twitter to stay updated with product updates and community news!

Hope you enjoy it!

Cauldron Team