You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@zeppelin.apache.org by AhyoungRyu <gi...@git.apache.org> on 2016/09/09 08:22:23 UTC

[GitHub] zeppelin pull request #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

GitHub user AhyoungRyu opened a pull request:

    https://github.com/apache/zeppelin/pull/1420

    [ZEPPELIN-1421] Fix dead link in docs/README.md

    ### What is this PR for?
    There is a dead link in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md). 
    
    It should be `https://zeppelin.apache.org/docs/latest/` not `https://zeppelin.apache.org/docs/latest`
    
    ### What type of PR is it?
    Bug Fix
    
    ### What is the Jira issue?
    [ZEPPELIN-1421](https://issues.apache.org/jira/browse/ZEPPELIN-1421)
    
    ### How should this be tested?
     - Before [https://zeppelin.apache.org/docs/latest](https://zeppelin.apache.org/docs/latest)
     - After [https://zeppelin.apache.org/docs/latest/](https://zeppelin.apache.org/docs/latest/)
    
    ### 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/AhyoungRyu/zeppelin ZEPPELIN-1421

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/zeppelin/pull/1420.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 #1420
    
----
commit 311e2eff0831f1174cf99e99dbfb05f7f6d86e1a
Author: AhyoungRyu <fb...@hanmail.net>
Date:   2016-09-09T08:10:38Z

    Fix dead link in docs/README.md

----


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by AhyoungRyu <gi...@git.apache.org>.

Github user AhyoungRyu commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    @kavinkumarks Ah right. Although they are just source for the real documentation website, someone might be confused like you. So I checked all docs pages under `/docs`, some link and image path contains `{{BASE_PATH}}`. I removed them and changed to the actual path. Could you check 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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by kavinkumarks <gi...@git.apache.org>.

Github user kavinkumarks commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    LGTM with the dead link in README.md
    
    Also, shouldn't we need to fix the broken image in shell interpreter 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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by AhyoungRyu <gi...@git.apache.org>.

Github user AhyoungRyu commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    @kavinkumarks 
    The shell interpreter docs in github is just a source not a real docs page. The real one is deployed at [https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/interpreter/shell.html](https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/interpreter/shell.html). 
    
    The below tag is for the broken image.
    ```
    <img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/shell-example.png" />
    ```
    Since it contains `{{BASE_PATH}}`, github can't recognize this variable. That's the reason why the image is broken. Zeppelin is using [Jekyll](https://jekyllrb.com/) to build the documentation site. (See [here](https://zeppelin.apache.org/contribution/documentation.html) for more details). Only Jekyll can recognize the variable. 
    Just FYI, that kind of variables(e.g. `BASE_PATH`, `ASSET_PATH`) are defined in [docs/_config.yml](https://github.com/apache/zeppelin/blob/master/docs/_config.yml) :)


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by kavinkumarks <gi...@git.apache.org>.

Github user kavinkumarks commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    @AhyoungRyu the changes look good!
    
    Thanks,
    Kavin
    MailTo: kavin.kumar@imaginea.com


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by corneadoug <gi...@git.apache.org>.

Github user corneadoug commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    Tested, Merging 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.
---

[GitHub] zeppelin pull request #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by asfgit <gi...@git.apache.org>.

Github user asfgit closed the pull request at:

    https://github.com/apache/zeppelin/pull/1420


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by zjffdu <gi...@git.apache.org>.

Github user zjffdu commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    Thanks @AhyoungRyu 


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by AhyoungRyu <gi...@git.apache.org>.

Github user AhyoungRyu commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    @zjffdu Just FYI
    >I found the docs of 0.7.0-SNAPSHOT is broken, is it a known issue ?
    
    This issue was resolved today. `docs/0.7.0-SNAPSHOT` site works well like before :)
    @kavinkumarks Thanks!
    
    Merging to master if there is no further discussion


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by kavinkumarks <gi...@git.apache.org>.

Github user kavinkumarks commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    @AhyoungRyu thanks for the information but we can use the path https://github.com/apache/zeppelin/blob/master/docs/assets/themes/zeppelin/img/docs-img/shell-example.png to access the image as used in other interpreters.There is no need to use BASE_PATH variable.What do you say?
    
    Thanks,
    Kavin
    MailTo: kavin.kumar@imaginea.com


---
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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by AhyoungRyu <gi...@git.apache.org>.

Github user AhyoungRyu commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    @zjffdu Ah it's wired. In `0.7.0-SNAPSHOT`, all the link in the dropdown menu are broken. It should be [https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/install/install.html](https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/install/install.html) not [https://zeppelin.apache.org/install/install.html](https://zeppelin.apache.org/install/install.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 #1420: [ZEPPELIN-1421] Fix dead link in docs/README.md

Posted by zjffdu <gi...@git.apache.org>.

Github user zjffdu commented on the issue:

    https://github.com/apache/zeppelin/pull/1420
  
    LGTM. BTW, I found the docs of 0.7.0-SNAPSHOT is broken, is it a known issue ?
    e.g. 
    https://zeppelin.apache.org/install/install.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.
---