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

Posted to reviews@zeppelin.apache.org by "tbonelee (via GitHub)" <gi...@apache.org> on 2025/05/17 17:30:53 UTC

[PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

tbonelee opened a new pull request, #4931:
URL: https://github.com/apache/zeppelin/pull/4931

### What is this PR for?
Due to stricter Content Security Policy (CSP) settings enforced by Apache, the Zeppelin website fails to load some externally hosted resources such as CSS and jQuery scripts. As a result, fonts are broken and some interactive components no longer function properly.

This PR removes external resource dependencies from the documentation site templates to ensure all necessary assets are bundled and served locally. These changes will be applied to future documentation pages generated during version releases.

### What type of PR is it?
Bug Fix
Documentation

### What is the Jira issue?
* Open an issue on Jira https://issues.apache.org/jira/browse/ZEPPELIN/
* Put link here, and add [ZEPPELIN-*Jira number*] in PR title, eg. [ZEPPELIN-533]

### How should this be tested?
- Ensure all necessary assets are available locally in the documentation build
- Validate styling and interactivity work without external dependencies

### 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

--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2909806951

   > What do you think of this setup?
   
   As this is external content, I would include the version number either in the file or in the folder.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "tbonelee (via GitHub)" <gi...@apache.org>.

tbonelee commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2909844055

   Got it. Just to confirm, would you prefer if I:
   - revert the `jquery.min.js` file name to the previous versioned name,
   - rename the `font-awesome` directory to `font-awesome-4.2.0`,
   - and add version numbers in the AnchorJS and Lunr.js filenames as well, since they are also external content?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer merged PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "tbonelee (via GitHub)" <gi...@apache.org>.

tbonelee commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2907838484

   I couldn' find a reliable way to include external CDN assets automatically with Jekyll. Since the documentation source code doesn't change often, I thought it would be fine to include the asset files directly in the repository.
   
   But I'm open to suggestions, do you have any ideas how we could handle this better?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2930406728

   @jongyoul Merged into master and branch-0.12.
   @tbonelee Thanks for your contribution.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2909486178

   I have not found a way with jekyll either. I think we can continue with a copy.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2909885832

   That's how I would do it. This could make updates easier, as it makes it clear which version is currently in use. But I am not a frontend developer.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "tbonelee (via GitHub)" <gi...@apache.org>.

tbonelee commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2910033799

   That makes sense. I've pushed the changes based on your suggestions.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2909498197

   What do you think of the version in the folder or file name? You have realized it for jQuery, but not for the other files.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "jongyoul (via GitHub)" <gi...@apache.org>.

jongyoul commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2911324175

   @Reamer If we cherry-pick this into branch-0.12, we can publish a new homepage. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "tbonelee (via GitHub)" <gi...@apache.org>.

tbonelee commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2909651167

   The version in the jQuery file name wasn't intentional. I just used the original path.
   
   I've now regrouped the files:
   - font files are together,
   - Font-Awesome-related files are in their own folder,
   - and the jQuery file is placed with the other JS files.
   
   I also removed the version from the jQuery file name to match the naming style of the other JS files. The version info is still available in the license header, though.
   
   What do you think of this setup?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [ZEPPELIN-6191] Remove loading external resources in Zeppelin documentations [zeppelin]

Posted by "Reamer (via GitHub)" <gi...@apache.org>.

Reamer commented on PR #4931:
URL: https://github.com/apache/zeppelin/pull/4931#issuecomment-2900969723

   Wouldn't it be better to download the files from the original sources when building?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@zeppelin.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org