Skip to content

[ZEPPELIN-1462] Zeppelin-Web Good Practices #3#1443

Closed
corneadoug wants to merge 2 commits intoapache:gh-pagesfrom
corneadoug:ZEPPELIN-1462
Closed

[ZEPPELIN-1462] Zeppelin-Web Good Practices #3#1443
corneadoug wants to merge 2 commits intoapache:gh-pagesfrom
corneadoug:ZEPPELIN-1462

Conversation

@corneadoug
Copy link
Copy Markdown
Contributor

What is this PR for?

This Good Practice Guide will focus on how to write a controller following the controller as vm concept, and how to provide a nice separation of the code.

What type of PR is it?

Documentation

What is the Jira issue?

https://issues.apache.org/jira/browse/ZEPPELIN-1462

How should this be tested?

Check the .md file, or build the website to see the full rendering

Questions:

  • Does the licenses files need update? No
  • Is there breaking changes for older versions? No
  • Does this needs documentation? No

@corneadoug
Copy link
Copy Markdown
Contributor Author

@AhyoungRyu Since you always find a few mistakes, can you make a quick spell check like always? :)

<br/>
Our main rule regarding writing a controller, is to use the `Controller as vm` style.

However we also have a few other style guidelines.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

However,

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prabhjyotsingh You really like that comma :)

</div>
```

#### Using the controller in a a page
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are double a :D

However we also have a few other style guidelines.

You can see below a full example of what the controller would look like.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need additional new lines? How about putting those three lines in one line? I mean

Our main rule regarding writing a controller, is to use the `Controller as vm` style.
However we also have a few other style guidelines. You can see below a full example of what the controller would look like.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have prefered those lines to be one under another without any additional spacing, but If I don't have that new line, the You can goes straight on the right side of the previous sentence

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eventually I could group the first two sentences:

Our main rule regarding writing a controller, is to use the `Controller as vm` style, however, we also have a few other style guidelines.

@corneadoug
Copy link
Copy Markdown
Contributor Author

Changes done.
Merging if there is no other discussions

@asfgit asfgit closed this in fd772df Sep 22, 2016
@corneadoug corneadoug deleted the ZEPPELIN-1462 branch September 22, 2016 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants