docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Review and update Desktop App Custom Dictionaries documentation

Open cwarnermm opened this issue 2 years ago • 5 comments

Review the existing Desktop App Custom Dictionaries product documentation for technical accuracy and update as needed.

The following user feedback has been shared with Mattermost about this page of product documentation: - The 'Setting up' directive does not work. - When I press Save and restart Mattermost, the directory is not shown anymore and it does not work with the selected dictionary. Used a local folder which holds the file.

Prerequisites: Experience with and access to the latest release of the Mattermost Desktop App is needed to complete this technical review and apply required updates.

cwarnermm avatar Oct 01 '21 15:10 cwarnermm

Would like to work on this @cwarnermm

AnshMishra2001 avatar Oct 03 '21 05:10 AnshMishra2001

We appreciate your help with this, @AnshMishra2001! Thank you!

cwarnermm avatar Oct 04 '21 12:10 cwarnermm

@AnshMishra2001 - Are you actively working on this? Would you like to keep it assigned to you?

cwarnermm avatar Dec 07 '21 13:12 cwarnermm

Excuse my intrusion here but this dictionary thing is all broken - Windows App

How the hell can you set it up now to do checking for language you need ?

Currently it looks for system language and ignores everything else, previously it was an easy selection what you needed to check and with what to check, like in most current browsers,.

Error reporting on what you setup in the url link is none existent

How can you work with several languages at the same time ?

MM-Mikhail avatar Jan 27 '22 15:01 MM-Mikhail

@MM-Mikhail - Would you be open to creating an issue detailing your feedback for the Windows Desktop App via https://github.com/mattermost/desktop?

cwarnermm avatar Mar 21 '22 20:03 cwarnermm

@cwarnermm - Still need help here?

TomerPacific avatar Nov 02 '23 18:11 TomerPacific

I'd love your help with this one, @TomerPacific!

cwarnermm avatar Nov 02 '23 18:11 cwarnermm

@cwarnermm - I'll try to see if I can get the Desktop App set up and update you.

TomerPacific avatar Nov 02 '23 20:11 TomerPacific

@cwarnermm - Is there a test server/mock server I can use in order to login to the Desktop app?

mm

TomerPacific avatar Nov 03 '23 09:11 TomerPacific

@TomerPacific - You're welcome to connect to the Mattermost Community Server any time for such testing. Alternatively, you could also connect to the Localization Community Server.

cwarnermm avatar Nov 03 '23 12:11 cwarnermm

@cwarnermm - I see that part of the instructions require to host the language files on an external web server. Is there any guidance here on how one would do that? Trying to understand how much effort this will take on my end.

TomerPacific avatar Nov 04 '23 18:11 TomerPacific

@devinbinnie - @TomerPacific is looking to test the desktop app custom dictionaries functionality and update our documentation. Is there a recommended way forward for setting everything up for testing? Do we have an environment that could be used for this effort?

cwarnermm avatar Nov 06 '23 14:11 cwarnermm

@cwarnermm To clarify, are we talking about the custom spellchecker URL? If so, I think you just need to provide a URL in the config file (seems like we don't have an interface for it). I've never messed with that functionality myself, but here's the relevant Electron API method: https://www.electronjs.org/docs/latest/api/session#sessetspellcheckerdictionarydownloadurlurl

devinbinnie avatar Nov 06 '23 14:11 devinbinnie

Thanks @cwarnermm for helping out and @devinbinnie for the feedback. What I noticed was that, while you need to put a URL as a custom dictionary, that means the file needs to be hosted somewhere. What I was asking is, if I can use something simple like Google Drive (as an example) or if I need to boot up a my own server for this?

mm

TomerPacific avatar Nov 06 '23 17:11 TomerPacific

@TomerPacific I would assume as long as the file is publicly accessible via URL it should be fine. Google Drive might not be ideal, it might need to be hosted somewhere. You could always try hosting it locally.

devinbinnie avatar Nov 06 '23 18:11 devinbinnie

@cwarnermm - I followed the steps detailed in the current documentation, and uploaded a language file to be used as a directory where definitions can be found and saw no issues.

TomerPacific avatar Nov 06 '23 18:11 TomerPacific

That's great news, @TomerPacific! Thank you for validating that the product docs are correct by testing the product functionality end to end. Very much appreciated. I'm going to close this issue since no docs updates are needed.

cwarnermm avatar Nov 06 '23 19:11 cwarnermm