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

Saving and integrating the config-editor #256

Closed
dan-bowerman opened this issue Feb 29, 2024 · 4 comments · Fixed by #271
Closed

Saving and integrating the config-editor #256

dan-bowerman opened this issue Feb 29, 2024 · 4 comments · Fixed by #271
Assignees
Labels
Discussion Maps Issues concerning map config generation or the FGPA tool Priority: Urgent This task should be grabbed before any others Workflow Development Documentation and Processes for developers and clients to build and deploy Storylines products

Comments

@dan-bowerman
Copy link
Member

@tosellob's review revealed the awkward symptom of having "apps within an app" when it comes to map configurations.

In the current "FGPA" workflow, the user creates a map-type slide, gives the map config a filename, and the FGPA tool opens. The user must actively SAVE the file within RESPECT, in addition to saving the Storylines product itself. This is confusing, as the user doesn't understand what's being saved and where with regards to the RAMP configs.

We have an opportunity to modify this workflow this as we switch to the Mohsin-Editor:

  • Setting RAMP config filenames is basically meaningless to the user. Perhaps we can standardize this and remove the option to name them entirely?
  • Do we need an "internal" save button with the config editor, or should we go with a "save-as-you-edit" approach?

Related #239.

@dan-bowerman dan-bowerman added Priority: Urgent This task should be grabbed before any others Workflow Development Documentation and Processes for developers and clients to build and deploy Storylines products Discussion Maps Issues concerning map config generation or the FGPA tool labels Feb 29, 2024
@dan-bowerman
Copy link
Member Author

Config-editor's API can save when you want. The top right button can handle this call.
We should have a bigger discussion about implications of removing file naming for map configs, and what we should standardize to if we are removing them.

@mohsin-r mohsin-r assigned mohsin-r and unassigned mohsin-r Mar 7, 2024
@dan-bowerman
Copy link
Member Author

Related #205.

@dan-bowerman
Copy link
Member Author

Braindump for upcoming discussion:

Establishing a "default" map filename

  • Name after slide/panel number?
    • Probably a bad idea, as this would quickly lose meaning if slides get reordered.
  • Pull from panel title?
    • Is panel title a mandatory field? If not, maybe it should be?
    • Panel title + incremental integer?
      • Could run into length limits, e.g. Location of facilities that report sulphuric acid to the NPRI-map-01.json
  • UUID + incremental integer?
    • 60d407cc-8879-4bc4-a474-29f6639125fd-map-01.json
    • 60d407cc-8879-4bc4-a474-29f6639125fd-map-02.json
    • 60d407cc-8879-4bc4-a474-29f6639125fd-map-99.json
  • Must work with existing products that don't follow any naming convention
  • Other ideas?
  • Should we apply this same logic to charts?

@dan-bowerman
Copy link
Member Author

Let's go with the UUID+map+integer naming convention for the time being.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Maps Issues concerning map config generation or the FGPA tool Priority: Urgent This task should be grabbed before any others Workflow Development Documentation and Processes for developers and clients to build and deploy Storylines products
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants