Repository navigation
docs(about): write the repos and license pages - #28
Conversation
|
Added fa573e6: the licence page now lists the Apache License 2.0 files in |
|
8ff888d says on the license page that every repo's LICENSE is the verbatim Apache 2.0 text. That is true once CryptOS-PKI/cryptos-node#289, CryptOS-PKI/api#124, CryptOS-PKI/cryptos-manager#130, CryptOS-PKI/cryptos-web#132, CryptOS-PKI/helm#24 and #41 merge (with CryptOS-PKI/.github#6 and CryptOS-PKI/cryptos-lab#3), so merge this after or with them. |
The repos page lists every public CryptOS-PKI repo, what it holds and how the four core repos fit together. The license page states the Apache 2.0 terms, NOTICE and header conventions, and the dependency license allowlists, taken from each repo's LICENSE, NOTICE and CI workflows. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
lab and .github now carry the Apache License 2.0, so the licence page lists their files and drops the caution about lab having no licence. Lands together with CryptOS-PKI/cryptos-lab#3 and CryptOS-PKI/.github#6. Refs CryptOS-PKI/.github#4 Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
The LICENSE files are moving to the text published by the ASF, unchanged, so GitHub detects them as Apache-2.0. Say so on the license page, and that the copyright line is in NOTICE. Refs CryptOS-PKI/.github#4 Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
The licensing PRs move every NOTICE and source header to "Copyright The CryptOS Authors." and drop golic's Apache License 2.0 title line. The page also said task license puts headers back; it is the check, and task license:fix writes them. Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
bdc6ee2 to
84a9184
Compare
|
Closing summary: writes the About pages for the public repositories (what each one holds and how they fit together) and the licence (Apache 2.0, the NOTICE file, the CNCF copyright line and the verbatim source header). Rebased onto docs/stub-pages (now level with main, including the theme, the VMCA pages and the install pages) with every commit signed off; |
What and why
The two About pages were stubs. This writes them for an operator who has never seen CryptOS.
docs/about/repos.md: howcryptos,api,managerandwebfit together, what each one holds (paths and binaries taken from each repo), where release artifacts come from, the other public repos (helm,lab,docs,.github), the two Fleet Manager charts, and a "which repo do I need" table.docs/about/license.md: Apache 2.0 per repo with links to each LICENSE and NOTICE, the copyright and NOTICE text, the source header golic manages, and the dependency license allowlists each repo's CI enforces.laband.githubhave no LICENSE file, and the page says so.Titles, emoji and sidebar positions are unchanged. The stub lines are gone.
Closes #22
Verification
How this was verified
npm ci --ignore-scriptsandnpm run build: build succeeds with no broken-link warnings.main.gh repo list CryptOS-PKI.Before merging: add a closing comment summarizing what was actually done in this PR
(not just the checked boxes).