search

yahoo / fili

Easily make RESTful web services for time series reporting with Big Data analytics engines like Druid and SQL Databases.
http://fili.io
Apache License 2.0
172 stars 96 forks source link

Possibility for open sourcing fili.io? #1291

Open QubitPi opened 1 year ago

QubitPi commented 1 year ago

Hi Fili, would it be possible to open source fili.io? Because our team, which uses fili internally, is expanding and onboarding some folks whose primary language is Chinese. We noticed fili.io does have partial Chinese translation but not complete; it'd be great for everybody to expand fili community to a broader audience and our team will definitely dedicate a a Chinese translation for it.

Thanks

michael-mclawhorn commented 1 year ago

Hey @QubitPi, long time no see. How can we make Fili.io more open source for you?

QubitPi commented 1 year ago

Hi @michael-mclawhorn, good to hear back from you!

The story is that we are implementing streaming ingestion capabilities in a Fili fork, so that Fili can not only read from but also write to Druid. It is very important for our team to comprehensively document this feature.

We thought the best way to write documentation would be by "adding it" on top of a fili.io fork (that's why we were hoping fili.io be open sourced), because

  1. it's the quickest approach, and
  2. it will make it easier for us to contribute back to Fili in the future

Understanding that enabling external contributions to fili.io takes effort and time from Fili core team, we propose a common alternative approach, which is co-hosting source code and documentation in the the same repository and then publishing the documentation (fili.io) to GitHub Pages. We see a lot of open source projects on GitHub use this approach and we adopt this approach as well using Docusaurus for all of our project documentations. Here is an example that basically turns fili/docs directory into a live site; we can make this happen in just 1 PR that affects fili/docs codes only

Although we could leave fili/docs as it is, we think a live site would attract more people and help expand fili user base. In addition, as we said above, we like Fili and love contributing back to Fili community by making its documentation better. In fact, we've already identified 3 broken links in fili/docs, which have been fixed in our version of doc already