Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a disclaimer to tutorials involving Ruby code #8525

Merged
merged 1 commit into from Jan 1, 2021

Conversation

ashmaroli
Copy link
Member

Summary

Tutorials utilizing just Liquid logic is considered safe since Liquid is inherently non-evaling. However, tutorials with Ruby code to be used as plugins cannot be deemed safe without proper review and test-coverage.
Therefore, place a disclaimer to indirectly state that the user discretion is recommended.

The disclaimer is not rendered by default. Tutorials with Ruby code need to explicitly enable it via the front matter:

plugin_disclaimer: true

@chrisfinazzo
Copy link
Contributor

Summary

Tutorials utilizing just Liquid logic is considered safe since Liquid is inherently non-evaling. However, tutorials with Ruby code to be used as plugins cannot be deemed safe without proper review and test-coverage.
Therefore, place a disclaimer to indirectly state that the user discretion is recommended.

The disclaimer is not rendered by default. Tutorials with Ruby code need to explicitly enable it via the front matter:

plugin_disclaimer: true

While testing this in the context of #8521, I noticed that it wasn't using the CSS I expected. Seems like this should have the regular "note" class applied...

Screen Shot 2020-12-29 at 11 05 37 AM

@ashmaroli
Copy link
Member Author

the regular "note" class applied..

@chrisfinazzo I chose to go with the bronze+chocolate-brown palette so that it is subtle and doesn't pop right out at the visitor (like the sky-blue or red note boxes on other pages) especially since the info within is not directly related to the topic of the page.
Whatsay? Change it anyways?

@chrisfinazzo
Copy link
Contributor

chrisfinazzo commented Dec 29, 2020

the regular "note" class applied..

@chrisfinazzo I chose to go with the bronze+chocolate-brown palette so that it is subtle and doesn't pop right out at the visitor (like the sky-blue or red note boxes on other pages) especially since the info within is not directly related to the topic of the page.
Whatsay? Change it anyways?

Oh, I see.

This is actually the color scheme I was thinking of, just couldn't tell at first glance. Unless I missed it, I don't see the .disclaimer-ribbon class applied elsewhere, so it made more sense to use .note in a form in which it already exists - for example, at the bottom of the Troubleshooting page.

Screen Shot 2020-12-29 at 2 27 46 PM

@ashmaroli
Copy link
Member Author

@jekyllbot: merge +doc

@jekyllbot jekyllbot merged commit 75a895c into jekyll:master Jan 1, 2021
@ashmaroli ashmaroli deleted the tutorial-plugin-disclaimer branch January 1, 2021 16:19
jekyllbot added a commit that referenced this pull request Jan 1, 2021
github-actions bot pushed a commit that referenced this pull request Jan 1, 2021
Ashwin Maroli: Add a disclaimer to tutorials involving Ruby code (#8525)

Merge pull request 8525
@jekyll jekyll locked and limited conversation to collaborators Jan 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants