3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-20 07:05:44 +01:00

Answer product-owner round 1: 1 🔴, 5 🟡 (0 misread); add the licence notice, link each document to its page, stop a failed fetch reaching the corpus, keep raw folders out of the repo

This commit is contained in:
2026-11-05 00:17:32 +01:00
committed by Lillem4n
parent 8fee35a63b
commit 1e3d6e5d65
51 changed files with 3164 additions and 1055 deletions
+15 -3
View File
@@ -13,10 +13,13 @@ One directory per contract kind:
- `real-payloads/` — `<name>.json`: ADF Atlassian's editor wrote, round-tripped ADF→markdown→ADF
and ADF→HTML→ADF. No expected markdown or HTML.
- `real-world/` — `<name>.json`: anonymized documents from public Jira and Confluence sites,
round-tripped as `real-payloads/` is. `real-world-sources.json` names each one's source, licence
and retrieval date. `corpus-gathering/run.sh <raw folder>` writes both, and the raw folder stays
outside the repo because its documents hold the sites' real text
round-tripped as `real-payloads/` is. `real-world-sources.json` names each one's original page,
licence and retrieval time. `corpus-gathering/run.sh <folder outside the repo>` fetches the
documents into that folder, then replaces the whole set and that file. It needs Docker and
network, and takes minutes
(`docs/decisions.md` §The real-world corpus holds anonymized documents from sites whose licence it records).
`typesNoFetchedDocumentHolds` in `src/conformance/corpus.test.ts` lists the node types these
documents don't show.
- `commonmark-spec/` — the CommonMark suite run against `commonMarkToAdf` by three checks.
`spec.json` is the suite; `refusals.json` pins each refusing example to its error `code`;
`exceptions.json` pins each known divergence by `check`, `example`, `kind` and the exact
@@ -30,3 +33,12 @@ suite, byte-exact from [spec.commonmark.org](https://spec.commonmark.org/0.31.2/
(CommonMark 0.31.2, © John MacFarlane,
[CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/)), and is not re-serialized by the
corpus gate.
`real-world/` isn't under this repository's MIT licence. Each document adapts the work its entry's
`url` names, replacing its text, names, ids and URLs, and that page credits its creators, whom the
documents don't name. It stays under the licence its entry names,
[CC-BY-3.0](https://creativecommons.org/licenses/by/3.0/) or
[CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/), without warranty, and an adaptation
of a CC-BY-SA-4.0 document is shared under that licence. Only the ONAP wiki states its own licence.
The others rest on the Linux Foundation's terms of use, which don't name these sites, so their
licence is our reading of those terms.