You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zeppelin.apache.org by yoonjs2 <gi...@git.apache.org> on 2016/11/01 17:49:53 UTC
[GitHub] zeppelin pull request #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 ...
GitHub user yoonjs2 opened a pull request:
https://github.com/apache/zeppelin/pull/1577
[ZEPPELIN-1554] Update jekyll version to 3.2.1 with its dependencies and fix document\u2026
### What is this PR for?
- Update outdated jekyll version of zeppelin documentation from 1.x to 3.x
- Eliminate kramdown only warnings when serving documentation as github pages.
- Prepare base environment for L10N related plugins for jekyll.
### What type of PR is it?
Improvement | Documentation
### Todos
* [*] - Update Jekyll version to 3.x
* [*] - Update documentation style as kramdown
* [ ] - Prepare L10N support on documentation
### What is the Jira issue?
ZEPPELIN-1554
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? Yes for documentation
* Does this needs documentation? No
\u2026 style as kramdown.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/yoonjs2/zeppelin ZEPPELIN-1554
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zeppelin/pull/1577.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 #1577
----
commit 81bc244a25f274a1ba3910ae0e36ef6370db125a
Author: Jesang Yoon <yo...@kanizsalab.com>
Date: 2016-10-09T15:30:15Z
Update jekyll version to 3.2.1 with its dependencies and fix document style as kramdown.
----
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by 1ambda <gi...@git.apache.org>.
Github user 1ambda commented on the issue:
https://github.com/apache/zeppelin/pull/1577
Any updated?
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@yoonjs2 Seems "Prepare L10N support on documentation" is unchecked in the PR description. Is it done now?
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by minahlee <gi...@git.apache.org>.
Github user minahlee commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@yoonjs2 just added your name to contributor role
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@yoonjs2 Sure. And let me test this patch :)
@minahlee Could you help me add @yoonjs2 (Jira username:Jesang Yoon) to the contributor list in Jira so that he can assign himself to assignee?
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@yoonjs2 yes i think it would be better to handle " L10N support" in other PR since it's a bit different work with this PR. What do you think?
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by yoonjs2 <gi...@git.apache.org>.
Github user yoonjs2 commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@AhyoungRyu no, its under progress now. Should I change unchecked todo to other PR?
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by yoonjs2 <gi...@git.apache.org>.
Github user yoonjs2 commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@AhyoungRyu OK I'll investigate and resolve them ASAP. Thanks for the review :)
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by yoonjs2 <gi...@git.apache.org>.
Github user yoonjs2 commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@AhyoungRyu Fair enough, I'd just removed a todo (L10N support) and It will be proposed different PR.
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by yoonjs2 <gi...@git.apache.org>.
Github user yoonjs2 commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@AhyoungRyu Can I ask you to allow me to change JIRA ZEPPELIN-1554 assignee and progress? In case of self proposal and PR like this, It would be great to use JIRA as contributor access :)
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/zeppelin/pull/1577
---
[GitHub] zeppelin issue #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by yoonjs2 <gi...@git.apache.org>.
Github user yoonjs2 commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@AhyoungRyu @minahlee Thanks! Let me know if patch needs any change :)
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by yoonjs2 <gi...@git.apache.org>.
Github user yoonjs2 commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@AhyoungRyu I've stucked with the first step you've mentioned...
How do I workaround this error?
1) build gh-pages (website) branch
```
$ git checkout gh-pages
$ JEKYLL_ENV=production
$ bundle exec jekyll build
Configuration file: /Users/yoonjesang/Desktop/openfrontier/zeppelin/_config.yml
Source: /Users/yoonjesang/Desktop/openfrontier/zeppelin
Destination: /Users/yoonjesang/Desktop/openfrontier/zeppelin/_site
Incremental build: disabled. Enable with --incremental
Generating...
Liquid Exception: Could not locate the included file 'nav/announcements-4.0.html' in any of ["/Users/yoonjesang/Desktop/openfrontier/zeppelin/_includes"]. Ensure it exists in one of those directories and, if it is a symlink, does not point outside your site source. in zeppelin-web/bower_components/select2/docs/announcements-4.0.html
jekyll 3.2.1 | Error: Could not locate the included file 'nav/announcements-4.0.html' in any of ["/Users/yoonjesang/Desktop/openfrontier/zeppelin/_includes"]. Ensure it exists in one of those directories and, if it is a symlink, does not point outside your site source.
```
And I found few lines of your instruction seems mistyped... Am I correct?
```
mkdir -p /tmp/zeppelin-website/docs/0.7.0-SNAPSHOT => mkdir -p /tmp/zeppelin_website/docs/0.7.0-SNAPSHOT
cp -r _site/ /tmp/zeppelin_website/0.7.0-SNAPSHOT/ => cp -r _site/ /tmp/zeppelin_website/docs/0.7.0-SNAPSHOT/
```
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@yoonjs2 Yeah you're right, there is a typo. It should be one of them either `zeppelin-website` or `zeppelin_website`. I updated the comment :)
And you did like below as you said
```
$ JEKYLL_ENV=production
$ bundle exec jekyll build
```
But it should be in one line
```
$ JEKYLL_ENV=production bundle exec jekyll build
```
---
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 #1577: [ZEPPELIN-1554] Update jekyll version to 3.2.1 with it...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1577
@yoonjs2 I've tested this branch and found some issues.
**1.**
```
Liquid Warning: Liquid syntax error (line 77): Expected end_of_string but found open_round in "{{noteName(note)}}" in manual/notebookashomepage.md
```
seems it needs some markdown escaping. The line number 83 in `docs/manual/notebookashomepage.md`
```
<a style="text-decoration: none;" href="#/notebook/{{note.id}}">{{noteName(note)}}</a>
```
it can be fixed simply like below
```
<a style="text-decoration: none;" href="#/notebook/{{"{{note.id"}}}}>{{"{{noteName(note)"}}}}</a>
```
then the error message will be gone :)
**2.** As you know, the docs site will be deployed under `zeppelin.apache.org/docs/0.7.0-SNAPSHOT/` not `zeppelin.apache.org`. So I tested in similar env like below
```
1) build gh-pages (website) branch
JEKYLL_ENV=production bundle exec jekyll build
cp -r _site/ /tmp/zeppelin_website/
mkdir -p /tmp/zeppelin-website/docs/0.7.0-SNAPSHOT
2) build this patch (docs) and copy it under docs/0.7.0-SNAPSHOT of website
cd docs
bundle exec jekyll build --safe
cp -r _site/ /tmp/zeppelin_website/0.7.0-SNAPSHOT/
3) start httpserver and browse http://localhost:8000/docs/0.7.0-SNAPSHOT/
cd /tmp/zeppelin_website
python -m SimpleHTTPServer
```
then it throws
<img width="646" alt="screen shot 2016-11-04 at 11 57 34 pm" src="https://cloud.githubusercontent.com/assets/10060731/20010178/80dcf8fc-a2ea-11e6-89d6-43558bcdac3c.png">
and not happened in master. And also some styles are not missing now.
Could you check them again? And please feel free to ping me if you're in trouble while testing.
---
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.
---