diff --git a/README-EN.md b/README-EN.md index 4af9f123c..e05c4e404 100644 --- a/README-EN.md +++ b/README-EN.md @@ -1,12 +1,11 @@ #
📌 TransmittableThreadLocal(TTL)
+> [!IMPORTANT] > 🚧 This branch is `TransmittableThreadLocal(TTL) v3`, which is in development and has not been released yet. > See [issue 432](https://github.com/alibaba/transmittable-thread-local/issues/432) for the `v3` notes, work item list and its progress. > > 👉 The stable version `v2.x` currently in use is on [**branch `2.x`**](https://github.com/alibaba/transmittable-thread-local/tree/2.x). ----------------------------------------- -

Fast CI Strong CI @@ -14,10 +13,10 @@ JDK support License Javadocs -Maven Central +Maven Central GitHub release -GitHub Stars -GitHub Forks +GitHub Stars +GitHub Forks user repos GitHub issues GitHub Contributors @@ -66,8 +65,9 @@ Application need transmit value from the time task is created to the time task i If you have problem or question, please [submit Issue](https://github.com/alibaba/transmittable-thread-local/issues) or play [fork](https://github.com/alibaba/transmittable-thread-local/fork) and pull request dance. -> From `TTL v2.13+` upgrade to `Java 8`. -> If you need `Java 6` support, use version `2.12.x` Maven Central +> [!NOTE] +> From `TTL v2.13+` upgrade to `Java 8`. 🚀 +> If you need `Java 6` support, use version `2.12.x` Maven Central # 🎨 Requirements @@ -292,6 +292,7 @@ to start demo of "Use Java Agent to decorate thread pool implementation class". The implementation of auto adding self agent jar to `boot classpath` use the `Boot-Class-Path` property of manifest file(`META-INF/MANIFEST.MF`) in the TTL Java Agent Jar: +> [!NOTE] > `Boot-Class-Path` > > A list of paths to be searched by the bootstrap class loader. Paths represent directories or libraries (commonly referred to as JAR or zip libraries on many platforms). @@ -317,7 +318,7 @@ The current version Java API documentation: ``` -Check available version at [search.maven.org](https://search.maven.org/artifact/com.alibaba/transmittable-thread-local). +Check available version at [maven.org](https://repo1.maven.org/maven2/com/alibaba/transmittable-thread-local/maven-metadata.xml). # 🔨 How to compile and build diff --git a/README.md b/README.md index d5d4d670b..4844989a2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ #

📌 TransmittableThreadLocal(TTL)
+> [!IMPORTANT] > 🚧 这个分支是`TransmittableThreadLocal(TTL) v3`,在开发中还没有发布。 > `v3`的版本说明、工作项列表及其进展,参见 [issue 432](https://github.com/alibaba/transmittable-thread-local/issues/432)。 > > 👉 目前使用中的稳定发布版本`v2.x`在 [**分支`2.x`**](https://github.com/alibaba/transmittable-thread-local/tree/2.x)上。 ----------------------------------------- -

Fast CI Strong CI @@ -14,10 +13,10 @@ JDK support License Javadocs -Maven Central +Maven Central GitHub release -GitHub Stars -GitHub Forks +GitHub Stars +GitHub Forks user repos GitHub issues GitHub Contributors @@ -73,8 +72,9 @@ - 建议和提问,[提交 Issue](https://github.com/alibaba/transmittable-thread-local/issues/new) - 贡献和改进,[Fork 后提通过 Pull Request 贡献代码](https://github.com/alibaba/transmittable-thread-local/fork) -> 从`TTL v2.13+`开始,升级到`Java 8`。 -> 如果需要`Java 6`的支持,使用版本`2.12.x` Maven Central +> [!NOTE] +> 从`TTL v2.13+`开始,升级到`Java 8`。🚀 +> 如果需要`Java 6`的支持,使用版本`2.12.x` Maven Central # 🎨 需求场景 @@ -389,7 +389,7 @@ These paths are searched by the bootstrap class loader after the platform specif ``` -可以在 [search.maven.org](https://search.maven.org/artifact/com.alibaba/transmittable-thread-local) 查看可用的版本。 +可以在 [maven.org](https://repo1.maven.org/maven2/com/alibaba/transmittable-thread-local/maven-metadata.xml) 查看可用的版本。 # 🔨 关于编译构建 @@ -437,7 +437,8 @@ JDK Bug: # ✨ 使用`TTL`的好处与必要性 -> 注:不读这一节,并不会影响你使用`TTL`来解决你碰到的问题,可以放心跳过;读了 [User Guide](#-user-guide) 就可以快速用起来了~ 😄 这一节信息密度较高不易读。 +> [!NOTE] +> 不读这一节,并不会影响你使用`TTL`来解决你碰到的问题,可以放心跳过;读了 [User Guide](#-user-guide) 就可以快速用起来了~ 😄 这一节信息密度较高不易读。 **_好处:透明且自动完成所有异步执行上下文的可定制、规范化的捕捉与传递。_** 这个好处也是`TransmittableThreadLocal`的目标。 diff --git a/docs/requirement-scenario.md b/docs/requirement-scenario.md index 700c81a05..2d8cab05c 100644 --- a/docs/requirement-scenario.md +++ b/docs/requirement-scenario.md @@ -56,7 +56,7 @@ PS: 多谢 [@wyzssw](https://github.com/https://github.com/wyzssw) 对分布 ``` -可以在 [search.maven.org](https://search.maven.org/artifact/com.alibaba/log4j2-ttl-thread-context-map) 查看可用的版本。 +可以在 [maven.org](https://repo1.maven.org/maven2/com/alibaba/log4j2-ttl-thread-context-map/maven-metadata.xml) 查看可用的版本。 PS: 多谢 @bwzhang2011 和 @wuwen5 对日志场景说明交流和实现上讨论建议: @@ -75,7 +75,7 @@ PS: 多谢 @bwzhang2011 和 @wuwen5 对日志场景说明交流和实现上讨 ``` -可以在 [search.maven.org](https://search.maven.org/artifact/com.ofpay/logback-mdc-ttl) 查看可用的版本。 +可以在 [maven.org](https://repo1.maven.org/maven2/com/ofpay/logback-mdc-ttl/maven-metadata.xml) 查看可用的版本。 这个集成已经在 **_线上产品环境_** 使用的。说明详见[欧飞网的使用场景](https://github.com/alibaba/transmittable-thread-local/issues/73#issuecomment-300665308)。