-
Notifications
You must be signed in to change notification settings - Fork 2
added the read-only access page with screenshots and a diagram #663
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| --- | ||
| title: Set Up Read-Only Access | ||
| description: Learn how to give stakeholders a view-only look at your testing in Testomat.io. This guide walks you through inviting an external user with the Read-Only role, adding them to the right project, and sharing a run report or living documentation by link when they need no account at all. | ||
| type: article | ||
| url: https://docs.testomat.io/tutorials/set-up-read-only-access | ||
| head: | ||
| - tag: meta | ||
| attrs: | ||
| name: og:image | ||
| content: https://docs.testomat.io/_astro/New_b1BS3EKN_2024-08-29.DGrFkMLR_ZOOgn1.webp | ||
|
|
||
| - tag: meta | ||
| attrs: | ||
| name: keywords | ||
| content: read-only access, Testomat.io, Read-Only user, user roles, permissions, invite users, external stakeholders, clients, auditors, project access, public reports, share report publicly, living documentation, view-only, test management, QA | ||
| --- | ||
|
|
||
| Welcome! | ||
|
|
||
| This tutorial shows you how to give someone outside your team a safe, look-but-don't-touch view of your testing. That could be a client, an auditor, or a stakeholder who wants to follow progress without the risk of changing anything. | ||
|
|
||
| You have two ways to do this, and this tutorial covers both: add the person as a Read-only user, or share a single report or living documentation with them without an account at all. | ||
|
|
||
| ## Which option to pick | ||
|
|
||
|  | ||
|
|
||
| * **Read-only user**. Best when the person needs ongoing access to browse tests, runs, and reports themselves. They log in but cannot change anything. It is free of charge on Professional and Enterprise plans. | ||
| * **Public share**. Best for a one-off. You send a link to a report or living docs, and they need no Testomat.io account at all. | ||
|
|
||
| ## Invite an external user as Read-only | ||
|
|
||
| Users are managed at the Company level, so you invite them there first. | ||
|
|
||
| 1. Open the **Companies** page and select your company. | ||
| 2. Invite the user by email. | ||
| 3. Assign the **Read-Only** role. | ||
|
|
||
|  | ||
|
|
||
| :::note | ||
|
|
||
| Read-only members can view information but cannot make any changes. See [Users and Access](https://docs.testomat.io/management/company/users-and-permissions/#_top) for what every role can do. | ||
|
|
||
| ::: | ||
|
|
||
| ## Add them to the right project | ||
|
|
||
| A company can hold several projects, so give the person access only to the one they need. | ||
|
|
||
| 1. Open the project you want to share. | ||
| 2. Go to **Settings**, then **Users**. | ||
| 3. Click **Invite**. | ||
| 4. Select the Read-only user and click **Send** to invite them to the project. | ||
|
|
||
|  | ||
|
|
||
| They can now sign in and browse that project, but every edit and run control stays locked for them. | ||
|
|
||
| ## Or share without an account | ||
|
|
||
| If the person only needs to see one report or your living docs, skip the account and send a link. | ||
|
|
||
| To share a run report: | ||
|
|
||
| 1. Open the run and click **Report**. | ||
| 2. Click the actions menu (`...`). | ||
| 3. Choose **Share Report by Email** to send it to specific people, or **Share Report Publicly** to create a link. | ||
| 4. For a public link, set an expiration date the default is 7 days, and keep the passcode on for security. | ||
|
|
||
|  | ||
|
|
||
| :::note | ||
|
|
||
| Public sharing is a two-level switch. Turn it on at the **Company** level first, then in **Project Settings** under the **Sharing** section, or the option stays greyed out. | ||
|
|
||
| ::: | ||
|
|
||
| To share living documentation, open it from the project and send its link the same way. This gives stakeholders an always-current view of what your tests cover, with no login. | ||
|
|
||
| ## Next steps | ||
|
|
||
| * Review what each role can do in [Users and Access](https://docs.testomat.io/management/company/users-and-permissions/#_top). | ||
| * Want stakeholders to follow coverage live? Share your [Living Documentation](https://docs.testomat.io/advanced/living-doc/#_top). | ||
| * Want to present particular results? Send a [run report](https://docs.testomat.io/project/runs/reports/#how-to-share-run-report). | ||
Binary file added
BIN
+77.5 KB
src/content/docs/tutorials/images/read-only-access/1-invite-read-only.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+61.6 KB
src/content/docs/tutorials/images/read-only-access/2-invite-user-to-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+87.8 KB
src/content/docs/tutorials/images/read-only-access/3-share-report-publicly.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+69.6 KB
src/content/docs/tutorials/images/read-only-access/read-only-access-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we also have a dedicated page, so we can mention it https://docs.testomat.io/project/runs/reports/#how-to-share-run-report