zeppelin icon indicating copy to clipboard operation
zeppelin copied to clipboard

ZEPPELIN-6200 Update docs URL to /docs/latest

Open gurioh opened this issue 5 months ago • 2 comments

What is this PR for?

The current official documentation link is set as:

http://zeppelin.apache.org/docs/{{zeppelinVersion}}/index.html

However, the current version is 0.12.0-SNAPSHOT, which is still under development and not an official release. As a result, the documentation link for this version is not available.

Since we only need to provide a link to the latest stable release, how about updating the link to:

http://zeppelin.apache.org/docs/latest/index.html

This would ensure users are always directed to the latest available documentation.

What type of PR is it?

Improvement

Todos

  • [o] - Verified that the updated URL

What is the Jira issue?

  • Open an issue on Jira https://issues.apache.org/jira/browse/ZEPPELIN-6200

How should this be tested?

  • Strongly recommended: add automated unit tests for any new or changed behavior
  • Outline any manual steps to test the PR here.

Screenshots (if appropriate)

Questions:

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

gurioh avatar Jul 16 '25 13:07 gurioh

Thanks for the update!

I just wanted to check something. As far as I know, the zeppelinVersion is replaced with the actual version number during the release process, so it ends up pointing to the correct version-specific documentation.

If we change the link to always point to latest documentation page, I'm a bit concerned that users of older Zeppelin versions might get redirected to a newer version' documentation, which could be different from what they're using.

I'm not completely sure, so just raising the point. @jongyoul Curious to hear your thoughts too.

tbonelee avatar Jul 17 '25 13:07 tbonelee

How about a compromise: we keep using {{zeppelinVersion}} for released versions to ensure users get version-specific documentation, but fall back to latest only when the version is a SNAPSHOT?

ParkGyeongTae avatar Jul 21 '25 12:07 ParkGyeongTae