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

The README in each example's folder should have the version number of the MVC framework used #1476

Open
mshindal opened this issue Oct 15, 2015 · 16 comments

Comments

@mshindal
Copy link

If I'm looking at the source code of one of the examples, there's no way for me to know what version of the MVC framework they are made with. The code could be very outdated and I would have no idea - for example, as of the time of this post, the emberjs example is very out of date. Sure, sometimes you can get the version number from the project's package.json, but many of the projects don't have one. This just seems like a critical piece of information that would be the first thing any developer would want to know.

@samccone
Copy link
Member

I like this idea, seems like something we could add to learn.json in the sidebar

@tastejs/todomvc thoughts?

@arthurvr
Copy link
Member

I like this idea, seems like something we could add to learn.json in the sidebar

👍

@sindresorhus
Copy link
Member

👍 for having it in the learn bar

@addyosmani
Copy link
Member

Support for this idea for the learn bar too.

@passy
Copy link
Member

passy commented Oct 16, 2015

Agreeeed.

On Fri, 16 Oct 2015 at 09:26 Addy Osmani [email protected] wrote:

Support for this idea for the learn bar too.


Reply to this email directly or view it on GitHub
#1476 (comment).

@beatfreaker
Copy link

@samccone i can do a PR for this but need some guidance.

how about storing version like this in learn.json

{
    "angularjs":{
        "name":"AngularJS",
        "homepage":"angularjs.org",
        "version":"1.1.0"
    }
}

@samccone
Copy link
Member

I like this idea @beatfreaker however, I wonder what we should do for composite examples... like react + backbone...

any thoughts?

@samccone
Copy link
Member

"angularjs": {
   "version": [
       {"foo: "1.1.1"},
       {"bar": "2.2.2"}
    ] 
}

maybe this ☝️ ?

@beatfreaker
Copy link

👍 yeah we can go with array

so this version array will contain version of every framework used as an example which is specified under example array right?

@samccone
Copy link
Member

yep :) you got it

@beatfreaker
Copy link

okay and so we have to navigate to every example folder manually to get the version of framework used and then populate it in learn.json right?

@samccone
Copy link
Member

unfortunately yes 😬

@beatfreaker
Copy link

haha okay will try to make a PR this weekend and what about displaying it in side bar?

any thought where to display it any specific place or else?

@samccone
Copy link
Member

woot! cool.

We can tackle the display part after we get the initial data in :)

@kveretennicov
Copy link
Contributor

+1! This may help to draw attention to examples based on outdated libs and prevent issues like #1748.

@addyosmani
Copy link
Member

I would be very supportive of this. I think the sidebar would be a pretty fair place to visualize version info.

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

No branches or pull requests

9 participants