chore: Remove frames.html from generated doc #251
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation generated from `yard` creates a [frames.html][1] file. This file is susceptible to XSS attacks. Additionally, this page can act as an open redirect (e.g. https://launchdarkly.github.io/ruby-server-sdk/frames.html#!////example.com). To remediate this problem, we are going to simply remove the generate frames.html file. This file was created to [support classical frameset views for the docs][2], which we have no need to support. [1]: https://github.com/lsegal/yard/blob/2d197a381c5d4cc5c55b2c60fff992b31c986361/templates/default/fulldoc/html/frames.erb [2]: lsegal/yard@dc0fcb4
|
This pull request has been linked to Shortcut Story #234563: Remove frames.html as a temporary fix to XSS vulnerability in ruby docs. |
pkaeding
approved these changes
Feb 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation generated from
yardcreates a frames.html file.This file is susceptible to XSS attacks.
Additionally, this page can act as an open redirect (e.g.
https://launchdarkly.github.io/ruby-server-sdk/frames.html#!////example.com).
To remediate this problem, we are going to simply remove the generate
frames.html file. This file was created to support classical frameset
views for the docs, which we have no need to support.