From ea6eee62880d49797bc3601115a62b2e78e84491 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=90=BE=E7=AB=8B?= Date: Wed, 24 Apr 2024 08:47:47 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(docs):?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 4 ++-- README.md | 35 ++++++++++++++++++----------------- script/docker-buildx.md | 6 +++--- typography-specification.md | 16 ++++++++-------- web-vue/README.md | 2 +- 5 files changed, 32 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 863bcb5469..27aa53916a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1228,7 +1228,7 @@ curl -LfsSo Service.sh https://gitee.com/dromara/Jpom/raw/master/modules/agent/s **如果需要使用 mysql 存储，则需要修改配置** 1. 修改 `jpom.db.mode` 为 `MYSQL` -2. 修改 `jpom.db.url` 为你 mysql 的 jdbc 地址( jdbc:mysql://127.0.0.1: +2. 修改 `jpom.db.url` 为您 mysql 的 jdbc 地址( jdbc:mysql://127.0.0.1: 3306/jpom?useUnicode=true&characterEncoding=UTF-8&useSSL=false) 3. 修改 `jpom.db.user-name` 为对应 mysql 账户 4. 修改 `jpom.db.user-pwd` 为对应 mysql 密码 @@ -1265,7 +1265,7 @@ bash ./bin/Server.sh restart -15 --h2-migrate-mysql --h2-user=jpom --h2-pass=jpo 如果需要使用 mysql 存储，则需要修改配置： 1. 修改 `jpom.db.mode` 为 `MYSQL` -2. 修改 `jpom.db.url` 为你 mysql 的 jdbc 地址( jdbc:mysql://127.0.0.1: +2. 修改 `jpom.db.url` 为您 mysql 的 jdbc 地址( jdbc:mysql://127.0.0.1: 3306/jpom?useUnicode=true&characterEncoding=UTF-8&useSSL=false) 3. 修改 `jpom.db.user-name` 为对应 mysql 账户 4. 修改 `jpom.db.user-pwd` 为对应 mysql 密码 diff --git a/README.md b/README.md index 88b4cd59d4..f8adf40a84 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ > 如果是分布式的项目，以上步骤则更加繁琐。 > -> 让 Jpom 来帮你解决这些痛点吧！然而，这些只是 Jpom 解决的最基础的功能。 +> 让 Jpom 来帮您解决这些痛点吧！然而，这些只是 Jpom 解决的最基础的功能。 ### 😁 使用 [Jpom](https://gitee.com/dromara/Jpom) 后 @@ -142,7 +142,7 @@ bash install.sh Server jdk ``` 启动成功后，服务端的端口为 `2122`，可通过 `http://127.0.0.1:2122/` -访问管理页面（如果不是本机访问，需要把 127.0.0.1 换成你安装的服务器 IP 地址）。 +访问管理页面（如果不是本机访问，需要把 127.0.0.1 换成您安装的服务器 IP 地址）。 > 如无法访问管理系统，执行命令 `systemctl status firewalld` 检查下是否开启了防火墙 > ，如状态栏看到绿色显示 `Active: active (running)` 需要放行 `2122` 端口。 @@ -154,7 +154,7 @@ bash install.sh Server jdk >firewall-cmd --reload >``` > ->如果在操作系统上放行了端口仍无法访问，并且你使用的是云服务器，请到云服务器后台中检查安全组规则是否放行 2122 端口。 +>如果在操作系统上放行了端口仍无法访问，并且您使用的是云服务器，请到云服务器后台中检查安全组规则是否放行 2122 端口。 > >⚠️ 注意： Linux 系统中有多种防火墙：Firewall、Iptables、SELinux 等，再检查防火墙配置时候需要都检查一下。 @@ -249,7 +249,7 @@ docker run -d -p 2122:2122 \ 1. server-x.x.x-release 目录为服务端的全部安装文件 2. 上传到对应服务器（整个目录） 3. 启动服务端，Windows 环境用 bat 脚本，Linux 环境用 sh 脚本。（如果出现乱码或者无法正常执行，请检查编码格式、换行符是否匹配。） - 4. 服务端默认运行端口：`2122`，访问管理页面：`http://127.0.0.1:2122/`（非本机访问把 127.0.0.1 换成你的服务器 IP 地址） + 4. 服务端默认运行端口：`2122`，访问管理页面：`http://127.0.0.1:2122/`（非本机访问把 127.0.0.1 换成您的服务器 IP 地址） ### 方式四：⌨️ 编译安装 @@ -266,7 +266,7 @@ docker run -d -p 2122:2122 \ 1. 查看插件端安装包 modules/server/target/server-x.x.x-release 2. 打包上传服务器运行（整个目录） 3. 启动服务端，Windows 环境用 bat 脚本，Linux 环境用 sh 脚本。（如果出现乱码或者无法正常执行，请检查编码格式、换行符是否匹配。） - 4. 服务端默认运行端口：`2122`，访问管理页面：`http://127.0.0.1:2122/`（非本机访问把 127.0.0.1 换成你的服务器 IP 地址） + 4. 服务端默认运行端口：`2122`，访问管理页面：`http://127.0.0.1:2122/`（非本机访问把 127.0.0.1 换成您的服务器 IP 地址） > 也可以使用 `script/release.bat` 或 `script/release.sh` 快速打包。 @@ -302,7 +302,7 @@ docker-compose -f docker-compose.yml up 4. 构建 vue 页面，切换到 `web-vue` 目录（前提需要本地开发环境有 node、npm 环境） 5. 安装项目 vue 依赖，控制台执行 `npm install` 6. 启动开发模式，控制台执行 `npm run dev` -7. 根据控制台输出的地址访问前端页面：`http://127.0.0.1:3000/`（非本机访问把 127.0.0.1 换成你的服务器 IP 地址） +7. 根据控制台输出的地址访问前端页面：`http://127.0.0.1:3000/`（非本机访问把 127.0.0.1 换成您的服务器 IP 地址） ## 管理 Jpom 命令 @@ -425,7 +425,7 @@ mvn -f xxxx/pom.xml clean package ## 🐞 交流讨论 、反馈 BUG、提出建议等 1. 快扫描下方左侧微信群二维码和我们一起交流讨论吧！（添加小助手：备注 Jpom 进群） -2. 开源项目离不开社区的支持，如果项目帮助到了你，并且想给我们加个餐。 +2. 开源项目离不开社区的支持，如果项目帮助到了您，并且想给我们加个餐。 欢迎扫描下方[微信、支付宝收款码赞赏](https://jpom.top/images/qrcode/praise-all.png) 或通过[码云赞赏](https://gitee.com/dromara/Jpom) （在项目首页下方点击捐赠，支持微信和支付宝）。[赞赏记录](https://jpom.top/pages/praise/publicity/) @@ -434,9 +434,10 @@ mvn -f xxxx/pom.xml clean package 5. 反馈 BUG、提出建议，欢迎新建：[issues](https://gitee.com/dromara/Jpom/issues)，开发人员会不定时查看回复。 6. 参与贡献，请查看[贡献指南](#贡献指南)。 -感谢所有赞赏以及参与贡献的小伙伴，你们的支持是我们不断更新前进的动力！ - -![wx-qrcode-praise.png](https://jpom.top/images/qrcode/praise-all.png) +感谢所有赞赏以及参与贡献的小伙伴，您们的支持是我们不断更新前进的动力！ +

