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.

Sign up for GitHub

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

Jump to bottom

[ZEPPELIN-1346] Add contribution guidelines to the website #1356

Closed
wants to merge 23 commits into from
Closed

[ZEPPELIN-1346] Add contribution guidelines to the website #1356

wants to merge 23 commits into from

Conversation

corneadoug
Copy link
Contributor

@corneadoug corneadoug commented Aug 24, 2016 •
edited
Loading

What is this PR for?

Recreation of #1354
This PR is bringing Contribution guidelines to the website.
We also introduce a sidemenu on those pages allowing to create additional content.
As an example, for the Web Application Guidelines, we added a page about "Defining Components"

In a different PR, we will remove the contributing markdown, and change the links in the repository to the website.

The layout of the doc was slightly modified to allow a larger documentation at max size.
It was also modified to accommodate better on smaller screens.

What type of PR is it?

Documentation

What is the Jira issue?

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

How should this be tested?

Build the website locally and visit the community page

Screenshots (if appropriate)

screen shot 2016-08-23 at 3 50 41 pm

screen shot 2016-08-31 at 10 33 36 am

#### Layout update (Before / After)

Navbar Bug fix

screen shot 2016-08-31 at 10 35 14 am

screen shot 2016-08-31 at 10 31 18 am

Small Device Margin Improvement

screen shot 2016-08-31 at 10 35 34 am

screen shot 2016-08-31 at 10 31 28 am

Content Width Change

screen shot 2016-08-31 at 10 33 50 am

screen shot 2016-08-31 at 10 32 12 am

### Questions: - Does the licenses files need update? No - Is there breaking changes for older versions? No - Does this needs documentation? No

@corneadoug
Copy link
Contributor Author

