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

Migrating to boba-editor-next #97

Open
8 tasks
essential-randomness opened this issue Sep 21, 2022 · 0 comments
Open
8 tasks

Migrating to boba-editor-next #97

essential-randomness opened this issue Sep 21, 2022 · 0 comments
Labels
🪲 Dev experience An issue that's not visible to users, but it's definitely visible to developers. 🚧 To sort Auto-added to all issues; removed after issues have been reviewed and classified

Comments

@essential-randomness
Copy link

essential-randomness commented Sep 21, 2022

Currently blocked on getting BEN to feature parity with boba-editor

Goal

Swapping boba-editor with boba-editor-next (BEN), for reasons to be documented at some other juncture.

How

We'll do the migration in 2 phases:

  1. cool-phase-name#1: new posts are created (and displayed) through BEN, but boba-editor remains in charge of old posts
  2. cool-phase-name#2: old posts are converted to the new BEN format, and boba-editor is taken out back and shot in a dark alley somewhere given the proper send off and a honorable discharge

cool-phase-name#1

a.k.a. "new posts are created (and displayed) through BEN, but boba-editor remains in charge of old posts"

Notes

Backend changes

This phase doesn't need to touch boba-backend or the DB in any way. boba-components can conditionally display content using either boba-editor OR BEN according to which format the passed JSON is in. This doesn't mean that we can't choose to e.g. tell the db to save old and new content in different columns if we so wish, but just that we're not forced to do backend changes.

Frontend changes

In the ideal case, boba-frontend wouldn't need to be touched either. Any change done there should be reviewed with suspicion and questioned.

Subphases (bugs to be filed)

  • An entity in boba-components (e.g. posts, comments) can use BEN to display BEN-format content
  • An entity in boba-components (e.g. posts, comments) can conditionally use BEN or boba-editor to display either content
  • An editable entity in boba-components (e.g. posts, comments) uses BEN to accept any type of input, with custom restrictions
  • An editable entity in boba-components (e.g. posts, comments) can go through the whole upload pipeline (e.g. getting all the included images uploaded) using BEN
  • All entities in boba-components are switched to use BEN (a.k.a "rest of the owl")

cool-phase-name#2

a.k.a. old posts are converted to the new BENformat, and boba-editor is taken out back and shot in a dark alley somewhere given the proper send off and a honorable discharge

Steps

@essential-randomness essential-randomness added 🚧 To sort Auto-added to all issues; removed after issues have been reviewed and classified 🪲 Dev experience An issue that's not visible to users, but it's definitely visible to developers. labels Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪲 Dev experience An issue that's not visible to users, but it's definitely visible to developers. 🚧 To sort Auto-added to all issues; removed after issues have been reviewed and classified
Projects
None yet
Development

No branches or pull requests

1 participant