sillsdev / StoryProducer

Story Producer app
Other
5 stars 11 forks source link

Strategy for deploying WordLinks files #622

Open bryanwussow opened 2 years ago

bryanwussow commented 2 years ago

Testing and discussion in issue #615 Wordlinks feature needs to handle csv file changes made it apparent that attempting to switch a SP workspace folder from one language to another would make a mess of the WordLinks word list. Dale rightly suggested that we train the user to create a new SP workspace for the new language csv file.

Indeed, it makes sense for the user to choose (in his own mind, then perhaps also in a choice within the app) the LWC he intends to work with in a new workspace. Once SP translation work begins in a workspace, this choice would normally never be changed. This should be a good approach for typical local translators who work in only one LWC. It would also work for technical support people if they need to set up multiple workspaces, because they should use one specific LWC in any given workspace.

In SP v3.0, the user chooses in his own mind the LWC he intends to work with in a new workspace. He downloads templates in that language and puts them in the workspace. This approach will continue for v3.1 . With that, it appears that automatically installing the English WordLinks file will be a problem for any user intending to use a different LWC.

Bryan proposes the following strategy.

For SP v3.1 Publish WordLinks files on Google drive, for manual installation Put the English and Swahili WordLinks CSV files (the files ultimately approved by IMS) on Story Producer Resources. Users would need to download and install on their phone the Wordlinks file appropriate for the LWC of their templates - a manual process similar to how they manually install templates with the LWC they want.

For SP v3.2 package the WorkLinks files with the apk (or download the correct one automatically) In SP v3.2, when a new workspace is created (ie when a workspace is selected in SP, and SP finds that it is empty) we want SP v3.2 to ask the user for the LWC they want to work in, and then SP will do much of the file management work. SP will assist the user to download and install templates for that LWC, and can automatically install Wordlinks for that LWC.

To do:

User Story

As a [choose: local translator / trainer / tech support / admin], I need to in order to .

Is your feature request related to a problem or rationale? Please describe.

Describe specific requirements for what you want to happen : __

Describe alternatives you've considered, and/or additional context: __


The sections above are all that's needed for a request. The following sections are filled out and groomed by the development team before work begins...

To Do:

See the SPEC DOC In summary:

Acceptance

[steps to verify that the new feature works as expected]

Testing Ideas

[Tips for the testers. If you include detailed steps, use the 'Steps to Reproduce' format (and past tense).] __

Original Report from __

indented quoted text is good but optional

bryanwussow commented 2 years ago

@DaleHensley Hi Dale, Since we are unsettled on what to do I need to review this with Greg and those involved in training. This issue is not in the Backlog column yet for v3.1, so we are not ready for any code changes yet.