You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zeppelin.apache.org by corneadoug <gi...@git.apache.org> on 2016/08/24 08:39:49 UTC
[GitHub] zeppelin pull request #1356: [ZEPPELIN-1346] Add contribution guidelines to ...
GitHub user corneadoug opened a pull request:
https://github.com/apache/zeppelin/pull/1356
[ZEPPELIN-1346] Add contribution guidelines to the website
### 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.
### 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)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/corneadoug/incubator-zeppelin add/ContributeCategory
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zeppelin/pull/1356.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1356
----
commit 06238fbc9b3a65085db2ea1ad4aa53630b1660f3
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-22T04:47:46Z
Modify the Community page
commit cb8760861b28b78e2ffc58e65bafd1ee154ce30b
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-22T04:51:45Z
Add forgotten license headers
commit acc68b50d71e16752eb598235d5be32ad6fbf5b8
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-22T05:38:19Z
Add contribution Guidelines to the website
commit 5f7e2bd47c2b027c9d63fb4d0ebc6c9e2b8b2e33
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-22T08:13:14Z
Add a side menu template
commit c933c194b3190961e799b8c9a75071718290c6dd
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-22T08:43:34Z
Add zeppelin-web contribution page
commit 306ae06724a870b2da454283afc851f20b65925f
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-22T09:05:32Z
Add zeppelin-web GPG menu
commit 666f3ec95ed4f7d6aed5efefec3b40269d022bf0
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-23T05:31:29Z
Add first Zeppelin-web best practices page
commit 81493abd9ecbf07cf864f5509e96c1bbabdc72ce
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-23T06:45:29Z
Change Side Menu style
commit 94d653b26eeb44538ef5f07f969de912e324478a
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-24T02:49:35Z
Fix typos
commit 8f69f283d031fcdb5f5c90426ad01f88f4879adf
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-24T03:07:31Z
Add GUI integration tests CLI
commit 98826702a321a6c67e2af030fb7d120560a883d8
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-24T03:25:13Z
Allows contribution page without side Menu
commit e0b4c8d30ffe4df95e3cb1cbc1fe3205191f0266
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-24T03:27:26Z
change name of good practice file
commit e34fc64f0b0f84697720b8aff49999ec82a7a83f
Author: Damien CORNEAU <co...@gmail.com>
Date: 2016-08-24T03:41:58Z
fix typo in front-end doc
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@Leemoonsoo Let me try playing a bit more with the layout, I will post screenshots once its done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1356
good to go now \U0001f46f
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@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 :)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@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
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
I pushed the last CSS changes, and Updated the description's screenshots
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@corneadoug Don't worry about that. Let me repush again :)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
Alright LGTM
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@Leemoonsoo Merging if there is no more feedbacks
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@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
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin pull request #1356: [ZEPPELIN-1346] Add contribution guidelines to ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/zeppelin/pull/1356
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by Leemoonsoo <gi...@git.apache.org>.
Github user Leemoonsoo commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@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?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by Leemoonsoo <gi...@git.apache.org>.
Github user Leemoonsoo commented on the issue:
https://github.com/apache/zeppelin/pull/1356
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)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@AhyoungRyu Sorry you will have to re-do your PR here :(
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1356: [ZEPPELIN-1346] Add contribution guidelines to the web...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1356
@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.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---