Skip to content

Conversation

@AhyoungRyu
Copy link
Contributor

What is this PR for?

There is a dead link in 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

How should this be tested?

Screenshots (if appropriate)

Questions:

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

@zjffdu
Copy link
Contributor

zjffdu commented Sep 9, 2016

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

@AhyoungRyu
Copy link
Contributor Author

@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 not https://zeppelin.apache.org/install/install.html.

@kavinkumarks
Copy link
Contributor

kavinkumarks commented Sep 9, 2016

@AhyoungRyu LGTM with the dead link in README.md

Also, shouldn't we need to fix the broken image in shell interpreter doc?

@AhyoungRyu
Copy link
Contributor Author

@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.

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 to build the documentation site. (See here 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 :)

@kavinkumarks
Copy link
Contributor

@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: [email protected]

@AhyoungRyu
Copy link
Contributor Author

AhyoungRyu commented Sep 10, 2016

@kavinkumarks Ah right. Although all docs/*.md are just source for the real documentation website, someone might be confused like you. After checking all docs pages under /docs, I found some link and image path contains {{BASE_PATH}}. So I removed them and changed to the actual path. Could you please check this again? :)

@kavinkumarks
Copy link
Contributor

@AhyoungRyu the changes look good!

Thanks,
Kavin
MailTo: [email protected]

@AhyoungRyu
Copy link
Contributor Author

@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

@zjffdu
Copy link
Contributor

zjffdu commented Sep 12, 2016

Thanks @AhyoungRyu

@corneadoug
Copy link
Contributor

Tested, Merging it

@asfgit asfgit closed this in 8f344db Sep 19, 2016
pedrozatta pushed a commit to pedrozatta/zeppelin that referenced this pull request Oct 27, 2016
### 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

Author: AhyoungRyu <[email protected]>

Closes apache#1420 from AhyoungRyu/ZEPPELIN-1421 and squashes the following commits:

57336f8 [AhyoungRyu] Remove BASE_PATH in some docs pages
311e2ef [AhyoungRyu] Fix dead link in docs/README.md
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.

4 participants