Skip to content

docs: add platform licenses reference#530

Open
tym83 wants to merge 2 commits intomainfrom
docs/licenses-reference
Open

docs: add platform licenses reference#530
tym83 wants to merge 2 commits intomainfrom
docs/licenses-reference

Conversation

@tym83
Copy link
Copy Markdown
Contributor

@tym83 tym83 commented May 6, 2026

Summary

  • add a shared Licenses documentation include for Cozystack platform components
  • publish the Licenses page for all documentation versions: v0, v1.0, v1.1, v1.2, v1.3, and next
  • include upstream license source links for system packages and managed runtimes

Verification

  • HUGO_ENV=production hugo --gc --minify --destination /tmp/cozystack-site-public-production-all --cacheDir /tmp/hugo-cache
  • HUGO_ENV=preview hugo --gc --minify --buildFuture --destination /tmp/cozystack-site-public-preview-all --cacheDir /tmp/hugo-cache

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Licenses documentation across documentation versions (v0, v1.0–v1.3, v1.2, and next), consolidating license details for Core, System, Application/Extra packages and Managed Workload Runtimes. The new pages present license rows with sources, an informational alert, and consistent formatting so license information is readily accessible and uniform across docs.

Signed-off-by: tym83 <6355522@gmail.com>
@tym83 tym83 requested review from kvaps and lllamnyp as code owners May 6, 2026 09:28
@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit 941da75
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/69fb8e8eaf21fb0008b496af
😎 Deploy Preview https://deploy-preview-530--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e0fb014b-d748-4c4f-90c9-05e43d26e6c8

📥 Commits

Reviewing files that changed from the base of the PR and between 44d0feb and 941da75.

📒 Files selected for processing (4)
  • content/en/docs/v0/operations/configuration/licenses.md
  • content/en/docs/v1.0/operations/configuration/licenses.md
  • content/en/docs/v1.1/operations/configuration/licenses.md
  • content/en/docs/v1.3/operations/configuration/licenses.md
✅ Files skipped from review due to trivial changes (2)
  • content/en/docs/v1.1/operations/configuration/licenses.md
  • content/en/docs/v1.0/operations/configuration/licenses.md

📝 Walkthrough

Walkthrough

Adds a shared licenses include and new Licenses documentation pages for multiple site versions that include that shared content. No code or public API changes.

Changes

License Documentation

Layer / File(s) Summary
Shared content
content/en/docs/_include/licenses.md
Adds a comprehensive licenses include containing headers, an informational alert, and tables listing licenses and sources for Core, System, Application/Extra packages, and Managed Workload Runtimes.
Versioned documentation pages
content/en/docs/next/operations/configuration/licenses.md, content/en/docs/v1.* /operations/configuration/licenses.md
Adds new Licenses pages for next, v0, v1.0, v1.1, v1.2, and v1.3 with YAML front matter (title, linkTitle, description, weight) that render the shared include via {{< include "docs/_include/licenses.md" >}}.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hoppin' through docs with a jaunty spin,

Licenses gathered, tidy within.
A shared little page, across versions it flies,
Compliance in order — rejoice, little eyes! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add platform licenses reference' clearly and specifically describes the main change: introducing a licenses documentation page for the platform, with references included across multiple documentation versions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/licenses-reference

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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
| `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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants