Skip to content

Commit e31ecd3

Browse files
danbarrclaude
danbarr
and
claude
authored
Fixup license headers and adopt CC BY 4.0 for content (#874)
* Fix missing SPDX and attribution headers Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com> * Normalize block comment styles Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com> * Add CC BY 4.0 license for content Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com> * Promote CC BY 4.0 to primary repo license The repo is primarily documentation, so the top-level LICENSE now contains CC BY 4.0 and Apache-2.0 moves to LICENSE-code. Per-file SPDX headers remain authoritative for code. Layout matches the kubernetes/website convention. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Address Copilot review on PR #874 - README: soften SPDX coverage claim to acknowledge unheadered configs. - NotFound/index.tsx: clarify the code (not the header) is unmodified. - Column/Columns: add SPDX-FileCopyrightText for the original author so attribution is machine-readable. The Redocly plugin files (also flagged) are left as-is. They are tutorial verbatim from Redocly's plugin guide, below the threshold of originality where formal copyright assertion makes sense. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com> Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 15ef141 commit e31ecd3

25 files changed

Lines changed: 830 additions & 324 deletions

File tree

‎LICENSE‎

Lines changed: 395 additions & 201 deletions
Large diffs are not rendered by default.

‎LICENSE-code‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ at [https://docs.stacklok.com](https://docs.stacklok.com).
1111
- [Formatting](#formatting)
1212
- [Building the site](#building-the-site)
1313
- [Deployment](#deployment)
14+
- [License](#license)
1415
- [About](#about)
1516

1617
## Contributing to docs
@@ -91,6 +92,33 @@ The `docs.stacklok.com` site is published using Vercel. Automatic previews for
9192
branches and pull requests are enabled. The production site is published from
9293
the `main` branch.
9394

95+
## License
96+
97+
This repository is primarily documentation, so the default license is for
98+
content. Code is licensed separately:
99+
100+
- **Documentation content** (Markdown and MDX files under `/docs` and `/blog`,
101+
plus accompanying images and diagrams) is licensed under
102+
[Creative Commons Attribution 4.0 International (CC BY 4.0)](./LICENSE).
103+
- **Code** (anything that compiles, runs, or configures the site - including
104+
`.ts`, `.tsx`, `.js`, `.mjs`, `.css`, and config files) is licensed under the
105+
[Apache License 2.0](./LICENSE-code). Most source files carry SPDX headers
106+
identifying this; a small number of top-level config files do not, and inherit
107+
the code license by virtue of being code.
108+
109+
This split follows the convention used by the
110+
[Kubernetes website repository](https://github.com/kubernetes/website).
111+
112+
Stacklok trademarks, logos, and brand marks (including the contents of
113+
`/static/img/logos/` and the Stacklok wordmark and icon used throughout the
114+
site) are excluded from both licenses and remain the property of Stacklok, Inc.
115+
116+
A small number of source files carry their own upstream license headers (for
117+
example, components adapted from the Docusaurus community knowledge base under
118+
CC BY-SA 4.0, theme components ejected from Docusaurus under MIT, and Font
119+
Awesome assets). In those files the file-level header is authoritative for that
120+
file.
121+
94122
## About
95123

96124
This site is built with [Docusaurus](https://docusaurus.io/).

‎plugins/crd-reference-remark/index.mjs‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
// Remark plugin that expands <CRDReference kind="..." /> MDX elements into
2-
// an ordered sequence of markdown headings + <CRDFields> calls, one per
3-
// object scope in the referenced CRD schema. The headings are injected
4-
// into the AST so Docusaurus's downstream TOC extractor picks them up;
5-
// this is why we do it as a remark plugin rather than purely at render
6-
// time in a React component.
7-
//
8-
// <CRDFields kind="..." path="..." /> is left alone - it's the per-scope
9-
// renderer that guides can inline without triggering heading injection.
1+
// SPDX-FileCopyrightText: Copyright 2026 Stacklok, Inc.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
/*
5+
* Remark plugin that expands <CRDReference kind="..." /> MDX elements into
6+
* an ordered sequence of markdown headings + <CRDFields> calls, one per
7+
* object scope in the referenced CRD schema. The headings are injected
8+
* into the AST so Docusaurus's downstream TOC extractor picks them up;
9+
* this is why we do it as a remark plugin rather than purely at render
10+
* time in a React component.
11+
*
12+
* <CRDFields kind="..." path="..." /> is left alone - it's the per-scope
13+
* renderer that guides can inline without triggering heading injection.
14+
*/
1015

1116
import fs from 'node:fs';
1217
import path from 'node:path';

‎scripts/extract-crd-schemas.mjs‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
#!/usr/bin/env node
2-
// Extract each CRD's openAPIV3Schema from the upstream ToolHive CRD YAMLs.
3-
// For each CRD this writes three files under static/api-specs/crds/:
4-
// <plural>.schema.json - JSON Schema (apiVersion/kind/metadata stripped)
5-
// <plural>.example.yaml - Minimal YAML skeleton covering required fields
6-
// Plus a shared index.json with metadata and a reference graph.
7-
//
8-
// Usage:
9-
// node scripts/extract-crd-schemas.mjs [--src <dir>]
10-
//
11-
// Default src is ../toolhive/deploy/charts/operator-crds/files/crds relative
12-
// to this repo. Set TOOLHIVE_CRD_DIR to override.
2+
// SPDX-FileCopyrightText: Copyright 2026 Stacklok, Inc.
3+
// SPDX-License-Identifier: Apache-2.0
4+
5+
/*
6+
* Extract each CRD's openAPIV3Schema from the upstream ToolHive CRD YAMLs.
7+
* For each CRD this writes three files under static/api-specs/crds/:
8+
* <plural>.schema.json - JSON Schema (apiVersion/kind/metadata stripped)
9+
* <plural>.example.yaml - Minimal YAML skeleton covering required fields
10+
* Plus a shared index.json with metadata and a reference graph.
11+
*
12+
* Usage:
13+
* node scripts/extract-crd-schemas.mjs [--src <dir>]
14+
*
15+
* Default src is ../toolhive/deploy/charts/operator-crds/files/crds relative
16+
* to this repo. Set TOOLHIVE_CRD_DIR to override.
17+
*/
1318

1419
import fs from 'node:fs';
1520
import path from 'node:path';

‎scripts/generate-crd-pages.mjs‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
#!/usr/bin/env node
2-
// Generate MDX pages for each CRD plus the CRD reference landing page and a
3-
// sidebar.json consumed by sidebars.ts. Every CRD present in
4-
// static/api-specs/crds/index.json (produced by extract-crd-schemas.mjs) is
5-
// published. Hand-written overrides in scripts/lib/crd-intros.mjs are merged
6-
// over schema-derived defaults, so a new upstream CRD ships a usable page
7-
// automatically; overrides are improvements, not prerequisites.
2+
// SPDX-FileCopyrightText: Copyright 2026 Stacklok, Inc.
3+
// SPDX-License-Identifier: Apache-2.0
4+
5+
/*
6+
* Generate MDX pages for each CRD plus the CRD reference landing page and a
7+
* sidebar.json consumed by sidebars.ts. Every CRD present in
8+
* static/api-specs/crds/index.json (produced by extract-crd-schemas.mjs) is
9+
* published. Hand-written overrides in scripts/lib/crd-intros.mjs are merged
10+
* over schema-derived defaults, so a new upstream CRD ships a usable page
11+
* automatically; overrides are improvements, not prerequisites.
12+
*/
813

914
import fs from 'node:fs';
1015
import path from 'node:path';
@@ -298,7 +303,10 @@ const schemasPath = path.resolve(
298303
'CRDReference',
299304
'schemas.ts'
300305
);
301-
const schemasContent = `// AUTO-GENERATED by scripts/generate-crd-pages.mjs. Do not edit.
306+
const schemasContent = `// SPDX-FileCopyrightText: Copyright 2026 Stacklok, Inc.
307+
// SPDX-License-Identifier: Apache-2.0
308+
309+
// AUTO-GENERATED by scripts/generate-crd-pages.mjs. Do not edit.
302310
// Maps each CRD Kind to its extracted JSON Schema so <CRDFields> and the
303311
// <CRDReference> remark plugin can resolve schemas by Kind name.
304312

0 commit comments

Comments
 (0)