Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for tech insights facts views. #1348

Merged
merged 6 commits into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/docs/docs-nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ nav:
- Introduction: '/docs/tech-insights/data-sources/'
- Definining custom Data Sources: '/docs/tech-insights/define-custom-data-sources/'
- Using built-in Data Sources: '/docs/tech-insights/builtin-data-sources/'
- Displaying Fact Data: '/docs/tech-insights/displaying-fact-data/'
- Data Source results and details: '/docs/tech-insights/data-source-details/'
- Checks:
- Introduction: '/docs/tech-insights/checks/'
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 70 additions & 0 deletions content/docs/tech-insights/displaying-fact-data/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Displaying Fact Data
publishedDate: '2024-08-12T14:33:22.0Z'
description: Roadie Plugins to display fact data directly
---

## Introduction

Tech Insights in Roadie provides the capabilities to automatically retrieve and store relevant data about your entity catalog. You can display this data in various ways within your Roadie instance to easily keep track, visualize and display important information for your entities.
Xantier marked this conversation as resolved.
Show resolved Hide resolved

## Components

Roadie provides the ability to display various views of fact data from tech insights. These range from table views to more fine-grained widgets.


### Tech Insights Fact Page

The *Tech Insights Fact Page* allows you to create a tabular view of facts collected to the system. These facts can range across different data sources. You can also define your own entity filtering to select only the relevant entities for this specific view.


![tech_insights_fact_page.png](tech_insights_fact_page.png)

You can add the table view as a `Page` component (`TechInsightsFactPage`) into the sidebar of your application. The configuration of the component can be done on either via the JSON options provided on the page add/edit screen, or more easily from within the page itself.

The configuration options include selecting the filtering of entities to display, and wanted columns that should be added to the table.


![page_settings_1.png](page_settings_1.png)
![page_settings_2.png](page_settings_2.png)

Additionally, there is the possibility to create bar or pie charts on any column in the table by using the _kebab menu_ and selecting "Show as graph".

![show_graph_menu.png](show_graph_menu.png)


### Tech Insights Facts Home Page Card

The *Tech Insights Facts Home Page Card* is a variant of the above Tech Insights page. It provides the same functionality but automatically limits the displayed entities to the ones that are owned by the current user in the application.

You can add the table view as a `Card` component (`TechInsightsFactsHomePageCard`) into the home page of your Roadie application. The configuration of the component from within the page itself, using the cog icon in the top right corner.

![home_page_table.png](home_page_table.png)

The configuration options for this component contain only the column selection for values to be displayed on the table.

![home_page_config.png](home_page_config.png)


### Fact Data Graph Card

The *Fact Data Graph Card* allows you to display historical graph of numerical Fact values that have been gathered into the system. This allows you to follow trends on open issues or vulnerability counts or similar.

You can add the table view as a `Card` component (`FactDataGraphCard`) into the entity page of your Roadie application. The configuration of the component from within the page itself, using the cog icon in the top right corner.

![graph_card_view.png](graph_card_view.png)

The configuration of this card allows you to configure either Bar, Line or Area chart types. It lets you select the color of the graph, what data to display and what date range of data should be displayed.
![graph_card_config.png](graph_card_config.png)

### Fact Info Card

The *Fact Info Card* allows you to display individual fact values in a card format on the entity. This lets you highlight the most relevant information and make it visible at a glance.

You can add the table view as a `Card` component (`FactInfoCard`) into the entity page of your Roadie application. The configuration of the component from within the page itself, using the cog icon in the top right corner.

![info_card_view.png](info_card_view.png)

The configuration options for the Fact Info Card expects you to select the facts you want displayed and additionally exposes the possibility to add a link to the card itself to let the user navigate to another location for additional information.

![info_card_config.png](info_card_config.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading