From bc0a0d79164b469b256e641fd02dd231a1ba74a2 Mon Sep 17 00:00:00 2001 From: zaki Date: Tue, 8 Apr 2025 18:07:00 +0800 Subject: [PATCH] docs: Add architecture diagram --- .license-ignore | 1 + README.md | 6 +++++- CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 docs/img/Architecture.svg | 2 ++ 4 files changed, 8 insertions(+), 1 deletion(-) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) create mode 100644 docs/img/Architecture.svg diff --git a/.license-ignore b/.license-ignore index 8d84962..f8980ab 100644 --- a/.license-ignore +++ b/.license-ignore @@ -18,3 +18,4 @@ requirements-dev.txt .github .gitignore .license-ignore +docs \ No newline at end of file diff --git a/README.md b/README.md index 26e901c..1639f04 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ Visit [the official website](https://dubbo.apache.org/) for more information. > **Disclaimer:** This project is in the early stages of development. Features are subject to change, and some components may not be fully stable. Contributions and feedback are welcome as the project evolves. + +## Architecture +Architecture + ## Features - **Service Discovery**: Zookeeper @@ -123,7 +127,7 @@ It's as simple as the code snippet below. With just a few lines of code, you can We are excited to welcome contributions to the Dubbo-Python project! Whether you are fixing bugs, adding new features, or improving documentation, your input is highly valued. -To ensure a smooth collaboration, please review our [Contributing Guide](https://github.com/apache/dubbo-python/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started, adhere to coding standards, and submit your contributions effectively. +To ensure a smooth collaboration, please review our [Contributing Guide](./docs/CONTRIBUTING.md) for detailed instructions on how to get started, adhere to coding standards, and submit your contributions effectively. ## License diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/docs/img/Architecture.svg b/docs/img/Architecture.svg new file mode 100644 index 0000000..dcb710a --- /dev/null +++ b/docs/img/Architecture.svg @@ -0,0 +1,2 @@ +ClientServerunarystreaming......ServiceDiscoveryLoadBalanceLogging......Triple (fully gRPC compatible)......BytesProtobufJsonCustomizableAsynciouvloopTCPHTTP2......Zookeeper......RandomCPU......logging(built-in)RegistryLoadBalanceLoggingAPIServiceGovernanceRPCProtocolSerializationtransport \ No newline at end of file