+praise img +

## 💖 周边商品 @@ -445,7 +446,7 @@ mvn -f xxxx/pom.xml clean package 购买支持我们这样您既获得了一份小商品我们也获得了您购买商品的利润（周边商品的价格会比市场价稍高，介意请勿下单）

-shop home +shop home

## 🔨贡献指南 @@ -454,9 +455,9 @@ mvn -f xxxx/pom.xml clean package ### 贡献须知 -Jpom 作为开源项目，离不开社区的支持，欢迎任何人修改和提出建议。贡献无论大小，你的贡献会帮助背后成千上万的使用者以及开发者，你做出的贡献也会永远的保留在项目的贡献者名单中，这也是开源项目的意义所在！ +Jpom 作为开源项目，离不开社区的支持，欢迎任何人修改和提出建议。贡献无论大小，您的贡献会帮助背后成千上万的使用者以及开发者，您做出的贡献也会永远的保留在项目的贡献者名单中，这也是开源项目的意义所在！ -为了保证项目代码的质量与规范，以及帮助你更快的了解项目的结构，请在贡献之前阅读： +为了保证项目代码的质量与规范，以及帮助您更快的了解项目的结构，请在贡献之前阅读： - [Jpom 贡献说明](https://gitee.com/dromara/Jpom/blob/master/CODE_OF_CONDUCT.md) - [中英文排版规范](https://gitee.com/dromara/Jpom/blob/dev/typography-specification.md) @@ -465,7 +466,7 @@ Jpom 作为开源项目，离不开社区的支持，欢迎任何人修改和提 1. Fork 本仓库。 -2. Fork 后会在你的帐号下多了一个和本仓库一模一样的仓库，把你帐号的仓库 clone 到本地。 +2. Fork 后会在您的账号下多了一个和本仓库一模一样的仓库，把您账号的仓库 clone 到本地。 注意替换掉链接中的`分支名`和`用户名`。 @@ -480,13 +481,13 @@ Jpom 作为开源项目，离不开社区的支持，欢迎任何人修改和提 ```bash # 把修改的文件添加到暂存区 git add . - # 提交到本地仓库，说明你具体做了什么修改 - git commit -m '填写你做了什么修改' + # 提交到本地仓库，说明您具体做了什么修改 + git commit -m '填写您做了什么修改' # 推送到远程仓库，分支名替换成 dev 或者 docs git push origin 分支名 ``` -4. 登录你的仓库，然后会看到一条 PR 请求，点击请求合并，等待管理员把你的代码合并进来。 +4. 登录您的仓库，然后会看到一条 PR 请求，点击请求合并，等待管理员把您的代码合并进来。 ### 项目分支说明 diff --git a/script/docker-buildx.md b/script/docker-buildx.md index 118ffcd6af..9dd293499e 100644 --- a/script/docker-buildx.md +++ b/script/docker-buildx.md @@ -19,15 +19,15 @@ ## 2 启用 binfmt_misc -如果你使用的是 Docker 桌面版（MacOS 和 Windows），默认已经启用了 binfmt_misc，可以跳过这一步。 +如果您使用的是 Docker 桌面版（MacOS 和 Windows），默认已经启用了 binfmt_misc，可以跳过这一步。 -如果你使用的是 Linux，需要手动启用 binfmt_misc。大多数 Linux 发行版都很容易启用，不过还有一个更容易的办法，直接运行一个特权容器，容器里面写好了设置脚本： +如果您使用的是 Linux，需要手动启用 binfmt_misc。大多数 Linux 发行版都很容易启用，不过还有一个更容易的办法，直接运行一个特权容器，容器里面写好了设置脚本： ```shell docker run --rm --privileged docker/binfmt:a7996909642ee92942dcd6cff44b9b95f08dad64 ``` -建议将 Linux 内核版本升级到 4.x 以上，特别是 CentOS 用户，你可能会遇到错误。 +建议将 Linux 内核版本升级到 4.x 以上，特别是 CentOS 用户，您可能会遇到错误。 在软件依赖中我们提到需要 Linux 内核版本>= 4.8.0；如果在内核版本为3.10.0的系统（比如 CentOS）上运行 docker/binfmt，会出现报错 Cannot write to /proc/sys/fs/binfmt_misc/register: write /proc/sys/fs/binfmt_misc/register: invalid diff --git a/typography-specification.md b/typography-specification.md index 148ccef10b..9d61797cbe 100644 --- a/typography-specification.md +++ b/typography-specification.md @@ -20,7 +20,7 @@ 以下例子均为**正例**，下面列出经常用错的大小写单词。 -在使用的时候，如果你不确定单词正确的拼写，请前往官网查看。 +在使用的时候，如果您不确定单词正确的拼写，请前往官网查看。 - [Java](https://www.oracle.com/java/technologies/downloads/) - [JDK](https://www.oracle.com/java/technologies/downloads/) @@ -85,7 +85,7 @@ ## 参考例子 -下面的例子可以帮助你进一步理解对应的规范，以及为什么要有这样的规范，大公司的网站是怎么用到的。 +下面的例子可以帮助您进一步理解对应的规范，以及为什么要有这样的规范，大公司的网站是怎么用到的。 ### 空格的使用 @@ -206,18 +206,18 @@ The Omnibus GitLab package requires about 2.5GB of storage space for installatio 正例： ``` -如果你是来自 React 的开发者，你可能会对 Vuex 和 [Redux](https://github.com/reactjs/redux) 间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 +如果您是来自 React 的开发者，您可能会对 Vuex 和 [Redux](https://github.com/reactjs/redux) 间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 ``` -正例显示效果：如果你是来自 React 的开发者，你可能会对 Vuex 和 [Redux](https://github.com/reactjs/redux) 间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 +正例显示效果：如果您是来自 React 的开发者，您可能会对 Vuex 和 [Redux](https://github.com/reactjs/redux) 间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 反例： ``` -如果你是来自 React 的开发者，你可能会对 Vuex 和[Redux](https://github.com/reactjs/redux)间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 +如果您是来自 React 的开发者，您可能会对 Vuex 和[Redux](https://github.com/reactjs/redux)间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 ``` -反例显示效果：如果你是来自 React 的开发者，你可能会对 Vuex 和[Redux](https://github.com/reactjs/redux)间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 +反例显示效果：如果您是来自 React 的开发者，您可能会对 Vuex 和[Redux](https://github.com/reactjs/redux)间的差异表示关注，Redux 是 React 生态环境中最流行的 Flux 实现。 > 参考资料：[https://docs.github.com/en/rest/overview/resources-in-the-rest-api](https://docs.github.com/en/rest/overview/resources-in-the-rest-api) @@ -386,13 +386,13 @@ Redux 事实上无法感知视图层，所以它能够轻松的通过一些 [简 正例： ``` -如果你刚开始学习前端开发，将框架作为你的第一步可能不是最好的主意——掌握好基础知识再来吧！ +如果您刚开始学习前端开发，将框架作为您的第一步可能不是最好的主意——掌握好基础知识再来吧！ ``` 反例： ``` -如果你刚开始学习前端开发，将框架作为你的第一步可能不是最好的主意——掌握好基础知识再来吧！！！ +如果您刚开始学习前端开发，将框架作为您的第一步可能不是最好的主意——掌握好基础知识再来吧！！！ ``` > 说明：有时我们在书写的时候想进行感叹，可能会情不自禁地连续使用了相同的标点符号，但是请克制住自己，不要连续使用相同的标点符号。 diff --git a/web-vue/README.md b/web-vue/README.md index 117d819df2..528f0fb7ff 100644 --- a/web-vue/README.md +++ b/web-vue/README.md @@ -25,7 +25,7 @@ pnpm build # 打包 #### 编辑器 -这边我们推荐使用 VSCode， 我们我们尽量采用工具化方式来约束开发规范和编码风格， 使用 VSCode 即可应用现有配置和推荐你安装适合项目的插件。 具体配置看`/.vscode` 目录 +这边我们推荐使用 VSCode， 我们我们尽量采用工具化方式来约束开发规范和编码风格， 使用 VSCode 即可应用现有配置和推荐您安装适合项目的插件。 具体配置看`/.vscode` 目录 ⚠️：因为我们在升级 vue3 的过程中 vue2 版本也在不断迭代， 为了确保我们始终是在最新的代码基础上开发，编写某个页面前记得先从`web-vue` 目录中找到同名文件先替换下。