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

[Docs] Update the Roadmap #4205

Closed
roughsoft opened this issue May 8, 2016 · 6 comments · Fixed by #4829
Closed

[Docs] Update the Roadmap #4205

roughsoft opened this issue May 8, 2016 · 6 comments · Fixed by #4829
Assignees
Labels
docs Improvements or additions to the documentation

Comments

@roughsoft
Copy link

roughsoft commented May 8, 2016

Problem description

Roadmap is out of date.

Steps to reproduce

https://github.com/callemall/material-ui/blob/master/ROADMAP.md

Versions

  • Material-UI: 0.15.2
  • React: N/A
  • Browser: N/A
@nathanmarks
Copy link
Member

We're aware, thanks for the reminder 👍

@mbrookes
Copy link
Member

mbrookes commented May 8, 2016

Lets try doing it here. Contributors can edit this, than we can update the .md file when we're done.

For starters, lets strike through what's done. We can remove it later.:

Roadmap

The roadmap is a living document, and it is likely that priorities will change, but the list below should give some indication of our plans for the next major release, and for the future.

0.15.0

Breaking Changes

  • Remove deprecated usage of JSON to generate children across the components.
  • [#3108] Remove deprecated components, methods & props.
  • [#2957] Standardize callback signatures.
  • [#2980] [#1839] Standardise Datepicker for ISO 8601.

Deprecations

  • [#2880] Deprecate valueLink. [Started]
  • [#1793][#2679] PascalCase component names and reorganise directory structure. Deprecate old names.
  • [#2697] Rename LeftNav and deprecate old name.

Core

  • [#2903] Enforce eslint rules. [Not every desired rule was implemented, but we have a pretty solid set now]
  • [#2493] Use higher order components across the library to abstract themes passed down from context. [The utility was implemented, but isn't in use.]
  • [#2627] Improve overall theme handling.
  • [#2573] Remove the usage of isMounted().
  • [#2437] Remove mixins.

Major features

  • [#1321] Composable AppBar component.
  • [#3132] New Stepper component.
  • [#2861] Scrollable Tabs.
  • [#2979] New Subheader component.

Documentation

  • [#1986]Documentation versioning.
  • Add example on how to use react-list for lists, menu items and table.
  • [#2635] Document the new theme calculation, and it's usage.
  • [#3191] Improve component property documentation. [Getting there...]

Future

Deprecations

  • Deprecate & eventually remove all imperative methods.

Core

  • Make extensive use of popover and render-to-layer.
  • [#458] Migrate components to ES6 Classes.
  • [#2784] Stateless components.
  • Improve performance with shouldComponentUpdate and removed inefficient computations.
  • Standardize API naming and available prop convention across the library.
  • Better accessibility support.
  • Better keyboard navigation support.

Features

  • [#2416] TextField as a composable component for various field types.
  • Responsive components to better support MD spec for mobile component sizes, and in preparation for react-native support.
  • [#2863] Add missing components, and missing features from current ones.
  • [#2251] Full featured Table.
  • Full Featured Tabs (close, disable, move, sizing, scrolling).
  • Full support for react-native
  • [#1673] I18n for the doc-site.

@mbrookes mbrookes changed the title the roadmap should be updated, [Docs] Update the Roadmap May 8, 2016
@mpontikes
Copy link

Hey @mbrookes and @nathanmarks,
We put together a first draft of some possible issues to include on the revision of the ROADMAP.md file. Could you please review it and let us know what you all think about how important these issues are? Thanks!

https://github.com/mpontikes/mpontikes.github.io/wiki/Material-UI-Roadmap-Issues

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 19, 2016

@mpontikes Hey, thanks for raising this topic. We are definitely going to need some organization regarding the upcoming releases.
@nathanmarks is, almost on his own at this moment, rewriting the lib from the ground up. He is addressing long-standing issues linked to various design decisions made. We need a smooth upgrade plan.

  • When do we merge it back to master?
  • What intermediary version do we release?

Here is what I'm proposing:

  1. We take care of all the opened PR.
  2. We release the fixes under the v0.15.x tag.
  3. We merge the next branch into master. Can't old and new components coexist?
  4. (optional) We provide a migration API that is as backward compatible as possible with deprecation warnings.
  5. We start doing alpha releases.

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation Core labels Jul 19, 2016
@mpontikes
Copy link

@oliviertassinari Should I write up an .md file with your 5 point proposal and a summary of what's being planned for the release and submit it as a PR? I feel that the roadmap needs an update of some kind.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 19, 2016

@mpontikes I think that we should wait for other points of view to decide on the how.

I see two use cases for a Roadmap.

  1. Set some goals that maintainers and contributor want to achieve.
  2. Give transparency, let the community know what's going on.

So, regarding the what, yes, I think that we can put down some stuff as we have already agreed to it.
I'm gonna open a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants