Conversation
Signed-off-by: tym83 <6355522@gmail.com>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughAdds a shared licenses include and new Licenses documentation pages for multiple site versions that include that shared content. No code or public API changes. ChangesLicense Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive license reference page for Cozystack by adding a shared markdown file that lists licenses for core, system, and application packages, along with managed workload runtimes. This content is integrated into the documentation for both the current and upcoming versions. Feedback was provided to ensure consistency in the monitoring agents entry by including source links for all listed components rather than just one.
| | `system/mongodb-operator` | Percona Operator for MongoDB Helm chart | Apache-2.0 | [source](https://github.com/percona/percona-server-mongodb-operator/blob/main/LICENSE) | | ||
| | `system/mongodb-rd` | Cozystack MongoDB resource definition | Apache-2.0 | [source](https://github.com/cozystack/cozystack/tree/main/packages/system/mongodb-rd) | | ||
| | `system/monitoring` | Cozystack monitoring package | Apache-2.0 | [source](https://github.com/cozystack/cozystack/tree/main/packages/system/monitoring) | | ||
| | `system/monitoring-agents` | Fluent Bit; kube-state-metrics; node-exporter | Apache-2.0 | [source](https://github.com/fluent/fluent-bit/blob/master/LICENSE) | |
There was a problem hiding this comment.
The system/monitoring-agents entry lists three components (Fluent Bit, kube-state-metrics, and node-exporter) but only provides a source link for Fluent Bit. For completeness and consistency with other multi-component entries in this table (such as system/fluxcd or HTTP Cache), source links for all listed components should be included.
| | `system/monitoring-agents` | Fluent Bit; kube-state-metrics; node-exporter | Apache-2.0 | [source](https://github.com/fluent/fluent-bit/blob/master/LICENSE) | | |
| | system/monitoring-agents | Fluent Bit; kube-state-metrics; node-exporter | Apache-2.0 | [fluent-bit](https://github.com/fluent/fluent-bit/blob/master/LICENSE), [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics/blob/main/LICENSE), [node-exporter](https://github.com/prometheus/node_exporter/blob/master/LICENSE) | |
Signed-off-by: tym83 <6355522@gmail.com>
myasnikovdaniil
left a comment
myasnikovdaniil
left a comment
There was a problem hiding this comment.
Thanks for putting this together — overall the data looks accurate and the per-version pages are clean. A few changes before this can land:
1. Scope: keep only next/ and v1.3/
Please drop the new files for v0/, v1.0/, v1.1/, and v1.2/.
The package list in this PR reflects the current (v1.3-era) set. v0 in particular is a different product snapshot — its applications/ tree had ferretdb and mysql, and didn't have foundationdb, harbor, mariadb, openbao, or qdrant. Backfilling the current list under v0/ would document components that release didn't ship.
For v1.0–v1.2 the application set matches v1.3, but the pinned upstream versions and operators differ across minor releases, and licenses can change between upstream versions (e.g. Redis, MongoDB-family). A license reference should be a per-release snapshot, not a single rolling document retro-applied to frozen versions.
The convention in this repo is that older vX.Y/ directories are frozen as-shipped — we shouldn't retrofit current state into them. If we want license data for older releases, that's worth a separate, version-accurate effort.
2. Include placement
The shared file currently lives at content/en/docs/_include/licenses.md and is transcluded from each per-version page. Two issues with this layout, even after scoping down to next/ + v1.3/:
- It's a new pattern. Existing
{{< include >}}usages all live inside per-version_include/directories (e.g.docs/v1.2/install/_include/hardware-config-tabs.md,docs/v1.2/operations/services/_include/monitoring-overview.md). - Once v1.4 is released and
v1.3/is frozen, edits to the shared file would silently mutate the v1.3 snapshot.
Two reasonable options:
- (a) Inline the body into each version's
licenses.md. Two copies, no shared include — matches how independent versions are supposed to work. Simplest. - (b) Per-version include:
docs/next/operations/configuration/_include/licenses.mdanddocs/v1.3/operations/configuration/_include/licenses.md. Matches the existing_include/convention.
I'd lean toward (a) — there's only one consumer per version, so the indirection doesn't pay off. Either is fine.
3. Generator script — follow-up
This file is hand-curated, but the source of truth lives upstream in cozystack/cozystack (packages/{core,system,apps,extra}/*/Chart.yaml and the components they vendor). To keep the page from drifting at each release, can we add a generator alongside the existing hack/update_apps.sh / hack/download_openapi.sh?
Rough shape:
hack/update_licenses.shdriven bymake update-licenses(and rolled intoupdate-all)- enumerates packages under
packages/{core,system,apps,extra}/in the upstream repo at the requested ref - reads license metadata — either a chart annotation (e.g.
cozystack.io/license,cozystack.io/upstream-license,cozystack.io/upstream-source) or a small per-package metadata file maintained upstream - emits the table into
content/en/docs/<DOC_VERSION>/operations/configuration/licenses.mdusing the sameRELEASE_TAG→DOC_VERSIONrouting asupdate-apps
Doesn't have to block this PR — happy to land hand-maintained content for v1.3 + next now and track the generator separately. But it shouldn't be the steady state; without it this page will drift silently.
Nit
system/linstor-guirow links to the repo root rather than aLICENSEfile — please update for consistency with the surrounding rows.
3 participants
Summary
Verification
Summary by CodeRabbit