Skip to content

docs: rewrite README and switch licence to OSL-3.0 - #204

Merged
lfrancke merged 5 commits into
mainfrom
docs/public-readme
Sep 4, 2026
Merged

docs: rewrite README and switch licence to OSL-3.0#204
lfrancke merged 5 commits into
mainfrom
docs/public-readme

Conversation

@lfrancke

@lfrancke lfrancke commented Jun 16, 2026

Copy link
Copy Markdown
Member
  • Rewrite README -> I mostly copied this over from our operators
  • Switch the project licence from Apache-2.0 to OSL-3.0 (LICENSE)
  • Add LICENSE-Apache-2.0
  • Set the package.json license field to OSL-3.0

@lfrancke
lfrancke force-pushed the docs/public-readme branch from 0a37e05 to 0bb81eb Compare June 16, 2026 20:13
@lfrancke lfrancke mentioned this pull request Aug 31, 2026
14 tasks
- Rewrite README to describe the actual product and match the SDP
  operator-repo structure (About SDP, Documentation, Contributing,
  Support, Sponsor and License sections)
- Update the operator list: drop Apache Druid, add OpenSearch
- Switch the project licence from Apache-2.0 to OSL-3.0 (LICENSE)
- Add LICENSE-Apache-2.0 for the bundled Apache-2.0 Trino SQL grammar
  and code derived from it; attribution stays in the per-file headers
- Set the package.json license field to OSL-3.0
@lfrancke
lfrancke force-pushed the docs/public-readme branch from 0bb81eb to 555765a Compare August 31, 2026 09:08
@lfrancke lfrancke self-assigned this Aug 31, 2026
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Aug 31, 2026
@soenkeliebau

Copy link
Copy Markdown
Member

Read it, looks good to me.
The extra Apache License file is present to redistribute the license as some components use it, I presume?

Not sure how extensive a review you want, I haven't run all the start commands etc. happy to do so, but that would probably make this a "tomorrow" thing :)

@dervoeti dervoeti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LABEL org.opencontainers.image.licenses needs to be updated in the Dockerfile. And we should maybe copy the Apache license into the container as well (since we ship the ANTLR parser which is generated from Trino's SQL grammar).

@dervoeti dervoeti moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Sep 1, 2026
…e-2.0

The image contains the ANTLR parser generated from Trino's Apache-2.0
SQL grammar, so its licence text is redistributed alongside the
project licence in /licenses.
@lfrancke

lfrancke commented Sep 4, 2026

Copy link
Copy Markdown
Member Author

Thanks both for taking a look. Yes, Apache is there for the Trino grammar. I made the requested changes. And no need to review the actual content Sönke.

@lfrancke
lfrancke requested a review from dervoeti September 4, 2026 06:30
@lfrancke
lfrancke merged commit c8a3099 into main Sep 4, 2026
12 checks passed
@lfrancke
lfrancke deleted the docs/public-readme branch September 4, 2026 11:21
@lfrancke lfrancke moved this from Development: In Review to Development: Done in Stackable Engineering Sep 8, 2026
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

3 participants