Skip to content

Documentation for service accounts #1184

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 5 commits into from
Jun 23, 2025

Conversation

pjlast
Copy link
Contributor

@pjlast pjlast commented Jun 12, 2025

Adds some documentation for service accounts, how to create them, manage them, add permissions, etc.

Pull Request approval

You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.

Copy link

vercel bot commented Jun 12, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2025 3:15pm

@pjlast pjlast marked this pull request as ready for review June 23, 2025 14:40
@pjlast pjlast changed the title Initial service account docs Documentation for service accounts Jun 23, 2025
@pjlast pjlast requested a review from a team June 23, 2025 14:41

Service accounts authenticate using access tokens rather than passwords. For detailed information about creating, managing, and using access tokens, see:

- [Creating an access token](/cli/how-tos/creating_an_access_token)
Copy link
Member

Choose a reason for hiding this comment

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

ugh, why do these docs live under cli 😆 is that the only access token documentation we have? (sigh)

- Click **Create User**
- Enter a descriptive **Username** (e.g., `ci-automation`, `api-integration`)
- Check the **Service account** checkbox
- Click **Create service account**

Choose a reason for hiding this comment

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

Not a judgement but do our users need that level of detail? Or is our user creation flow that bad?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think our user creation flow is particularly bad, it's pretty straightforward. This has just kinda been the default mode of docs writing 🤷‍♂️ perhaps it's a bad practice, and just saying "you can create them here" is good enough

@pjlast pjlast merged commit 55aef46 into main Jun 23, 2025
5 checks passed
@pjlast pjlast deleted the petrilast-src-1331-service-accounts-documentation branch June 23, 2025 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants