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

Show release version info for modules/properties/etc. #300

Open
chasenlehara opened this issue Jun 5, 2017 · 7 comments
Open

Show release version info for modules/properties/etc. #300

chasenlehara opened this issue Jun 5, 2017 · 7 comments

Comments

@chasenlehara
Copy link
Member

We used to show release info for our modules: see the 2.1 on this page:
screen shot 2017-06-05 at 8 41 39 am

We still have that information in some of our repositories but we’re not showing it. It’s a little bit more complicated now that any given thing has two release versions—one in the module, another in the packaged version of CanJS. We will probably want to display both, but I’m not 100% sure.

@jamiemccue
Copy link
Contributor

jamiemccue commented Jun 6, 2017

@chasenlehara

  • show module release version number
  • show API release version number
  • discuss using the term 'introduced': example: can-param 1.0.1 introduced CanJS 3.6
  • Bit docs will figure out how it corresponds to the current major CanJS version

Examples in keeping with the brutalist theme. These need refining once we chose a direction.

1

2

3

@jamiemccue
Copy link
Contributor

  • remove module 2.0 text - leave introduced...

  • make button - link to canjs

  • or make label -

  • right align 2nd number

  • mobile - above and below

@jamiemccue
Copy link
Contributor

jamiemccue commented Jun 26, 2017

Use button style similar to other buttons:
release-version-1

Mobile:
release-version-1-mobile

@jamiemccue
Copy link
Contributor

@chasenlehara Do you have any feedback on these recent mockups?

@chasenlehara chasenlehara assigned imaustink and unassigned jamiemccue Jun 28, 2017
@chasenlehara
Copy link
Member Author

Looks good, thanks @jamiemccue! Moving this to @imaustink’s backlog for implementation.

@tomgreever
Copy link
Contributor

I'd like to recommend simplifying this design by including the name of the collection and the CanJS version next to the title in smaller text.
screen shot 2017-10-11 at 3 32 08 pm

There are a couple of reasons for this:

  1. I'm afraid of overloading the user with too many buttons on the right side
  2. Buttons indicate an action, where as text or a link indicate a location. Clicking a button makes sense for editing, Starring, or getting on npm - whereas taking the user to a different page would be more appropriate with just text

I think we can also combine this with the need to include the title of the collection, like Ecosystem.

Here's my recommendation for both. If "3.6+" links to release notes, it would be blue. If not, it would be grey. I think just "3.6+" is enough in this context without saying something like, "Introduced in CanJS..."

screen shot 2017-10-11 at 3 24 00 pm

@chasenlehara
Copy link
Member Author

I think this is good; for core/infrastructure/ecosystem/legacy, we could link to the collection’s page for people to get more info about what it means.

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

4 participants