diff --git a/README.md b/README.md deleted file mode 120000 index 0e01b4308c1424d861f0af570038bfd5209c0691..0000000000000000000000000000000000000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ce37d5f9d07aa59de3e6d2c0401f88d5dbb3a57b --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# Spring 中文文档社区 + +从实操的角度整理翻译`Spring`相关文档,包括`快速开始`、`安装指南`、`开发工具配置`、`代码案例`等。 + +## 声明 +本站中的文章内容来源于 [Spring.io](https://spring.io/),原始版权归属于 [Spring.io](https://spring.io/)。本站对相关文章进行了翻译及整理。本站文章可供个人学习、研究或者欣赏之用,未经本站事先书面许可,不得进行任何转载、商用或与之相关的行为。 +商标声明:Spring 是 Pivotal Software, Inc. 在美国以及其他国家的商标。 + +## 文档列表 + +- [Spring](/why-spring.html) +- [Spring Boot](/spring-boot/legal.html) +- [Spring Framework](/spring-framework/overview.html) +- [Spring Data](/spring-data/spring-data.html) +- [Spring Cloud](/spring-cloud/legal.html) +- [Spring Cloud Data Flow](/spring-cloud-data-flow/spring-cloud-dataflow.html) +- [Spring Security](/spring-security/overview.html) +- [Spring for GraphQL](/spring-for-graphql/spring-graphql.html) +- [Spring Session](/spring-session/_index.html) +- [Spring Integration](/spring-integration/preface.html) +- [Spring HATEOAS](/spring-hateoas/spring-hateoas.html) +- [Spring REST Docs](/spring-rest-docs/spring-restdocs.html) +- [Spring Batch](/spring-batch/spring-batch-intro.html) +- [Spring AMQP](/spring-amqp/spring-amqp.html) +- [Spring CredHub](/spring-credhub/spring-credhub.html) +- [Spring Flo](/spring-flo/spring-flo.html) +- [Spring for Apache Kafka](/spring-for-apache-kafka/spring-kafka.html) +- [Spring LDAP](/spring-ldap/spring-ldap.html) +- [Spring Shell](/spring-shell/spring-shell.html) +- [Spring Statemachine](/spring-statemachine/spring-statemachine.html) +- [Spring Vault](/spring-vault/spring-vault.html) +- [Spring Web Flow](/spring-web-flow/preface.html) +- [Spring Web Services](/spring-web-services/spring-web-service.html) + + +## 参与贡献流程 + +所有 **`Java Spring 熟练使用者`** 可以参与到`Spring 中文文档社区`的建设中来,选择自己感兴趣题目,可以直接撰写文章,也可以翻译 [Spring 官方](https://spring.io/) 上面的内容,也可以校对别人翻译的文章。具体贡献流程如下。 +![](./readme/readme-1.png) + +### 1. 阅读文档帮助改善 + +在[`Spring 中文文档社区`](https://spring.gitcode.net)上浏览某一篇文档时,发现有不准确的地方,可以`随时`在该页面的左下方点击`在 GitCode 上编辑此页`。 +![](./readme/readme-2.png) + +### 2. 在 GitCode 校对/创作 + +进入GitCode之后,会自动定位到你想要修改的文件,修改文件内容。 + +#### 2-1. 仓库的成员 + +如果是仓库的成员,点击`“编辑”按钮,会直接进入可编辑的状态,供你修改文件内容。 + +![](./readme/readme-3.png) + +![](./readme/readme-4.png) + +#### 2-2. 非仓库的成员 + +如果是非仓库的成员,点击`“编辑”`,GitCode 会提醒你没有权限编辑,可以点击`Fork`按钮,将该项目克隆到你的 GitCode 账户下。 + +![](./readme/readme-5.png) + + +### 3. 内容编辑完成提交PR + +内容编辑完成者向[此仓库](https://gitcode.net/dev-cloud/spring-docs)提交 PR(Pull Request)。 + +### 4. 审核 +[主仓库](https://gitcode.net/dev-cloud/spring-docs) 管理者会 Review,符合要求的,即会 Merge 到[主仓库](https://gitcode.net/dev-cloud/spring-docs)中。 + +### 5. 查看更新 +Merge 成功之后,稍等片刻就可以刷新页面查看更新。 diff --git a/readme b/readme deleted file mode 120000 index 67e397d81841ff0d0adfa82327ef106b85645742..0000000000000000000000000000000000000000 --- a/readme +++ /dev/null @@ -1 +0,0 @@ -docs/readme \ No newline at end of file diff --git a/readme/readme-1.png b/readme/readme-1.png new file mode 100644 index 0000000000000000000000000000000000000000..e3dec2b802776dbefd4fb5833815c7c4fafe77a2 Binary files /dev/null and b/readme/readme-1.png differ diff --git a/readme/readme-2.png b/readme/readme-2.png new file mode 100644 index 0000000000000000000000000000000000000000..3d854fd894eed22ac3440ef5da850f672f7a58e5 Binary files /dev/null and b/readme/readme-2.png differ diff --git a/readme/readme-3.png b/readme/readme-3.png new file mode 100644 index 0000000000000000000000000000000000000000..14acdf6db343c6725c8c3c119810013814671aa7 Binary files /dev/null and b/readme/readme-3.png differ diff --git a/readme/readme-4.png b/readme/readme-4.png new file mode 100644 index 0000000000000000000000000000000000000000..b6a370a9f98fe2331cd62a54286b718ebf7513cd Binary files /dev/null and b/readme/readme-4.png differ diff --git a/readme/readme-5.png b/readme/readme-5.png new file mode 100644 index 0000000000000000000000000000000000000000..bc98671d5b0069225c279474abf5d1781df24e4e Binary files /dev/null and b/readme/readme-5.png differ