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 documentation on public test suites #2572

Conversation

meghan-kradolfer
Copy link
Contributor

@meghan-kradolfer meghan-kradolfer commented Nov 28, 2023

NOTE: This should not be merged until the feature flag ANALYTICS_PUBLIC_SUITE_ACCESS is turned on for all users

We are about to release a new feature that introduces public test suites into Test Analytics. We need to make sure users understand what public suites are so it is used appropriately. There is a risk that users will make their suite public without realising the privacy implications if it is not documented.

I have copied what is existing in the docs for Public pipelines and altered the content to relate to test suites

Linear ticket


Screenshot 2023-11-29 at 4 25 00 PM

@github-actions github-actions bot added the test-analytics Pull requests that update content related to Test Analytics label Nov 28, 2023
@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2572--bk-docs-preview.netlify.app

Copy link
Contributor

@KatieWright26 KatieWright26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reckon it could be worth expanding on how to turn on public suites, as only org admins will have this power initially, until the org TA settings are updated to grant this permission to all users. Maybe something like:

"Permission to make a test suite public is reserved for organization admins initially. Admins are able to extend this permission to all organization members via the Security tab in the organization settings."

Screenshot 2023-11-29 at 11 00 48

Copy link
Contributor

@KatieWright26 KatieWright26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM; would be good to get a review from @mbelton-buildkite before merging

Copy link
Contributor

@mbelton-buildkite mbelton-buildkite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left a bunch of suggestions, but in general, it looks good to me. 😊

pages/test_analytics/public_test_suites.md Outdated Show resolved Hide resolved
pages/test_analytics/public_test_suites.md Outdated Show resolved Hide resolved
pages/test_analytics/public_test_suites.md Outdated Show resolved Hide resolved
pages/test_analytics/public_test_suites.md Outdated Show resolved Hide resolved
pages/test_analytics/public_test_suites.md Outdated Show resolved Hide resolved
pages/test_analytics/public_test_suites.md Outdated Show resolved Hide resolved
@meghan-kradolfer meghan-kradolfer force-pushed the pie-2168-add-documentation-on-public-test-suites-to-the-docs branch from b7646f9 to 1038c47 Compare December 6, 2023 01:19
@meghan-kradolfer meghan-kradolfer merged commit cefddf5 into main Dec 6, 2023
1 check passed
@meghan-kradolfer meghan-kradolfer deleted the pie-2168-add-documentation-on-public-test-suites-to-the-docs branch December 6, 2023 01:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
test-analytics Pull requests that update content related to Test Analytics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants