|
| 1 | +# Microsphere Spring Cloud — Documentation |
| 2 | + |
| 3 | +[中文版 →](./zh/README.md) |
| 4 | + |
| 5 | +This documentation set covers the `release` and `release-1.x` branches of |
| 6 | +[microsphere-spring-cloud](https://github.com/microsphere-projects/microsphere-spring-cloud). |
| 7 | +English is the default language; Chinese documents are stored in parallel `zh/` directories with identical file names. |
| 8 | + |
| 9 | +## Structure |
| 10 | + |
| 11 | +``` |
| 12 | +docs/ |
| 13 | +├── README.md ← you are here (English index) |
| 14 | +├── zh/README.md ← 中文总索引 |
| 15 | +├── user-guide/ ← User Guide (English, default) |
| 16 | +│ ├── README.md ← User Guide index |
| 17 | +│ ├── zh/ ← 用户文档（中文） |
| 18 | +│ ├── current/ ← release branch (0.2.x) — one document per Maven module |
| 19 | +│ │ ├── parent.md dependencies.md commons.md openfeign.md |
| 20 | +│ │ └── zh/ (identical file names, Chinese) |
| 21 | +│ └── 1.x/ ← release-1.x branch (0.1.x) |
| 22 | +│ ├── parent.md dependencies.md commons.md openfeign.md |
| 23 | +│ └── zh/ (Chinese mirrors) |
| 24 | +└── developer-guide/ ← Developer Guide (English, default) |
| 25 | + ├── README.md ← Developer Guide index |
| 26 | + ├── zh/ ← 开发者文档（中文） |
| 27 | + ├── current/ ← release branch architecture & source analysis |
| 28 | + │ ├── parent.md dependencies.md commons.md openfeign.md |
| 29 | + │ └── zh/ (Chinese mirrors) |
| 30 | + └── 1.x/ ← release-1.x branch |
| 31 | + ├── parent.md dependencies.md commons.md openfeign.md |
| 32 | + └── zh/ (Chinese mirrors) |
| 33 | +``` |
| 34 | + |
| 35 | +## Start Here |
| 36 | + |
| 37 | +| I am… | Go to | |
| 38 | +|---|---| |
| 39 | +| Using this library in a Spring Boot 3/4 application | [User Guide → current](./user-guide/current/commons.md) | |
| 40 | +| Using this library in a Spring Boot 2.x / Java 8 application | [User Guide → 1.x](./user-guide/1.x/commons.md) | |
| 41 | +| Contributing to the project or studying its design | [Developer Guide](./developer-guide/README.md) | |
| 42 | +| 在中文环境下使用本项目 | [用户文档（中文）](./user-guide/zh/README.md) · [开发者文档（中文）](./developer-guide/zh/README.md) | |
| 43 | + |
| 44 | +- [User Guide](./user-guide/README.md) — APIs, configuration properties, runnable examples (derived from the modules' own test cases), version information and compatibility ranges. |
| 45 | +- [Developer Guide](./developer-guide/README.md) — architecture design, source-level analysis, design patterns, mermaid flow/sequence diagrams, module dependency graphs, build & test guidance. |
| 46 | + |
| 47 | +## Branches and Version Lines / Branch–Directory Mapping |
| 48 | + |
| 49 | +| Git branch | Version line | Docs directory | Java | Spring Boot | Spring Cloud | Latest release | |
| 50 | +|---|---|---|---|---|---|---| |
| 51 | +| `release` | 0.2.x | [`current`](./user-guide/current/commons.md) | 17+ | 3.0.x – 4.0.x | 2022.0.x – 2025.1.x | `0.2.26` | |
| 52 | +| `release-1.x` | 0.1.x | [`1.x`](./user-guide/1.x/commons.md) | 8+ | 2.3.x – 2.6.x | Hoxton.SR12 – 2021.0.x | `0.1.26` | |
| 53 | + |
| 54 | +Both lines are published to Maven Central under groupId `io.github.microsphere-projects`. |
| 55 | +`main`/`dev` are working branches and are intentionally **not** documented. |
| 56 | + |
| 57 | +## Maven Module Dependency Overview |
| 58 | + |
| 59 | +```mermaid |
| 60 | +graph TD |
| 61 | + subgraph "microsphere-spring-cloud (aggregator pom)" |
| 62 | + ROOT[pom.xml<br/>revision 0.2.27-SNAPSHOT] |
| 63 | + PARENT[microsphere-spring-cloud-parent<br/>parent pom + Spring Cloud profiles] |
| 64 | + DEPS[microsphere-spring-cloud-dependencies<br/>BOM pom] |
| 65 | + COMMONS[microsphere-spring-cloud-commons<br/>jar] |
| 66 | + OPENFEIGN[microsphere-spring-cloud-openfeign<br/>jar] |
| 67 | + end |
| 68 | +
|
| 69 | + BUILD[microsphere-build<br/>upstream build parent] --> ROOT |
| 70 | + ROOT --> PARENT |
| 71 | + ROOT --> DEPS |
| 72 | + ROOT --> COMMONS |
| 73 | + ROOT --> OPENFEIGN |
| 74 | + PARENT --> DEPS |
| 75 | + PARENT --> COMMONS |
| 76 | + PARENT --> OPENFEIGN |
| 77 | + MSBOOT[microsphere-spring-boot<br/>core/webmvc/webflux/actuator] --> COMMONS |
| 78 | + SB[spring-boot-dependencies] --> PARENT |
| 79 | + SC[spring-cloud-dependencies] --> PARENT |
| 80 | + SCA[spring-cloud-alibaba-dependencies] --> PARENT |
| 81 | + COMMONS --> OPENFEIGN |
| 82 | + SCOF[spring-cloud-starter-openfeign<br/>optional] -.-> OPENFEIGN |
| 83 | +``` |
| 84 | + |
| 85 | +The [Developer Guide index](./developer-guide/README.md) explains this graph in detail. |
0 commit comments