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

Provide an descriptive, editable and human-readable Repo Name field #629

Open
colans opened this issue Jan 10, 2025 · 2 comments
Open

Provide an descriptive, editable and human-readable Repo Name field #629

colans opened this issue Jan 10, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@colans
Copy link

colans commented Jan 10, 2025

Currently, there's a Repo Name field, but it's really an ID that:

  • can't be changed later, and
  • isn't human-readable (e.g. spaces aren't allowed)

It would be nice to have some sort of descriptive name field that can actually be changed. UX++

Solution:

  1. Change the field label of Repo Name to Repo ID (keeping everything else the same, i.e. storage)
  2. Add a new field called Repo Name which is a regular text field that allows whitespace, etc., and can be changed later. Place it above the ID field.
  3. In menus, and wherever else the repo name is now used, swap in the new field instead.
  4. Optional: Have the ID field prepopulate with whatever users type into the descriptive name field, adding hyphens & such.
@colans colans added the enhancement New feature or request label Jan 10, 2025
@garethgeorge
Copy link
Owner

garethgeorge commented Jan 17, 2025

Hey, appreciate the FR but I'm a bit hesitant here for a few reasons

My current thinking is that there's value in the name in the UI being consistent with the tag set on snapshots in the restic repo. A first class principle of backrest is that things you do in the UI should also be understandable from the restic cli. So for that reason IDs are a subset of strings admissible by restic tag.

I've thought a bit about, as you say, making the ID an internal property and supporting human readable strings -- but I think this adds a possible footgun by making it such that there are two different ways of referring to the same thing in the system. The case only gets more muddled when I introduce features like multihost management. Can the same repo have different names on different instances? etc.

To keep my maintenance simple I'm probably ruling out aliases as a feature.

@colans
Copy link
Author

colans commented Jan 18, 2025

What about keeping it visible? Just add another field that's changeable?

My use case is that I have repos that I can't rename, but want to because I'm naming things differently now. If there were a changeable field, I wouldn't care what the IDs were.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants