Plan a 1.0.x Release

Created on 23 February 2023, over 1 year ago
Updated 9 June 2023, about 1 year ago

Problem/Motivation

In our 3-part plan we talked about finishing this module by building in it in stages.

  • Stage 1: Have a preview on the same page as the edit page.
  • Stage 2: Update the preview when the user stops typing in a form field (debounce)
  • Stage 3: Make form fields Reactive (Editing the preview immediately)

I propose that we release version 1.0.x as soon as we can accomplish stage 1.

Then, we can begin targeting commits to Version 2.0.x and launch 2.0 as soon as we accomplish stage 2's objectives. (mainly reloading the preview upon editing fields)

And if we ever figure out how to get stage 3 done, that'll be version 3.0.x

It wouldn't be ideal to be supporting all 3 versions, but we can plan the deprecation and elimination of versions if we ever get that far.

Proposed resolution

We're very close to meeting the minimum requirements of 1.0.x. I think we can start preparing the release and getting this out there. Then we can work on minor (1.0.(x+1)) and major (1.y.x) updates if we get a lot of feedback / think of improvements.

Remaining tasks

Agree on release plan.

Completed

✨ Position the new iFrame so preview and edit are side by side Fixed
πŸ“Œ Take over the Preview button Fixed
πŸ“Œ Replace enablePreview logic with permission check. Fixed
πŸ“Œ Add Tests Fixed
πŸ“Œ Provide a button to open preview in new page Active
πŸ“Œ Remove contextual links from same_page'ed preview Fixed

Release Blockers

✨ [meta] Address accessibility concerns Active
✨ Move Preview controls to edit page Fixed
✨ Toggle Preview Should Refresh Preview Fixed

Nice to haves

πŸ“Œ Add a grabber to the left border of the dialog Postponed
πŸ“Œ On by default, make off-by-default an opt-in setting Closed: duplicate
πŸ“Œ Better module page Postponed
✨ Scroll position is lost when refreshing the preview Fixed
✨ Provide Preview Presets for Common Device Widths Active

Process when we're ready

πŸ“Œ Create 1.0.0 Release Fixed

πŸ“Œ Task
Status

Fixed

Version

1.0

Component

Plan

Created by

πŸ‡ΊπŸ‡ΈUnited States cosmicdreams Minneapolis/St. Paul

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024