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

[Demos] Migration from mv-edit* to mv-editor* #108

Merged
merged 1 commit into from
Mar 21, 2021
Merged

[Demos] Migration from mv-edit* to mv-editor* #108

merged 1 commit into from
Mar 21, 2021

Conversation

DmitrySharabin
Copy link
Member

No description provided.

@LeaVerou
Copy link
Member

Thank you!

@DmitrySharabin DmitrySharabin deleted the demos-migration-to-mv-editor branch March 21, 2021 10:28
@LeaVerou
Copy link
Member

We should probably add a note somewhere that up to version [whatever the latest stable is] these attributes had a different name. Otherwise people using the latest stable will be very confused. And even after release, people might be on older versions, or people may be on the latest stable, discover their app is broken, and go to the docs to figure out how to fix it.

@DmitrySharabin
Copy link
Member Author

I was thinking about that. And I agree with you.

I was also thinking about whether we should tweet about it.

And I am leaning towards the idea of adding a note to the docs as well. What do you think?

@LeaVerou
Copy link
Member

Sure! But let's first add the note.

@LeaVerou
Copy link
Member

LeaVerou commented Mar 24, 2021

And we need to iron out some minor regressions before tweeting about this. E.g. see:
image

Edit: fixed

@DmitrySharabin
Copy link
Member Author

Sure! But let's first add the note.

What if we add a comment to the corresponding HTML files? So, we'll get something like that:

The Talks list demo

<!-- If you are using Mavo up to version 0.2.3, please replace mv-editor with mv-edit in the following tag. -->
<span property class="type" mv-editor="#talk-type"></span>

and

<!-- If you are using Mavo up to version 0.2.3, please replace mv-editor with mv-edit in the following tag. -->
<span property="country" mv-editor="#countries"></span>

The Restaurant visit log demo

<!-- If you are using Mavo up to version 0.2.3, please replace mv-editor-step with mv-edit-step in the following tag. -->
<meter property="dishRating" min="0" value="4" max="5" mv-editor-step="0.5"></meter>

Or you had another way to add the note in your mind?

@LeaVerou
Copy link
Member

LeaVerou commented Mar 28, 2021

That adds a lot of overhead to every single use of mv-editor*.
I was just thinking of something like:

Note: In versions of Mavo up to 0.2.3 you will need to use `mv-edit` instead of `mv-editor` 
and `mv-edit-*` attributes instead of `mv-editor-*` attributes. 

in the docs section where we describe these attributes (possibly two notes if these are described in separate sections)

@DmitrySharabin
Copy link
Member Author

Oh, I see. I thought you meant we should add the note both in the demos and in the docs. So I sent a PR to the docs (and already re-sent it with the text you suggested) and decided to discuss how to add the note to the demos. 😅 And if we don't need to add any comments, then I believe we are done with this PR, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants