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.

Sign up for GitHub

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

Modify Tech Insights intro documentation to talk about roles better. #1158

Merged
merged 3 commits into from
Nov 6, 2023
Merged

Modify Tech Insights intro documentation to talk about roles better. #1158

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4085ebd
Modify Tech Insights intro documentation to better talk about roles.
Xantier Nov 2, 2023
696190a
Correct way to make link in MD
Xantier Nov 2, 2023
88335e4
Merge branch 'main' into sc-17328-tweak-ti-intro-doc
Xantier Nov 6, 2023
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: 4 additions & 4 deletions content/docs/tech-insights/introduction/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Therefore, in order to create [Scorecards](../scorecards/index.md), you will nee
## 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 enable and manage Tech Insights. See [access section](#users-access) for more details.

## Enable Roadie Tech Insights

Expand All @@ -23,11 +23,11 @@ To enable Roadie Tech Insights, go to Administration → Settings → Plugins

## Users 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 in Roadie will have write access to Tech Insights.

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.
However, if you want to grant write 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 group called `roadie-tech-insights-admin` and add them as a 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 in Roadie 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.

Expand Down