gitpod icon indicating copy to clipboard operation
gitpod copied to clipboard

Show resource IDs in the Dashboard

Open easyCZ opened this issue 3 years ago • 4 comments

Is your feature request related to a problem? Please describe

When viewing a resource (workspace, project, team, prebuild), show the UUID of the resource in the UI.

This is useful for the following:

  • Reporting issues to gitpod with a particular resource
  • Making it easier to control experiments for particular resources
  • Cross-referencing resources in the system

easyCZ avatar Jan 10 '23 10:01 easyCZ

For more context: We are often using these identifiers to include users in A/B tests or private betas. There is no current easy way to communicate how to get these values. We can start using the team name, or other aspects of the user as the unique identifier, however if the resource ID is the best unique identifier, we do need some way for users to access that, even if it's hidden away on some page in the user settings.

loujaybee avatar Jan 10 '23 10:01 loujaybee

@easyCZ I understand and agree with the problem statement above. Cc @loujaybee

FWIW, I could be wrong but some UUIDs are already visible in the URL path. For example:

  1. The prebuild UUID
  2. The user UUID in /admin/users
  3. The project UUID in /admin/projects
  4. The team UUID in /admin/teams

However, it's obvious that some of these are hidden behind the admin dashboard and could be beneficial to surface these in the dashboard of the user.

Spent some time doing a quick exploration how this could look like and we could introduce a subtle copy-to-clipboard button for the team, project, and prebuild on the header section like :a: below as well as for the workspace in the more actions dropdown menu like :b:.

:a: :b:
Screenshot 2023-01-10 at 12 54 00 PM (2) Screenshot 2023-01-10 at 1 00 29 PM (2)

In both cases we could shorten the UUID to the first part (see screenhot below) and mention in the copy-to-clipboard tooltip that this action will copy the full UUID.

Screenshot 2023-01-10 at 1 52 43 PM

gtsiolis avatar Jan 10 '23 11:01 gtsiolis

Thanks @gtsiolis

Seeing the UUIDs in the admin view is a bonus, but I'd like for them to be primarily visible in the regular UI.

An additional reason for this is to enable easier integration with the Public API. When exploring initially, a user may want to find the ID of a resource and retrieve it with the API as a first touch point to get familiar with the SDKs - easily grabbing the IDs would aid that.

easyCZ avatar Jan 10 '23 20:01 easyCZ

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar May 09 '23 02:05 stale[bot]