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.

Sign up for GitHub

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

Jump to bottom

Improve the syncing status text displayed to the user #6882

Merged
merged 5 commits into from
Jul 30, 2024
Merged

Improve the syncing status text displayed to the user #6882

merged 5 commits into from
Jul 30, 2024

Conversation

camilasan
Copy link
Member

@camilasan camilasan commented Jul 5, 2024 •
edited
Loading

before => after:

  • capitalize all sync status to string e.g. "upload" => "Upload", "download" => "Download"

  • list less file names in the details of the progress bar
    Screenshot 2024-07-29 at 19 29 27

  • "Reconciling changes" => "Reconciling local and remote changes"

  • "Syncing changes" => "Syncing"

  • "Downloading %1. Please wait …" => "Downloading %1 …" (this is the updater status though)

  • "0 of 6 files" => "1 of 6 files" (do not display 0, but 1)"

  • "Synchronizing VirtualFiles with local folder" => "Synchronizing virtual files in local folder"

  • "Synchronizing with local folder" => "Synchronizing files in local folder"

  • "Waiting …" => "About to start syncing"
    Screenshot 2024-07-05 at 14 10 54

  • "Preparing sync" => "Checking folder changes"
    Screenshot 2024-07-05 at 15 03 23

  • "Waiting to start sync" => "Waiting to start syncing"

  • "Sync Success" => "Sync was successful"

  • "Status undefined" => "Sync status is unknown"

  • "Sync Success, some files were ignored." => "Sync was successful but some files were ignored"

  • "Sync Error" => "Error occurred during sync"

  • "Setup Error" => "Error occurred during setup"

  • "Aborting …" => "Stopping sync"

  • "Synchronizing VirtualFiles with local folder" => "Synchronizing virtual files in local folder"

  • "Synchronizing with local folder" => "Synchronizing files in local folder"

  • Change tooltip text
    Screenshot 2024-07-29 at 18 17 30

claucambra
claucambra approved these changes Jul 9, 2024
View reviewed changes
Copy link
Collaborator

@claucambra claucambra left a comment

Choose a reason for hiding this comment

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

Thank you for the readability improvements, I am a huge fan 🙂

I left a small comment but otherwise it looks ok to me

It's a draft so if things change substantially I can re-review

src/gui/folderstatusmodel.cpp Outdated Show resolved Hide resolved
jancborchardt
jancborchardt approved these changes Jul 11, 2024
View reviewed changes
Copy link
Member

@jancborchardt jancborchardt left a comment

Choose a reason for hiding this comment

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

All sounds like nice improvements to me. :)

"Reconciling local and remote changes" could use a more commonly understandable word instead of "reconciling". Maybe just "Syncing local and remote changes"?

@camilasan
Copy link
Member Author

@jancborchardt just a few more suggestions - atm mostly used in tooltips:
"Waiting to start sync" => "Waiting to start syncing"
"Sync Success" => "Sync was successful"
"Status undefined" => "Syncing status is unknown"
"Sync Success, some files were ignored." => "Sync was successful but some files were ignored"
"Sync Error" => "Error occurred during syncing"
"Setup Error" => "Error occurred during setup"
"Aborting …" => "Stopping sync"

@camilasan
Copy link
Member Author

camilasan commented Jul 11, 2024 •
edited
Loading

@jancborchardt just a few more suggestions - atm mostly used in tooltips:

  • "Waiting to start sync" => "Waiting to start syncing"
  • "Sync Success" => "Sync was successful"
  • "Status undefined" => "Syncing status is unknown"
  • "Sync Success, some files were ignored." => "Sync was successful but some files were ignored"
  • "Sync Error" => "Error occurred during syncing"
  • "Setup Error" => "Error occurred during setup"
  • "Aborting …" => "Stopping sync"

@camilasan camilasan closed this Jul 11, 2024
@camilasan camilasan reopened this Jul 11, 2024
jancborchardt
jancborchardt reviewed Jul 11, 2024
View reviewed changes
Copy link
Member

@jancborchardt jancborchardt left a comment

Choose a reason for hiding this comment

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

@camilasan sounds good, only 2 changes so it’s consistently "sync"

"Status undefined" => "Syncing status is unknown"

→ Sync status is unknown

"Sync Error" => "Error occurred during syncing"

Error occurred during sync

@camilasan camilasan force-pushed the enh/syncing-status branch 2 times, most recently from 16aa232 to 16d01d5 Compare July 29, 2024 18:05
@camilasan camilasan marked this pull request as ready for review July 29, 2024 18:06
camilasan added 5 commits July 29, 2024 20:06
@camilasan
Display more details of the sync progress in the settings dialog.
b5888f4 
- Add margin to sync progress text.
- Make use of the text in FolderStatusDelegate::FolderSyncText.

Signed-off-by: Camila Ayres <[email protected]>
@camilasan
Modernize FolderStatusModel::slotSetProgress.
23a1770 
- Add const auto.
- Change variable names to be more clear.

Signed-off-by: Camila Ayres <[email protected]>
@camilasan
Make sync status text easier to understand.
0f2554e 
- Never display "please wait" to users.
- Only start displaying status starting at 1. e.g. "0 f 6 files" => "1 of 6 files"
- Improve text for FolderStatusDelegate::FolderSyncText.
- Reconciling => Syncing.
- Syncing => Sync.

Signed-off-by: Camila Ayres <[email protected]>
@camilasan
Capitalize sync instruction strings returned by Progress::asActionStr…
5cf4e87 
…ing.

Signed-off-by: Camila Ayres <[email protected]>
@camilasan
List less file names in the sync progress bar text.
43777be 
Signed-off-by: Camila Ayres <[email protected]>
@camilasan camilasan force-pushed the enh/syncing-status branch from 16d01d5 to 43777be Compare July 29, 2024 18:06
@camilasan camilasan requested a review from mgallien July 29, 2024 18:07
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
3 Security Hotspots
0.0% Coverage on New Code (required ≥ 80%)
C Maintainability Rating on New Code (required ≥ A)
35 New Code Smells (required ≤ 0)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

@nextcloud-desktop-bot
Copy link

AppImage file: nextcloud-PR-6882-43777bed226729fda00881ea35a917b78c9a776c-x86_64.AppImage

To test this change/fix you can simply download above AppImage file and test it.

Please make sure to quit your existing Nextcloud app and backup your data.

@camilasan
Copy link
Member Author

/backport to stable-3.13

@camilasan camilasan merged commit c52b1e9 into master Jul 30, 2024
12 of 15 checks passed
@camilasan camilasan deleted the enh/syncing-status branch July 30, 2024 10:35
@backportbot backportbot bot mentioned this pull request Jul 30, 2024
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jancborchardt jancborchardt jancborchardt approved these changes

@claucambra claucambra claucambra approved these changes

@mgallien mgallien Awaiting requested review from mgallien

Assignees
No one assigned
Labels
backport-request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@camilasan @nextcloud-desktop-bot @jancborchardt @claucambra