Repository navigation
docs: state that ExtendDB is maintained by AWS - #964
Conversation
The README, the crate README, the Docker Hub overviews and the npm README say ExtendDB is an open source project managed by Amazon Web Services. The footer of 59 documents, the PDF license page, docs/NOTICE.md and the console documentation page said it is not affiliated with, endorsed by, or sponsored by Amazon Web Services. SECURITY.md and CODE_OF_CONDUCT.md route reports to Amazon. The footers, the license page, NOTICE.md and the console page now say ExtendDB is an open source project managed by Amazon Web Services and is not Amazon DynamoDB or an AWS service. The README wording is unchanged. Verified with git grep: no file says "affiliated with", "endorsed by" or "sponsored by" after the change. Closes #661.
jcshepherd
left a comment
There was a problem hiding this comment.
There are a few ADRs that are missing the license footer altogether: 0004, 0010, 0018, 0019
There was a problem hiding this comment.
Some things in docs/design are missing their license footer too: everything from 11-* on up.
docs/manuals 12 and 13 too.
docs/rfcs/README.md and draft-cassandra-backend.md too (darn those Cassandra people)
In docs/ , version.md, verifying-images.md and dev-image.md .
demohan
left a comment
There was a problem hiding this comment.
ExtendDB should state who runs it in one sentence, and that sentence should say "maintained by AWS":
ExtendDB is an open source project maintained by AWS.
That sentence goes in 69 places: the 59 documentation footers, the PDF license page in docs/build-docs.py, docs/NOTICE.md, the console documentation page, README.md, crates/bin/README.md, the four Docker Hub overviews and packaging/npm/README.md. The last seven are outside this diff and still say "an independent open source project managed by Amazon Web Services". Dropping "independent" there answers open question 2. In the footers the change is one line: source project maintained by AWS. It is not Amazon DynamoDB or an AWS service. followed by "DynamoDB" is a trademark of Amazon.com, Inc. on the next line. The title and body would change to match.
Other items:
- 19 documents under
docs/have no footer, so they have no ownership statement. Besides the files in the earlier comments,docs/adr/README.mdhas none. The earlier "version.md" isdocs/versioning.md. - The body says the PR is a draft until the open questions are answered. The PR is open for review, and code owners are requested.
- Optional, and older than this branch: the footers say
"DynamoDB" is a trademark of Amazon.com, Inc., and the rootNOTICEanddocs/NOTICE.mdsayAmazon.com, Inc. or its affiliates.
At 96f9423 no "affiliated with", "endorsed by" or "sponsored by" text remains, main has added none since the branch point, and the branch merges onto main without conflict.
Review on #964 settled the wording: one sentence, "ExtendDB is an open source project maintained by AWS." - The footers of 59 documents, the PDF license page, docs/NOTICE.md and the console documentation page now use that sentence. - README.md, crates/bin/README.md, the four Docker Hub overviews and the npm README drop "an independent open source project managed by Amazon Web Services" for the same sentence. - The 19 documents under docs/ that had no License section now have the same one as the rest. Verified with git grep: no tracked file says "managed by Amazon Web Services", "managed by AWS", "independent open source", "affiliated with", "endorsed by" or "sponsored by". Every Markdown file under docs/ except NOTICE.md carries the License section.
…DB in the console banner Three documents had their License section without the --- line the other 75 have. The console documentation banner wrote the name as extenddb in the sentence before 'ExtendDB is an open source project maintained by AWS.'
|
Thanks @demohan and @jcshepherd. Both reviews are addressed at 6b6cc1b.
Checked at 6b6cc1b:
Still open, in the description: the copyright line ("ExtendDB contributors" or "Amazon.com, Inc. or its affiliates"), and the trademark line, which says "Amazon.com, Inc." in the footers and "or its affiliates" in the NOTICE files. I've left both as they are. |
|
A wording pass over the whole repository turned up 11 open questions about text next to the new sentence: "clean-room", "independent", the compatibility claims, the trademark, copyright and NOTICE lines, and the contribution terms. They are in the description under Open questions, each with its location. Questions 1 and 2 are small and I propose fixing them in this PR unless someone objects. The rest need a decision from a maintainer, OSPO or legal. |
…-statement # Conflicts: # docker/dockerhub-overview-dev.md # docs/design/15-backup-restore.md
|
Rechecked at 1eada0f: every Markdown file under On the open questions:
With items 1, 2, 3, 6, 7 and 11, this is ready to merge. |
- AGENTS.md: 'maintained by AWS' replaces 'initially developed by AWS engineers'. - README, crate README, Docker Hub overviews, npm README: add 'It is not an AWS service.' - docs/NOTICE.md and the console documentation page: drop 'independent'. - crates/storage-sqlite/README.md: ExtendDB dev is the drop-in replacement for DynamoDB Local. - Trademark line reads 'Amazon.com, Inc. or its affiliates' in all 87 places. - devtools/approved-licenses.txt: remove the internal policy link.
|
@demohan, all six answers are applied in 4e40938.
Items 4, 5, 8, 9 and 10 are unchanged, as you said. Checked at 4e40938:
|
jcshepherd
left a comment
There was a problem hiding this comment.
LGTM: earlier feedback addressed. Assuming Deepthi signs off on the wording, you're good to go.
ExtendDB#964 gave every document under docs/ the same License section, with a second paragraph that says ExtendDB is maintained by AWS and is not Amazon DynamoDB. ADR-0030 had the first paragraph only. It now has the same section as ADR-0029. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: michael parsons <michael@twisp.com>
#964 on main changed the sentence at the end of every document, in NOTICE.md, in the README and in the console documentation page. The sentence now reads "ExtendDB is an open source project maintained by AWS. It is not Amazon DynamoDB or an AWS service." The site removes each page's License section at build time, so the footer is the one place the site states this. The footer now carries the sentence from #964, and the trademark line names Amazon.com, Inc. or its affiliates as the documents do.
What
The repository said two different things about who runs ExtendDB. This PR makes it say one thing, in one sentence:
README.md,crates/bin/README.md, the four Docker Hub overviews,packaging/npm/README.mddocs/, the PDF license page indocs/build-docs.py,docs/NOTICE.md, the console documentation pagedocs/with no License sectionDecision
The sentence is "ExtendDB is an open source project maintained by AWS.", settled in review on this PR. It replaces both earlier statements, and "independent" is dropped.
The rest of the repository already treats the project as AWS-run:
SECURITY.mdsends vulnerability reports to AWS Security, andCODE_OF_CONDUCT.mdadopts the Amazon Open Source Code of Conduct. Every surface follows the sentence with one that keeps ExtendDB apart from the service: "It is not Amazon DynamoDB or an AWS service." in the documentation footers anddocs/NOTICE.md, and "It is not an AWS service." in the README files and package pages.Changes
91 files.
docs/NOTICE.mdand the console documentation page: the same sentence, and "independent" is dropped from "clean-room implementation".README.md,crates/bin/README.md, the four Docker Hub overviews andpackaging/npm/README.md: "an independent open source project managed by Amazon Web Services" becomes "an open source project maintained by AWS", followed by "It is not an AWS service."AGENTS.md(andCLAUDE.md, which links to it): "initially developed by AWS engineers" becomes "maintained by AWS".crates/storage-sqlite/README.md: the dev-mode profile builds "ExtendDB dev, a drop-in replacement for DynamoDB Local".devtools/approved-licenses.txt: the internal policy link is removed. The approved list is unchanged (51 identifiers).docs/adr/README.md; design documents 11, 12, 13 and the four 15 documents; manuals 12 and 13;docs/rfcs/README.mdanddocs/rfcs/draft-cassandra-backend.md;docs/dev-image.md,docs/verifying-images.mdanddocs/versioning.md.Merging this publishes the new Docker Hub overview text, since a push to main that changes those files updates Docker Hub.
Testing
git grep -i -E "managed by (Amazon|AWS)|independent open source|independent, clean-room|affiliated with|endorsed by|sponsored by"finds nothing.Amazon.com, Inc.is left without "or its affiliates".docs/are identical apart from the relativeLICENSEpath.docs/exceptNOTICE.mdcarries the License section.cargo check -p extenddb-serverpasses.Answered questions
The 11 open questions were answered by @demohan in review (comment lists the changes). Changes are in 4e40938.
AGENTS.mddocs/NOTICE.mdand console pagecrates/storage-sqlite/README.mdNOTICEdevtools/approved-licenses.txtOverlap with #530
#530 also changes these lines, with the wording "maintained by engineers at Amazon Web Services". Whichever merges second needs to rebase, and #530 would take the wording settled here.
Closes #661.