From d1a7cd25d56782da905b399504a4f2e1f29efe80 Mon Sep 17 00:00:00 2001 From: Chojan Shang Date: Thu, 18 Jan 2024 22:18:52 +0800 Subject: [PATCH 1/2] docs: add trademark information to every possible published readme. Signed-off-by: Chojan Shang --- README.md | 6 ++++-- bin/oay/README.md | 6 ++++++ bin/ofs/README.md | 6 ++++++ bin/oli/README.md | 6 ++++++ bindings/c/README.md | 7 +++++-- bindings/cpp/README.md | 6 ++++++ bindings/dotnet/README.md | 6 ++++++ bindings/go/README.md | 6 ++++++ bindings/haskell/README.md | 6 ++++++ bindings/java/README.md | 6 ++++++ bindings/lua/README.md | 6 ++++++ bindings/nodejs/README.md | 4 +++- bindings/ocaml/README.md | 6 ++++++ bindings/php/README.md | 6 ++++++ bindings/python/README.md | 6 ++++++ bindings/ruby/README.md | 6 ++++++ bindings/swift/README.md | 7 +++++-- bindings/zig/README.md | 6 ++++-- core/README.md | 4 +++- 19 files changed, 102 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0b65d2a80b6b..15f756eed067 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,8 @@ The first and most prominent mentions must use the full form: **Apache OpenDAL For more details, see the [Apache Product Name Usage Guide](https://www.apache.org/foundation/marks/guide). -## License +## Trademarks & Licenses -Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bin/oay/README.md b/bin/oay/README.md index 766fd958a23f..368784d5ffe3 100644 --- a/bin/oay/README.md +++ b/bin/oay/README.md @@ -15,3 +15,9 @@ Our first milestone is to provide S3 APIs. ### S3 API Only `list_object_v2` with `start_after` is supported. + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bin/ofs/README.md b/bin/ofs/README.md index 91c98092b587..f145035e0ed4 100644 --- a/bin/ofs/README.md +++ b/bin/ofs/README.md @@ -1,3 +1,9 @@ # OpenDAL File System OpenDAL File System (ofs) is a userspace filesystem backing by OpenDAL. + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bin/oli/README.md b/bin/oli/README.md index 2845b6a00b10..1bc9cb661e1d 100644 --- a/bin/oli/README.md +++ b/bin/oli/README.md @@ -87,3 +87,9 @@ Contribution is not only about code, but also about documentation, examples, and If you have any questions or suggestions about `oli`, please feel free to open an issue on GitHub. As `oli` is a part of Apache OpenDAL, you should follow the [CONTRIBUTION](https://github.com/apache/incubator-opendal/blob/main/CONTRIBUTING.md) documentation. There are still lots works to do with `oli`, you could track them on this [GitHub Issue](https://github.com/apache/incubator-opendal/issues/422). + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/c/README.md b/bindings/c/README.md index 99958bd32960..ffeec915330b 100644 --- a/bindings/c/README.md +++ b/bindings/c/README.md @@ -138,6 +138,9 @@ If you want to build the documentations yourself, you could use make doc ``` -## License +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. -[Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) diff --git a/bindings/cpp/README.md b/bindings/cpp/README.md index d16abde62b39..1d945a74f2e4 100644 --- a/bindings/cpp/README.md +++ b/bindings/cpp/README.md @@ -102,3 +102,9 @@ make docs - `OPENDAL_ENABLE_DOCUMENTATION`: Enable documentation. Default: `OFF` - `OPENDAL_DOCS_ONLY`: Only build documentation. Default: `OFF` - `OPENDAL_ENABLE_TESTING`: Enable testing. Default: `OFF` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/dotnet/README.md b/bindings/dotnet/README.md index 2494c8190acd..28fa7adf790e 100644 --- a/bindings/dotnet/README.md +++ b/bindings/dotnet/README.md @@ -3,3 +3,9 @@ ![](https://img.shields.io/badge/status-unreleased-red) This binding is currently under development. Please check back later. + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/go/README.md b/bindings/go/README.md index 15672b3fbcf9..2f8caab0e014 100644 --- a/bindings/go/README.md +++ b/bindings/go/README.md @@ -55,3 +55,9 @@ For benchmark ```shell go test -bench=. -tags dynamic . ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/haskell/README.md b/bindings/haskell/README.md index dc75dbee7137..392ff4060204 100644 --- a/bindings/haskell/README.md +++ b/bindings/haskell/README.md @@ -56,3 +56,9 @@ cabal haddock ``` If your `cabal` version is greater than `3.8`, you can use `cabal haddock --open` to open the documentation in your browser. Otherwise, you can visit the documentation from `dist-newstyle/build/$ARCH/ghc-$VERSION/opendal-$VERSION/doc/html/opendal/index.html`. + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/java/README.md b/bindings/java/README.md index 996363374b79..22f75609546a 100644 --- a/bindings/java/README.md +++ b/bindings/java/README.md @@ -156,3 +156,9 @@ export OPENDAL_REDIS_ROOT=/ export OPENDAL_REDIS_DB=0 ./mvnw test -Dtest="behavior.*Test" -Dcargo-build.features=services-redis ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/lua/README.md b/bindings/lua/README.md index accae5672702..b2dbb236fe50 100644 --- a/bindings/lua/README.md +++ b/bindings/lua/README.md @@ -64,3 +64,9 @@ $ busted -o gtest test/opendal_test.lua [==========] 2 tests from 1 test file ran. (3.54 ms total) [ PASSED ] 2 tests. ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/nodejs/README.md b/bindings/nodejs/README.md index 3e3490762753..53440b15872b 100644 --- a/bindings/nodejs/README.md +++ b/bindings/nodejs/README.md @@ -50,6 +50,8 @@ main(); - Asking questions in the [Discussions](https://github.com/apache/incubator-opendal/discussions/new?category=q-a). - Talk to community at [Discord](https://discord.gg/XQy8yGR2dg). -## License +## Trademarks & Licenses Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/ocaml/README.md b/bindings/ocaml/README.md index 7699ecb0df5a..a718524bd2a9 100644 --- a/bindings/ocaml/README.md +++ b/bindings/ocaml/README.md @@ -77,3 +77,9 @@ To execute unit tests, we can simply use the following command: cd bindings/ocaml dune test ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/php/README.md b/bindings/php/README.md index 3b0c67c43d59..d8e05e3f024c 100644 --- a/bindings/php/README.md +++ b/bindings/php/README.md @@ -82,3 +82,9 @@ cd incubator-opendal/bindings/php composer install composer test ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/python/README.md b/bindings/python/README.md index 7a194383e0e2..1e85950ac76d 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -105,3 +105,9 @@ Build API docs: maturin develop -E docs pdoc -t ./template opendal ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/ruby/README.md b/bindings/ruby/README.md index 543598de6080..3b5a5eacc30c 100644 --- a/bindings/ruby/README.md +++ b/bindings/ruby/README.md @@ -25,3 +25,9 @@ Run tests: ```shell rake spec ``` + +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/bindings/swift/README.md b/bindings/swift/README.md index af9922a894bd..28ff03630926 100644 --- a/bindings/swift/README.md +++ b/bindings/swift/README.md @@ -63,6 +63,9 @@ let readData = try op.blockingRead("/demo") print(readData!) ``` -## License +## Trademarks & Licenses + +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. -[Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) diff --git a/bindings/zig/README.md b/bindings/zig/README.md index 3f57f0e248b2..2f4b8286afba 100644 --- a/bindings/zig/README.md +++ b/bindings/zig/README.md @@ -21,6 +21,8 @@ zig build libopendal_c zig build test --summary all ``` -## License +## Trademarks & Licenses -[Apache v2.0](https://www.apache.org/licenses/LICENSE-2.0) +Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. diff --git a/core/README.md b/core/README.md index 713491999a5c..208a82e2dd61 100644 --- a/core/README.md +++ b/core/README.md @@ -159,6 +159,8 @@ The examples are available at [here](../examples/rust). Check out the [CONTRIBUTING](CONTRIBUTING.md) guide for more details on getting started with contributing to this project. -## License +## Trademarks & Licenses Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 + +Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation. From 36c48f2a0cfadfda79fa8cacd593f4e3aa22a8f0 Mon Sep 17 00:00:00 2001 From: Chojan Shang Date: Thu, 18 Jan 2024 22:25:43 +0800 Subject: [PATCH 2/2] docs: minor update Signed-off-by: Chojan Shang --- README.md | 2 +- bin/oay/README.md | 2 +- bin/ofs/README.md | 2 +- bin/oli/README.md | 2 +- bindings/c/README.md | 2 +- bindings/cpp/README.md | 2 +- bindings/dotnet/README.md | 2 +- bindings/go/README.md | 2 +- bindings/haskell/README.md | 2 +- bindings/java/README.md | 2 +- bindings/lua/README.md | 2 +- bindings/nodejs/README.md | 2 +- bindings/ocaml/README.md | 2 +- bindings/php/README.md | 2 +- bindings/python/README.md | 2 +- bindings/ruby/README.md | 2 +- bindings/swift/README.md | 2 +- bindings/zig/README.md | 2 +- core/README.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 15f756eed067..95f51d9609d5 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ The first and most prominent mentions must use the full form: **Apache OpenDAL For more details, see the [Apache Product Name Usage Guide](https://www.apache.org/foundation/marks/guide). -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bin/oay/README.md b/bin/oay/README.md index 368784d5ffe3..eae03f47a8c2 100644 --- a/bin/oay/README.md +++ b/bin/oay/README.md @@ -16,7 +16,7 @@ Our first milestone is to provide S3 APIs. Only `list_object_v2` with `start_after` is supported. -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bin/ofs/README.md b/bin/ofs/README.md index f145035e0ed4..eaf472caf3a7 100644 --- a/bin/ofs/README.md +++ b/bin/ofs/README.md @@ -2,7 +2,7 @@ OpenDAL File System (ofs) is a userspace filesystem backing by OpenDAL. -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bin/oli/README.md b/bin/oli/README.md index 1bc9cb661e1d..bf1611e95253 100644 --- a/bin/oli/README.md +++ b/bin/oli/README.md @@ -88,7 +88,7 @@ If you have any questions or suggestions about `oli`, please feel free to open a As `oli` is a part of Apache OpenDAL, you should follow the [CONTRIBUTION](https://github.com/apache/incubator-opendal/blob/main/CONTRIBUTING.md) documentation. There are still lots works to do with `oli`, you could track them on this [GitHub Issue](https://github.com/apache/incubator-opendal/issues/422). -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/c/README.md b/bindings/c/README.md index ffeec915330b..f2210999e4fe 100644 --- a/bindings/c/README.md +++ b/bindings/c/README.md @@ -138,7 +138,7 @@ If you want to build the documentations yourself, you could use make doc ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/cpp/README.md b/bindings/cpp/README.md index 1d945a74f2e4..ec9518e98a8f 100644 --- a/bindings/cpp/README.md +++ b/bindings/cpp/README.md @@ -103,7 +103,7 @@ make docs - `OPENDAL_DOCS_ONLY`: Only build documentation. Default: `OFF` - `OPENDAL_ENABLE_TESTING`: Enable testing. Default: `OFF` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/dotnet/README.md b/bindings/dotnet/README.md index 28fa7adf790e..2d4905025f2c 100644 --- a/bindings/dotnet/README.md +++ b/bindings/dotnet/README.md @@ -4,7 +4,7 @@ This binding is currently under development. Please check back later. -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/go/README.md b/bindings/go/README.md index 2f8caab0e014..a51567ea5da6 100644 --- a/bindings/go/README.md +++ b/bindings/go/README.md @@ -56,7 +56,7 @@ For benchmark go test -bench=. -tags dynamic . ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/haskell/README.md b/bindings/haskell/README.md index 392ff4060204..9c20ccb03c82 100644 --- a/bindings/haskell/README.md +++ b/bindings/haskell/README.md @@ -57,7 +57,7 @@ cabal haddock If your `cabal` version is greater than `3.8`, you can use `cabal haddock --open` to open the documentation in your browser. Otherwise, you can visit the documentation from `dist-newstyle/build/$ARCH/ghc-$VERSION/opendal-$VERSION/doc/html/opendal/index.html`. -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/java/README.md b/bindings/java/README.md index 22f75609546a..3eb2291e1a8b 100644 --- a/bindings/java/README.md +++ b/bindings/java/README.md @@ -157,7 +157,7 @@ export OPENDAL_REDIS_DB=0 ./mvnw test -Dtest="behavior.*Test" -Dcargo-build.features=services-redis ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/lua/README.md b/bindings/lua/README.md index b2dbb236fe50..4f888a8818c5 100644 --- a/bindings/lua/README.md +++ b/bindings/lua/README.md @@ -65,7 +65,7 @@ $ busted -o gtest test/opendal_test.lua [ PASSED ] 2 tests. ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/nodejs/README.md b/bindings/nodejs/README.md index 53440b15872b..3805c2c9b9a7 100644 --- a/bindings/nodejs/README.md +++ b/bindings/nodejs/README.md @@ -50,7 +50,7 @@ main(); - Asking questions in the [Discussions](https://github.com/apache/incubator-opendal/discussions/new?category=q-a). - Talk to community at [Discord](https://discord.gg/XQy8yGR2dg). -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/ocaml/README.md b/bindings/ocaml/README.md index a718524bd2a9..7acfdc18ce96 100644 --- a/bindings/ocaml/README.md +++ b/bindings/ocaml/README.md @@ -78,7 +78,7 @@ cd bindings/ocaml dune test ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/php/README.md b/bindings/php/README.md index d8e05e3f024c..7eb035ca28a2 100644 --- a/bindings/php/README.md +++ b/bindings/php/README.md @@ -83,7 +83,7 @@ composer install composer test ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/python/README.md b/bindings/python/README.md index 1e85950ac76d..be2377203687 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -106,7 +106,7 @@ maturin develop -E docs pdoc -t ./template opendal ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/ruby/README.md b/bindings/ruby/README.md index 3b5a5eacc30c..ee2f7f761023 100644 --- a/bindings/ruby/README.md +++ b/bindings/ruby/README.md @@ -26,7 +26,7 @@ Run tests: rake spec ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/swift/README.md b/bindings/swift/README.md index 28ff03630926..c78ebe549cc3 100644 --- a/bindings/swift/README.md +++ b/bindings/swift/README.md @@ -63,7 +63,7 @@ let readData = try op.blockingRead("/demo") print(readData!) ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bindings/zig/README.md b/bindings/zig/README.md index 2f4b8286afba..1a8698da2589 100644 --- a/bindings/zig/README.md +++ b/bindings/zig/README.md @@ -21,7 +21,7 @@ zig build libopendal_c zig build test --summary all ``` -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/core/README.md b/core/README.md index 208a82e2dd61..207f0e44b220 100644 --- a/core/README.md +++ b/core/README.md @@ -159,7 +159,7 @@ The examples are available at [here](../examples/rust). Check out the [CONTRIBUTING](CONTRIBUTING.md) guide for more details on getting started with contributing to this project. -## Trademarks & Licenses +## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0