diff --git a/docs/README.md b/docs/README.md index d1b9d306e2c2a3e5808048d1779e6492a2e1a1ce..717760f6885e8724cf06b288e1aa5a627bccc94d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,35 +2,57 @@ 从实操的角度整理翻译`Spring`相关文档,包括`快速开始`、`安装指南`、`开发工具配置`、`代码案例`等。 -## 内容大纲 +## 内容大纲及贡献者 + +| 内容大纲 | 校对者 | +| ------ | ------ | +| [为什么是Spring](https://dev-cloud.gitcode.host/spring/why-spring.html) | 冯丙见 | +| [Spring Boot 介绍](https://dev-cloud.gitcode.host/spring/introducing-spring-boot.html) | 冯丙见 | +| [Spring 快速入门指南](https://dev-cloud.gitcode.host/spring/quickstart.html) | 冯丙见 | +| [安装系统要求](https://dev-cloud.gitcode.host/spring/system-requirements.html) | 崔志康 | +| [安装Spring Boot](https://dev-cloud.gitcode.host/spring/installing.html) | 崔志康 | +| [安装脚手架](https://dev-cloud.gitcode.host/spring/initializr.html) | 王晗 | +| [在 VS Code 中开始使用 Java](https://dev-cloud.gitcode.host/spring/vscode_java.html) | 王晗 | +| [使用 IntelliJ IDEA 编写入门指南](https://dev-cloud.gitcode.host/spring/intellij_idea.html) | 王捷 | +| [开发你的第一个 Spring Boot 应用程序](https://dev-cloud.gitcode.host/spring/getting-started_first-application.html) | 王捷 | +| [构建 RESTful Web 服务](https://dev-cloud.gitcode.host/spring/rest-service.html#%E4%BD%A0%E5%B0%86%E5%BB%BA%E9%80%A0%E4%BB%80%E4%B9%88) | 王晗 | +| [使用 RESTful Web 服务](https://dev-cloud.gitcode.host/spring/consuming-rest.html#%E4%BD%A0%E5%B0%86%E5%BB%BA%E9%80%A0%E4%BB%80%E4%B9%88) | 王捷 | + +## 参与贡献流程 -- 概述 -- 快速开始 -- 系统要求 -- 安装指南 -- 脚手架 -- VSCode -- IntelliJ IDEA -- 开发你的第一个 Spring Boot 应用程序 -- 构建 RESTful Web 服务 -- 使用 RESTful Web 服务 +所有 **`Java Spring 熟练使用者`** 可以参与到`Spring 中文文档社区`的建设中来,选择自己感兴趣题目,可以直接撰写文章,也可以翻译 [Spring 官方](https://spring.io/) 上面的内容,也可以校对别人翻译的文章。具体贡献流程如下。 +![](readme/readme-1.png) -## 参与贡献 +### 1. 阅读文档帮助改善 -所有 **`Java Spring 熟练使用者`** 可以参与到`Spring 中文文档社区`的建设中来,选择自己感兴趣题目,可以直接撰写文章,也可以翻译 [Spring 官方](https://spring.io/) 上面的内容,也可以校对别人翻译的文章。具体贡献流程如下。 +在[`Spring 中文文档社区`](https://dev-cloud.gitcode.host/spring)上浏览某一篇文档时,发现有不准确的地方,可以`随时`在该页面的左下方点击`在 GitCode 上编辑此页`。 +![](readme/readme-2.png) + +### 2. 在 GitCode 校对/创作 + +进入GitCode之后,会自动定位到你想要修改的文件,修改文件内容。 + +#### 2-1. 仓库的成员 + +如果是仓库的成员,点击`“编辑”按钮,会直接进入可编辑的状态,供你修改文件内容。 + +![](readme/readme-3.png) + +![](readme/readme-4.png) -![](https://gitcode.net/zkxw2008/my-material/-/raw/master/spring/readme-1.png) +#### 2-2. 非仓库的成员 -1、Fork[此仓库](https://gitcode.net/dev-cloud/spring)到自己的[GitCode](https://gitcode.net/)账户下。 +如果是非仓库的成员,点击`“编辑”`,GitCode 会提醒你没有权限编辑,可以点击`Fork`按钮,将该项目克隆到你的 GitCode 账户下。 -2、查看[Issue](https://gitcode.net/dev-cloud/spring/-/issues) 确定自己需要完成的题目。 +![](readme/readme-5.png) -3、对于已有中文的文档内容文件,可以执行校对。 -4、对于暂时无中文文档内容的,可以直接贡献(翻译/撰写)原创中文文档。 +### 3. 内容编辑完成提交PR -5、内容完成者向[此仓库](https://gitcode.net/dev-cloud/spring)提交 PR(Pull Request)。 +内容编辑完成者向[此仓库](https://gitcode.net/dev-cloud/spring)提交 PR(Pull Request)。 -6、[此仓库](https://gitcode.net/dev-cloud/spring)审核人员审核通过,符合要求的,即会 Merge 到[此仓库](https://gitcode.net/dev-cloud/spring)中。 +### 4. 审核 +[主仓库](https://gitcode.net/dev-cloud/spring) 管理者会 Review,符合要求的,即会 Merge 到[主仓库](https://gitcode.net/dev-cloud/spring)中。 -7、被 Merged 的 PR,会得到 200 ~ 500元不等的奖励。 +### 5. 查看更新 +Merge 成功之后,稍等片刻就可以刷新页面查看更新。 \ No newline at end of file diff --git a/docs/en/readme/readme-1.png b/docs/en/readme/readme-1.png new file mode 100644 index 0000000000000000000000000000000000000000..e3dec2b802776dbefd4fb5833815c7c4fafe77a2 Binary files /dev/null and b/docs/en/readme/readme-1.png differ diff --git a/docs/readme/readme-1.png b/docs/readme/readme-1.png new file mode 100644 index 0000000000000000000000000000000000000000..e3dec2b802776dbefd4fb5833815c7c4fafe77a2 Binary files /dev/null and b/docs/readme/readme-1.png differ diff --git a/docs/readme/readme-2.png b/docs/readme/readme-2.png new file mode 100644 index 0000000000000000000000000000000000000000..3d854fd894eed22ac3440ef5da850f672f7a58e5 Binary files /dev/null and b/docs/readme/readme-2.png differ diff --git a/docs/readme/readme-3.png b/docs/readme/readme-3.png new file mode 100644 index 0000000000000000000000000000000000000000..14acdf6db343c6725c8c3c119810013814671aa7 Binary files /dev/null and b/docs/readme/readme-3.png differ diff --git a/docs/readme/readme-4.png b/docs/readme/readme-4.png new file mode 100644 index 0000000000000000000000000000000000000000..b6a370a9f98fe2331cd62a54286b718ebf7513cd Binary files /dev/null and b/docs/readme/readme-4.png differ diff --git a/docs/readme/readme-5.png b/docs/readme/readme-5.png new file mode 100644 index 0000000000000000000000000000000000000000..bc98671d5b0069225c279474abf5d1781df24e4e Binary files /dev/null and b/docs/readme/readme-5.png differ