-
Notifications
You must be signed in to change notification settings - Fork 4.7k
add vue school links to supplement component documentation with video… #1119
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
add vue school links to supplement component documentation with video… #1119
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the links!
A general observation on terminology. In the documentation, we avoid using the term 'Vue instance' when talking about Vue 3. That name made sense in Vue 2, with new Vue
and Vue.prototype
, but in Vue 3 it doesn't fit so well. Instead we use 'application instance' or 'component instance', depending on which of the two instances we're referring to.
The first few videos in the 'Vue.js 3 Components Fundamentals' course have code a bit like this:
const app = Vue.createApp({
}).mount('#app')
It's potentially problematic using the name app
for the root component instance returned by mount
. The name app
is more often used for the application instance returned by createApp
, which is a different object. e.g.:
const app = Vue.createApp({}) // application instance
const vm = app.mount('#app') // root component instance
Throughout the docs we use this same convention of using app
to refer to the application instance. As app
isn't used for anything in the examples in the videos, it might be better if it wasn't included.
src/guide/single-file-component.md
Outdated
@@ -1,5 +1,7 @@ | |||
# Single File Components | |||
|
|||
<VideoLesson href="https://vueschool.io/courses/vue-3-single-file-components?friend=vuejs" title="Free Vue.js Single File Components Course">Learn about single file components with a free video course on Vue School</VideoLesson> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that there's only one free video in this course. Should the link not point directly to that video?
@skirtles-code Thanks very much for the feedback, especially the piece on the Vue instance vs application /component instance terminology. That's very helpful! Below are my proposed changes to address the issues you've brought up. Please let me know if I've missed anything, otherwise let me know I'm good to implement the changes. Thanks again! app instance vs root component instance
Vue instance vs application or component instance
data as object no longer valid on root
parent is root instance
sfc link
|
I can't easily provide inline responses here but hopefully this won't be too difficult to follow. I've tried to use the same names and timestamps as in your proposed changes. I've only listed the proposals where I had something to add, the others sounded fine to me. Vue instance vs application or component instance
data as object no longer valid on root
|
@skirtles-code Yes all that makes sense. I will note those corrections. I think that leaves just this issue unsolved:
Thanks! |
@danielkellyio The proposed correction at 0:56 sounds good to me. |
@skirtles-code all of the discussed revisions have been made and published to the courses. Thanks! |
@skirtles-code just checking in on this to see if anything else needs to be done on my side before merge. Thanks! |
@danielkellyio The thing that's currently holding this up is reviewing the subtitles. I've only watched through a couple of them and there are lots of typos and it takes me a ridiculously long time to create a full list of all the corrections and their timestamps. If I were reviewing the same thing as text it would take no time at all. Is there any way we can speed up this process? I don't really have time to go through all of these videos creating lists of all the subtitle corrections. Can somebody at Vue School with direct access to edit the subtitles make these corrections so all I have to do is check them? |
@skirtles-code I can definitely get somebody on our side to go through the subtitles and make corrections. My apologies, I didn't review them myself and assumed they were good. I'll let you know once that's complete. Thanks! |
@skirtles-code I've gone through the subtitles and made corrections where necessary. Thanks! |
@skirtles-code just checking in on this. I think all the blockers have been removed on our side. Thanks! |
@@ -2,6 +2,8 @@ | |||
|
|||
> This page assumes you've already read the [Components Basics](component-basics.md). Read that first if you are new to components. | |||
|
|||
<VideoLesson href="https://vueschool.io/lessons/vue-3-component-slots?friend=vuejs" title="Free Vue.js Slots lesson">Learn slot basics with a free lesson on Vue School</VideoLesson> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bencodezen FYI, this video is a new addition.
This PR adds Vue School links to the documentation to supplement the documentation with free training videos about components.
The lessons are up-to-date, V3 versions of component lessons currently on the v2 documentation site.
Screenshots of the placements can be seen here
Links:
Component Basics
Component Props
Component Registration
Component Slots
Single File Components
Thanks!