#3714 [UI/UX - 5.0+] Better explanation of regenerating repos in Settings menu
Opened 6 months ago by jflory7. Modified 5 months ago

Problem

Regenerating repos sounds dangerous and scary but there isn't anything clear in the UI or an explanation to tell me otherwise :sweat_smile:

Analysis

I noticed this setting in 5.0+ when going through the Settings menu. I was hoping for an explanation or link to docs to learn what this does or an explanation of when I would need to do this.

Implementation

  • Short paragraph or hover-over hint to explain usage?
  • Link to existing documentation?
  • If dangerous, more clear hinting with red buttons and maybe something clever like a hazard symbol for colorblind users

Metadata Update from @pingou:
- Issue tagged with: doc, easyfix

6 months ago

Hey, I will take a look at this. BTW, could you please point me where to find more details on "Regenerate Repos"? Since I jut get started with this project:-)

Hey, I will take a look at this. BTW, could you please point me where to find more details on "Regenerate Repos"? Since I jut get started with this project:-)

Tickets and pull-requests metadata are stored in git repositories in JSON files, these two buttons will update the JSON representations of each and every tickets and pull-requests in the projects in their corresponding git repos.
It's going to be a long task but there are few cases where it can be interesting to do it (fairly limited number of cases though)

fairly limited number of cases though

@pingou What are those use cases? To me as a user, this is the interesting / helpful part. I don't know why I would need to update the JSON blobs for tickets and PRs.

@pingou Thanks for the explanation. I'm going to read the source code, could you please give more details on this? E.g. which source files are related, that I can start with.

@pingou I'm also curious now, as like @jflory7 asks, when and why would we need to update the JSON blobs for tickets and PRs? Could you please give us a more detailed explanation? Thanks:-)

@pingou What are those use cases? To me as a user, this is the interesting / helpful part. I don't know why I would need to update the JSON blobs for tickets and PRs.

The one that comes in mind is basically, you want to migrate off pagure and want to make sure the data in the ticket/request repo is up to date with what is in the database.

@pingou Thanks for the explanation. I just went through the source code, thinking about to make a more detailed hover-over hint, does that sound good to you?

make sure the data in the ticket/request repo is up to date with what is in the database.

Is there a risk or probability they become out of sync? And does this action risk any negative effects to the repository configuration or source code? I'm also curious.

Login to comment on this ticket.

Metadata