@AhyoungRyu Sorry you will have to re-do your PR here :(

@AhyoungRyu
Copy link
Contributor

@corneadoug Don't worry about that. Let me repush again :)

@AhyoungRyu AhyoungRyu mentioned this pull request Aug 24, 2016
Merged
@corneadoug
Copy link
Contributor Author

Alright LGTM

@AhyoungRyu
Copy link
Contributor

good to go now 👯

@Leemoonsoo
Copy link
Member

I've tested and it looks nice.

Some small feedback about sidemenu

  • When sidemenu is displayed, content area become little bit too narrow.
  • Items in Sidemenu is in consistent. i.e.

page /contribution/general.html, sidemenu

  • Documentation (/contribution/documentation.html)
  • Webapplication (/contribution/webapplication.html)

page /contribution/webapplication.html

  • Defining Components (/contribution/zeppelinweb/goodPracticeGuide01.html)

page /contribution/zeppelinweb/goodPracticeGuide01.html

  • Defining Components (/contribution/zeppelinweb/goodPracticeGuide01.html)

I think it'll better it sidemenu decide only one behavior either doesn't include current page, (like general.html,webapplication.html) or does include current page (like goodPracticeGuide01.html)

felixcheung
felixcheung reviewed Aug 25, 2016
View reviewed changes
contribution/documentation.md


### Markdown
Zeppelin documentation pages are written with [Markdown](http://daringfireball.net/projects/markdown/). It is possible to use [GitHub flavored syntax](https://help.github.com/categories/writing-on-github/) and intermix plain HTML.
Copy link
Member

Choose a reason for hiding this comment

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

probably need to say Apache Zeppelin

@corneadoug
Copy link
Contributor Author

@Leemoonsoo
We can reduce the font and width of the menu, but we can't do much more than that since the width of the documentation is fixed.

The sidemenu is inconsistent indeed, mainly because other categories might need more content.
One possible change would be to have:

  • Contribution (general.html)
  • Documentation (documentation.html)
  • Webapplication (webapplication.html)

Showing as side menu for general.html, documentation.html

And to have:

  • Zeppelin-web (webapplication.html)
  • Defining Components (goodPracticeGuide01.html)

Showing as side menu for webapplication.html and goodPracticeGuide01.html

@corneadoug
Copy link
Contributor Author

@felixcheung I don't think that adding Apache in front of every Zeppelin is necessary.
Especially since this is documentation for the project itself. It is fine to use the shorten name without Apache, and you can actually see that projects are doing it (Apache Mesos, Spark, Flink for example), and we've also been doing it.

@Leemoonsoo
Copy link
Member

@corneadoug Because of width of the documentation is already fixed, I'm not sure it's best idea to reduce contents width even more.
Could you elaborate some possible alternatives to effectively display links of related pages in consistent way while maximizing actual content width?

@AhyoungRyu
Copy link
Contributor

@felixcheung I agree with @corneadoug. If this document page need to be posted to the external resources, then we may need to attach Apache in front of every Zeppelin. But we don't need to say Apache Zeppelin every time in internal project page I guess :)

@corneadoug
Copy link
Contributor Author

@Leemoonsoo Let me try playing a bit more with the layout, I will post screenshots once its done

@corneadoug
Copy link
Contributor Author

@Leemoonsoo I made both general.html and webapplication.html appear on the sideMenu.

For the size issue, I think the best would be to simply have the documentation max-width bigger (1024px instead of ~960px), I didn't push the CSS yet but the screenshot below have it.

If you Compare with the screenshots of the PR description, it gives more space to the content

screen shot 2016-08-30 at 1 24 25 pm

screen shot 2016-08-30 at 1 24 35 pm

@corneadoug
Copy link
Contributor Author

I pushed the last CSS changes, and Updated the description's screenshots

@corneadoug
Copy link
Contributor Author

@Leemoonsoo Merging if there is no more feedbacks

@asfgit asfgit closed this in 9647ba4 Sep 6, 2016
This was referenced Sep 6, 2016
Closed
Closed
asfgit pushed a commit that referenced this pull request Sep 7, 2016
@corneadoug
Update Zeppelin Website building instructions
e53101f 
### What is this PR for?
Usually in order to push jekyll code to github pages, it will compile using the `--safe`
One drawback is that you cannot use any plugins.

After working on PR #1356 and introduction a plugin, using the build line with `--safe` specified in the README is failing.

However in our case, we are not forced to use that flag, since we are sending the compiled website directly to the Apache SVN, and I was able to confirm that fact when I sent the updated website to the SVN and it was rendered correctly

Also since plugins like Google Analytics needs to be activated only in production we are adding a special production environment option to add `JEKYLL_ENV=production`

### What type of PR is it?
Documentation

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Damien CORNEAU <corneadoug@gmail.com>

Closes #1405 from corneadoug/update/buildCommandLine and squashes the following commits:

a5652b1 [Damien CORNEAU] Change also in the website contribution guide
08b46e5 [Damien CORNEAU] Update to handle the production flag
acd0b04 [Damien CORNEAU] Remove --safe from building instruction
asfgit pushed a commit that referenced this pull request Sep 8, 2016
@corneadoug
[ZEPPELIN-1414] Remove CONTRIBUTING.md files
56bbff3 
### What is this PR for?
Following the PR #1356, we now have the contribution documentation to on Apache Zeppelin Website.

We can now remove the contributing files from the repository, and replace the links to that documentation.

### What type of PR is it?
Documentation

### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-1414

### How should this be tested?
Just check if there is other CONTRIBUTING.md files and if there is other links to replace

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Damien CORNEAU <corneadoug@gmail.com>

Closes #1406 from corneadoug/ZEPPELIN-1414 and squashes the following commits:

4347043 [Damien CORNEAU] change a how to contribute link to the webiste in the docs
faf3e11 [Damien CORNEAU] Make links to contribution material point to the website
cb4b5f7 [Damien CORNEAU] Remove contributing files from RAT
7810f57 [Damien CORNEAU] Remove contributing files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@corneadoug @AhyoungRyu @Leemoonsoo @felixcheung