You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by ah...@apache.org on 2017/03/05 07:30:29 UTC
zeppelin git commit: [gh-pages] update
contribution/webapplication.html
Repository: zeppelin
Updated Branches:
refs/heads/gh-pages 9d0cf79e8 -> e8b8a9620
[gh-pages] update contribution/webapplication.html
### What is this PR for?
This PR is for matching current web environment.
I changed `dev mode` part from `./grunt serve` to `yarn run dev` and fixed some typo.
### What type of PR is it?
[ Documentation]
### What is the Jira issue?
* None
### How should this be tested?
* build `gh-pages` branch and then check [webapplication.html](http://localhost:4000/contribution/webapplication.html) page.
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? Yes
Author: soralee <so...@zepl.com>
Closes #2000 from soralee/gh_contribute_web_dev and squashes the following commits:
3a8cb90 [soralee] modify typo and update inject part
e0c08cd [soralee] update contribute/webapplication.html
Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/e8b8a962
Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/e8b8a962
Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/e8b8a962
Branch: refs/heads/gh-pages
Commit: e8b8a962041aa6e7767d536a2ce26b9fa3f4ad87
Parents: 9d0cf79
Author: soralee <so...@zepl.com>
Authored: Fri Feb 10 11:41:03 2017 +0900
Committer: ahyoungryu <ah...@apache.org>
Committed: Sun Mar 5 16:30:22 2017 +0900
----------------------------------------------------------------------
contribution/webapplication.md | 12 +++++++-----
contribution/zeppelinweb/goodPracticeGuide01.md | 3 +--
contribution/zeppelinweb/goodPracticeGuide04.md | 2 +-
3 files changed, 9 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/e8b8a962/contribution/webapplication.md
----------------------------------------------------------------------
diff --git a/contribution/webapplication.md b/contribution/webapplication.md
index 8010e10..a02d751 100644
--- a/contribution/webapplication.md
+++ b/contribution/webapplication.md
@@ -26,7 +26,7 @@ limitations under the License.
## Dev Mode
When working on Zeppelin's WebApplication, it is recommended to run in dev mode.
-For that, start Zeppelin server normally, then use ``./grunt serve`` in _zeppelin-web_ directory.
+For that, start Zeppelin server normally, then use ``yarn run dev`` in _zeppelin-web_ directory.
This will launch a Zeppelin WebApplication on port **9000** that will update on code changes.
@@ -63,7 +63,7 @@ If you still need to use it, then please use ``angular.element()`` instead of ``
## Folder Structure & Code Organization
* `src` folder: Contains the Source code for Zeppelin WebApplication
-* `dist` folder: Contains the compiled code after using **grunt build**
+* `dist` folder: Contains the compiled code after using **yarn run build**
### Src and Code Organization
@@ -80,7 +80,8 @@ The `src` folder is organized as such:
| | | \u251c\u2500\u2500 subComponent1.css
\u2502 | | \u2514\u2500\u2500 subComponent1.controller.js
\u2502 \u2502 \u2514\u2500\u2500 name.css
- \u2502 \u2514\u2500\u2500 app.js
+ \u2502 \u251c\u2500\u2500 app.js
+ \u2502 \u2514\u2500\u2500 app.controller.js
\u251c\u2500\u2500 assets/
\u2502 \u251c\u2500\u2500 images/
\u2502 \u2514\u2500\u2500 styles/
@@ -94,8 +95,9 @@ The `src` folder is organized as such:
\u251c\u2500\u2500 fonts/
| \u251c\u2500\u2500 *.{eot,svg,ttf,woff,otf}
\u2502 \u2514\u2500\u2500 *.css
- \u251c\u2500\u2500 favico.ico
+ \u251c\u2500\u2500 favicon.ico
\u251c\u2500\u2500 index.html
+ \u251c\u2500\u2500 index.js
\u2514\u2500\u2500 404.html
</pre>
@@ -127,7 +129,7 @@ Contains the application `app.js` and page related components.
* Notebook Page
etc...
-The only resctiction being that a component in the `app` folder is **not used anywhere else**
+The only restriction being that a component in the `app` folder is **not used anywhere else**
#### Components folder
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/e8b8a962/contribution/zeppelinweb/goodPracticeGuide01.md
----------------------------------------------------------------------
diff --git a/contribution/zeppelinweb/goodPracticeGuide01.md b/contribution/zeppelinweb/goodPracticeGuide01.md
index d486208..c37fd5d 100644
--- a/contribution/zeppelinweb/goodPracticeGuide01.md
+++ b/contribution/zeppelinweb/goodPracticeGuide01.md
@@ -30,9 +30,8 @@ We should have only one Angular Component per file, and it should look like this
angular.module('zeppelinWebApp').controller('HomeCtrl', HomeCtrl);
- HomeCtrl.$inject = ['$location'];
-
function HomeCtrl($location) {
+ 'ngInject';
...
}
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/e8b8a962/contribution/zeppelinweb/goodPracticeGuide04.md
----------------------------------------------------------------------
diff --git a/contribution/zeppelinweb/goodPracticeGuide04.md b/contribution/zeppelinweb/goodPracticeGuide04.md
index ec5286e..c4d2ad7 100644
--- a/contribution/zeppelinweb/goodPracticeGuide04.md
+++ b/contribution/zeppelinweb/goodPracticeGuide04.md
@@ -29,7 +29,7 @@ It allows some performance improvements compared to the usual `{{ "{{ " }}}}` sy
Your code would then look like:
```
-<div ng-bing='home.myValue'></div>
+<div ng-bind='home.myValue'></div>
```
Instead of: