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

Show resource IDs in the Dashboard #15654

Open
easyCZ opened this issue Jan 10, 2023 · 4 comments
Open

Show resource IDs in the Dashboard #15654

easyCZ opened this issue Jan 10, 2023 · 4 comments
Labels
feature: public-api Issues relating to Public API gitpod for gitpod For tagging issues that will improve Gitpod for internal Gitpod use. meta: never-stale This issue can never become stale team: webapp Issue belongs to the WebApp team

Comments

@easyCZ
Copy link
Member

easyCZ commented Jan 10, 2023

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 easyCZ added team: webapp Issue belongs to the WebApp team gitpod for gitpod For tagging issues that will improve Gitpod for internal Gitpod use. labels Jan 10, 2023
@loujaybee
Copy link
Member

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.

@gtsiolis
Copy link
Contributor

gtsiolis commented Jan 10, 2023

@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 🅰️ below as well as for the workspace in the more actions dropdown menu like 🅱️.

🅰️ 🅱️
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

@easyCZ
Copy link
Member Author

easyCZ commented Jan 10, 2023

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.

@loujaybee loujaybee added the feature: public-api Issues relating to Public API label Jan 24, 2023
@stale
Copy link

stale bot commented May 9, 2023

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 stale bot added the meta: stale This issue/PR is stale and will be closed soon label May 9, 2023
@stale stale bot closed this as completed Jun 11, 2023
@loujaybee loujaybee added meta: never-stale This issue can never become stale and removed meta: stale This issue/PR is stale and will be closed soon labels Jun 15, 2023
@filiptronicek filiptronicek reopened this Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature: public-api Issues relating to Public API gitpod for gitpod For tagging issues that will improve Gitpod for internal Gitpod use. meta: never-stale This issue can never become stale team: webapp Issue belongs to the WebApp team
Projects
None yet
Development

No branches or pull requests

4 participants