clearmatics / qreacto

Run standalone React components in your Quarto project!
https://clearmatics.github.io/qreacto/example.html
MIT License
34 stars 1 forks source link

Licensing Considerations for Extension: Qreacto #1

Closed dweng0 closed 1 year ago

dweng0 commented 1 year ago

TL;DR I propose we use an MIT licensing strategy for this extension, and would like your thoughts and feedback.

Hi @aiman @flofrie As part of the process of migrating over to Quarto, I have developed an extension for Quarto that allows us to inject React components into quarto markdown documentation, I think it is something the Quarto community would love to be able to use and so we need to consider the licensing strategy for this extension.

To begin, let's go through its functionality. Qreacto enables the injection of React components into markdown documents within a Quarto project. The user creates a react component in javascript or typescript and provides the necessary shortcode in the md document. The extension will find, inject, transpile and execute the component, providing all the reactivity of a typical React component.

When reviewing peer extensions, I noticed that they generally adopt the MIT license. To foster collaboration within the Quarto community, it would be prudent to follow a similar licensing strategy. However, i'm not sure what the best approach is and would lilke your thoughts and feedback on the matter.

Once the licensing is in place I would like the repository to be made public. This will be beneficial for the continued development of the extension becase any questions or issues raised over at Quarto's repo typically need to have a repo linked for any meaningful responses. Again happy to discuss the pros and cons of this.

The most popular extensions in the eco system all use MIT as at 28th July 2023

to name a few

dweng0 commented 1 year ago

@flofrie FYSA

rmsams commented 1 year ago

I have developed an extension for Quarto that allows us to inject React components into quarto markdown documentation, I think it is something the Quarto community would love to be able to use

Good stuff @dweng0 !

I fully support open sourcing this and am fine with the MIT license in this case. I assume the repo for the extension will be in the clearmatics GH org?

dweng0 commented 1 year ago

I assume the repo for the extension will be in the clearmatics GH org?

That's right, Quarto leverages GH for adding extensions, so users would do

quarto add clearmatics/qreacto

To add the extension to their project

dweng0 commented 1 year ago

I'll leave this issue open until EoD Wednesday. Please do let me know if there are any questions. I have added some next steps. Provided there are no questions/issues that need resolving first

rmsams commented 1 year ago

No issues from me, and I'm happy to see this open sourced.

rmsams commented 1 year ago

@dweng0 do you want to do any promo of the project after it's published? Eg tweet something on @clearmatics twitter to @quarto_pub ?

flofrie commented 1 year ago

Completely agree, I think this would be a great contribution to the community. Also agree it's Clearmatics, not Autonity Github; and MIT license seems a good choice. Tagging @JackmooreCM for helping promote it.

dweng0 commented 1 year ago

@rmsams

An excellent idea, a couple of suggestions, but its not really my forte so @JackmooreCM feel free to ignore if it is not the right calibre tweet.

๐Ÿš€ We've just created a Quarto extension for use with @Quarto_pub's Quarto! ๐Ÿ”ฅYour documents can now house dynamic React components! ๐Ÿ’ก. #Quarto #ReactJS #WebDevelopment


Excited to announce our Qreacto extension! ๐Ÿš€ Inject your awesome React components into @quarto_pub's Quarto projects effortlessly. ๐Ÿ“๐Ÿงช Boost your creativity with #Quarto and #React. Try it now! #WebDevelopment #MarkdownMagic

JackmooreCM commented 1 year ago

Great idea, happy to get this scheduled onto Clearmatics Twitter and perhaps Linkedin this week?

dweng0 commented 1 year ago

Great idea, happy to get this scheduled onto Clearmatics Twitter and perhaps Linkedin this week?

Hey @JackmooreCM, will open source this EoD today, but lets put something out Monday at 9:00am? My reasoning is that I want to "use it" in its open source form as an extension and test/adjust tomorrow/Friday