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

Update Tech Insights docs for new configuration setup #1154

Merged
merged 10 commits into from
Nov 2, 2023
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
8 changes: 6 additions & 2 deletions content/docs/tech-insights/builtin-data-sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ publishedDate: '2023-05-12T21:00:00.0Z'
description: Built-in Data Sources.
---

Roadie includes several (built-in) Data Sources for common vendors such as Datadog, Snyk, PagerDuty, and GitHub. All built-in Data Sources have pre-defined Facts you can use for defining your [Checks](../checks/).
Roadie includes several (built-in) Data Sources for common vendors such as Datadog, Snyk, PagerDuty, and GitHub.

All built-in Data Sources have pre-defined Facts you can use for defining your [Checks](../checks/). You can view the Facts on the detail page for the individual Data Source or when adding a Check.

You can also [create your own custom Data Sources]('../define-custom-data-sources/') if the built-in ones do not provide the Facts you need.

### Configuring Built-in Data Sources

Expand All @@ -14,7 +18,7 @@ We have built several Data Sources, which you can find explained below, together

This list will probably have better accuracy, since we update facts frequently.

Please note, if you don't find what you are looking for and/or want to create something we haven't provided out of the box, Roadie Tech Insights lets you define custom Data Sources. More information around that can be found [here](../define-custom-data-sources/).
Please note, if you don't find what you are looking for and/or want to create something we haven't provided out of the box, Roadie Tech Insights lets you [define custom Data Sources](../define-custom-data-sources/).

### Datadog Data Source

Expand Down
10 changes: 9 additions & 1 deletion content/docs/tech-insights/data-sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ publishedDate: '2022-11-15'
description: Managing Data Sources.
---

Data Sources periodically collect Facts about your services from third-party vendors or arbitrary APIs. The Facts collected by Data Sources are used for defining Checks. Roadie comes with a handful of built-in Data Sources with predefined Facts that you can use without any setup. You can also define your own Data Sources, which can use external APIs or files in a repository as a source of truth.
### What are they?
Data Sources periodically collect Facts about your services from third-party vendors or arbitrary APIs.

The Facts collected by Data Sources can be used for defining Checks. You can view the Facts collected by a Data Source by clicking on the Data Source and finding the facts on the details page.

### Ready made and Custom Data Sources
[Built-in Data Sources](('../builtin-data-sources/')) with predefined Facts are available to use without any setup.

However, you can also [define your own custom Data Sources]('../define-custom-data-sources/'), which can pull data from external APIs or the files in a repository.

To manage Data Sources, go to Tech Insights → Data Sources.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
35 changes: 19 additions & 16 deletions content/docs/tech-insights/introduction/index.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,45 @@
---
title: Introduction to Tech Insights
publishedDate: '2022-11-15'
description: An introduction about Tech Insights plugin.
description: An introduction to the Tech Insights plugin.
---

Roadie Tech Insights helps you keep track of all of your software assets and make sure they meet your quality and compliance targets.

Roadie Tech Insights lets you create Scorecards to track what matters to you about your assets in the Backstage catalog. It does this by ingesting data via Data Sources, and then aggregating Checks on that data.
You can create Scorecards to track the things that matter about your assets in the Backstage catalog. This is done by ingesting Fact data via various Data Sources, and then aggregating Checks on those Facts.

Therefore, in order to create [Scorecards](../scorecards/index.md), you will need to add [Data Sources](../data-sources/index.md) and define [Checks](../checks//index.md) on such data. Roadie provides a user interface to build all three of these, this page describes how to set each one of them.


## Prerequisites

- Roadie Tech Insights is a paid add-on. If you are not sure about whether or not you have it or would like to include it, please reach out to our sales team.
- You must be an administrator for your Roadie instance to enable and manage Tech Insights.
- You must be an administrator for your Roadie instance to manage Tech Insights.


## Read Only Access

By default, all users will be able to see but not edit Tech Insights content.

## Enable Roadie Tech Insights
If you want to hide Tech Insights for non-admin users such as when initially setting it up, you can check 'Admins only' checkbox under Administration → Settings → Plugins → Tech Insights page. This will remove Tech Insights from the sidebar for anyone who is not part of `roadie-backstage-admin` or `roadie-tech-insights-admin` groups.

To enable Roadie Tech Insights, go to Administration → Settings → Plugins → Tech Insights, or navigate to `https://[organisation]/administration/settings/tech-insights` and tick the enabled box as shown below:
![Admin Only View](./admin-only-settings.png)

![Enable Tech Insights](./enable-tech-insights.png)

## Users access
## Write Access

Anyone who is part of the `roadie-backstage-admin` GitHub team will have CRUD access to Tech Insights.
Anyone who is part of the `roadie-backstage-admin` group will have write access to Tech Insights by default.

However, if you want to grant CRUD access to the feature to some users, but do not wish to make them parts of main admin group (`roadie-backstage-admin`), you can create a `roadie-tech-insights-admin` and add them as a members there.
If you want to extend write access to more users but do not wish to make them parts of main admin group (`roadie-backstage-admin`), you can create a `roadie-tech-insights-admin` and add them as members there.

If it exists, anyone who is part of the `roadie-tech-insights-admin` GitHub group will have CRUD access to Tech Insights.
If it exists, anyone who is part of the `roadie-tech-insights-admin` group will have write access to Tech Insights.

By default, no other users will have access, unless you check 'Visible to all users' checkbox under Administration → Settings → Plugins → Tech Insights page.

This will grant Read access to all users which are not part of `roadie-backstage-admin` nor `roadie-tech-insights-admin` groups.
## Disabling Roadie Tech Insights

Once Roadie Tech Insights is enabled, you’ll find a link in the sidebar as below:
To disable Roadie Tech Insights and remove it from your sidebar, please reach out to Roadie support.

![Sidebar Tech Insights](./sidebar-tech-insights.png)

## Next steps
## First steps

Now that you have enabled Roadie Tech Insights and verified you have access to the Tech Insights page you’ll be able to create [Data Sources](../data-sources/), define [Check](../checks/) for your Data Sources, and compose [Scorecards](../scorecards/) with said Checks.
You will first want to see what data is available to use already and see how to pull in custom data sets via [Data Sources](../data-sources/). Then you can define [Checks](../checks/) for your Data Sources, and compose [Scorecards](../scorecards/) with the Checks.
Binary file not shown.