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

Jump to bottom

add docs for service accounts #3093

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

add docs for service accounts #3093

wants to merge 3 commits into from

Conversation

przemek-sl
Copy link
Contributor

Description

Add documentation for service accounts.

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation fix (typos, incorrect content, missing content, etc.)

@przemek-sl przemek-sl requested a review from a team as a code owner February 20, 2025 12:16
@github-actions GitHub Actions
Copy link

Deploy preview ready for 3093!
https://docs.dev.saucelabs.net/pr-preview/pr-3093

@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from 4fb0026 to 9410255 Compare February 20, 2025 12:22
@github-actions GitHub Actions
Copy link

Deploy preview ready for 3093!
https://docs.dev.saucelabs.net/pr-preview/pr-3093

@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from 9410255 to 1cd5f5f Compare February 20, 2025 14:20
@github-actions GitHub Actions
Copy link

Deploy preview ready for 3093!
https://docs.dev.saucelabs.net/pr-preview/pr-3093

@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from 1cd5f5f to 5a2c8bf Compare February 21, 2025 12:28
@github-actions GitHub Actions
Copy link

Deploy preview ready for 3093!
https://docs.dev.saucelabs.net/pr-preview/pr-3093

@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from 5a2c8bf to 3db036a Compare February 21, 2025 16:03
@github-actions GitHub Actions
Copy link

Deploy preview ready for 3093!
https://docs.dev.saucelabs.net/pr-preview/pr-3093

@Mightynumnums
Copy link

@przemek-sl A few things about the API service account doc:

  • POST and PATCH name parameter:
    | BODY | REQUIRED | STRING |
    A user-friendly display name for the service account. Must be between 1 and 128 characters.

Are there characters which are not allowed for the name? Should we list those to ensure clarity?

@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from 3db036a to df33e55 Compare February 25, 2025 14:24
@przemek-sl
Copy link
Contributor Author

@przemek-sl A few things about the API service account doc:

  • POST and PATCH name parameter:
    | BODY | REQUIRED | STRING |
    A user-friendly display name for the service account. Must be between 1 and 128 characters.

Are there characters which are not allowed for the name? Should we list those to ensure clarity?

Fixed. I have explicity listed all allowed characters.

@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from df33e55 to b6d4d0b Compare February 25, 2025 14:26
@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from b6d4d0b to 3962e86 Compare February 25, 2025 14:36
@przemek-sl
fix sidebar and links as they have been broken on the master branch
5e5c2a2 
Error:  Error: Unable to build website for locale en.
[cause]: Error: Invalid sidebar file at "sidebars.js".
These sidebar document ids do not exist:
  - testfairy/ci-tools/bamboo
  - testfairy/ci-tools/ms-app-ctr
  - testfairy/integrations/centercode
  - testfairy/integrations/coralogix
  - testfairy/integrations/google-cloud
  - testfairy/integrations/splunk
  - testfairy/integrations/zendesk

- Broken link on source page path = /pr-preview/pr-3093/testfairy/security/acct-settings/:
   -> linking to /pr-preview/pr-3093/testfairy/integrations/zendesk/
@przemek-sl przemek-sl force-pushed the IAM-6595/add-docs-for-service-accounts branch from cea4297 to 5e5c2a2 Compare February 25, 2025 16:46
@github-actions GitHub Actions
Copy link

Deploy preview ready for 3093!
https://docs.dev.saucelabs.net/pr-preview/pr-3093

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcinsauce marcinsauce marcinsauce approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@przemek-sl @Mightynumnums @marcinsauce