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

UI development docs Backbone/Coffeescript => es6/React/Redux (WIP) #1232

Merged
merged 10 commits into from Aug 23, 2016

Conversation

Projects
None yet
3 participants
@Calvinp
Contributor

Calvinp commented Aug 19, 2016

Rewrites the UI development docs to properly mention that React and es6 are being used instead of Backbone and Coffeescript.

This is a first draft. I'm sure there are things I could do better, so please review and rip into this.

cc @tpetr @ssalinas @wolfd

Calvinp added some commits Aug 19, 2016

Show outdated Hide outdated Docs/development/ui.md
@@ -20,14 +20,15 @@ The compiled static files are placed in `../SingularityService/target/generated-
SingularityUI is a single page webapp that relies on SingularityService for its data.
The app is built using Gulp (i.e. compiling CoffeeScript, etc), with npm being used to manage its dependencies (e.g. jQuery, Backbone).
The app is built using Gulp (i.e. compiling es6, etc), with npm being used to manage its dependencies (e.g. React, Bootstrap).

This comment has been minimized.

@tpetr

tpetr Aug 19, 2016

Member

capitalize ES6

@tpetr

tpetr Aug 19, 2016

Member

capitalize ES6

Show outdated Hide outdated Docs/development/ui.md
@@ -141,42 +142,39 @@ localStorage.setItem('suppressRefresh', true)
## Code structure
As mentioned before, SingularityUI uses [Backbone](http://backbonejs.org/). If you're not familiar with how it does things, please look into it and familiarise yourself with Views, Models, Collections, and the event-based interaction between them all.
As mentioned before, SingularityUI uses [React](https://facebook.github.io/react/) and [Redux](http://redux.js.org/docs/introduction/). If you're not familiar with how it does things, please look into it and familiarise yourself with React's lifecycle and the Redux store and dispatch.

This comment has been minimized.

@tpetr

tpetr Aug 19, 2016

Member

nit: can we America-ify these words? (i.e. familiarise --> familiarize)

@tpetr

tpetr Aug 19, 2016

Member

nit: can we America-ify these words? (i.e. familiarise --> familiarize)

Calvinp added some commits Aug 19, 2016

@tpetr

This comment has been minimized.

Show comment
Hide comment
@tpetr

tpetr Aug 22, 2016

Member

LGTM

Member

tpetr commented Aug 22, 2016

LGTM

@tpetr tpetr merged commit bd37625 into master Aug 23, 2016

1 of 2 checks passed

continuous-integration/travis-ci/push The Travis CI build could not complete due to an error
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ssalinas ssalinas modified the milestone: 0.10.1 Aug 24, 2016

@ssalinas ssalinas deleted the convert_ui_development_docs_to_react branch Nov 1, 2016

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