diff --git a/astro.config.mjs b/astro.config.mjs index eb9867fc..1c08b43f 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -88,6 +88,7 @@ export default defineConfig({ items: [ { label: 'Overview', link: '/tutorials'}, { label: 'Manual Testing Classic', link: '/tutorials/manual-testing-classic'}, + { label: 'Set Up Read-Only Access', link: '/tutorials/set-up-read-only-access'}, { label: 'Playwright', link: '/tutorials/playwright'}, { label: 'Java Integration', link: '/tutorials/java'}, { label: 'WebdriverIO', link: '/tutorials/webdriver'}, diff --git a/src/content/docs/tutorials/Set-Up-Read-Only-Access.md b/src/content/docs/tutorials/Set-Up-Read-Only-Access.md new file mode 100644 index 00000000..c1a5ab37 --- /dev/null +++ b/src/content/docs/tutorials/Set-Up-Read-Only-Access.md @@ -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 + +![Testomat.io user access options chart](./images/read-only-access/read-only-access-options.png) + +* **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. + +![The company user invite with the Read-Only role selected](./images/read-only-access/1-invite-read-only.png) + +:::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. + +![Adding the Read-only user to a project under Settings, Users](./images/read-only-access/2-invite-user-to-project.png) + +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. + +![The Share Report Publicly options with expiration date and passcode](./images/read-only-access/3-share-report-publicly.png) + +:::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). \ No newline at end of file diff --git a/src/content/docs/tutorials/images/read-only-access/1-invite-read-only.png b/src/content/docs/tutorials/images/read-only-access/1-invite-read-only.png new file mode 100644 index 00000000..7aa3de14 Binary files /dev/null and b/src/content/docs/tutorials/images/read-only-access/1-invite-read-only.png differ diff --git a/src/content/docs/tutorials/images/read-only-access/2-invite-user-to-project.png b/src/content/docs/tutorials/images/read-only-access/2-invite-user-to-project.png new file mode 100644 index 00000000..eefd448c Binary files /dev/null and b/src/content/docs/tutorials/images/read-only-access/2-invite-user-to-project.png differ diff --git a/src/content/docs/tutorials/images/read-only-access/3-share-report-publicly.png b/src/content/docs/tutorials/images/read-only-access/3-share-report-publicly.png new file mode 100644 index 00000000..6453a8b0 Binary files /dev/null and b/src/content/docs/tutorials/images/read-only-access/3-share-report-publicly.png differ diff --git a/src/content/docs/tutorials/images/read-only-access/read-only-access-options.png b/src/content/docs/tutorials/images/read-only-access/read-only-access-options.png new file mode 100644 index 00000000..3db208d1 Binary files /dev/null and b/src/content/docs/tutorials/images/read-only-access/read-only-access-options.png differ