From 80703a26d4f2786f5ddd3e53f06419e997289c67 Mon Sep 17 00:00:00 2001 From: Seven Du Date: Wed, 28 Nov 2018 15:06:21 +0800 Subject: [PATCH] chore: Remve DOCS --- docs/guide/upgrade/1.9-to-2.0.md | 133 ------------------ ...avel-master-branch-to-plus-master-guide.md | 103 -------------- 2 files changed, 236 deletions(-) delete mode 100644 docs/guide/upgrade/1.9-to-2.0.md delete mode 100644 docs/merge-laravel-master-branch-to-plus-master-guide.md diff --git a/docs/guide/upgrade/1.9-to-2.0.md b/docs/guide/upgrade/1.9-to-2.0.md deleted file mode 100644 index be327a643..000000000 --- a/docs/guide/upgrade/1.9-to-2.0.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: 从 1.9 升级到 2.0 -prev: false -next: false ---- - -::: danger -请你先确认你的版本已经是 1.9.* 版本，这里的 `*` 可以是 1.9 的任意修复版本。 -::: - -## 更新代码 - -**预计耗时：** `1 小时` - -这是你自我操作的步骤，确认将你的 1.9 版本代码升级到 2.0 版本，如果你做过一些自定义修改可能会出现代码冲突，你需要解决。 - -## 升级依赖 - -**预计耗时：** `3 分钟` - -进入 Plus 程序目录，执行： - -```bash -composer update -vvv -``` - -这个过程根据你的网速决定快慢。 - -## 清理缓存 - -**预计耗时：** `1 分钟` - -不管你是否使用 Laravel 命令进行过程序优化，我们仍然建议你执行下面的命令： - -```bash -php artisan view:clear && \ -php artisan route:clear && \ -php artisan config:clear -``` - -## 升级数据库 - -**预计耗时：** `10 分钟` - -- `at_messages` 增加表（无需操作） -- `users` 用户 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|-----| - | `avatar` | `true` | `null` | VARCHAR 类型，长度 `255` | 用户头像 | 添加 | - | `bg` | `true` | `null` | VARCHAR 类型，长度 `255` | 个人主页背景 | 添加 | - | `email_verified_at` | `true` | `null` | timestamp 类型 | 邮箱认证时间 | 添加 | - | `phone_verified_at` | `true` | `null` | timestamp 类型 | 手机号码认证时间 | 添加 | -- `feed_topics` 动态 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|----| - | `logo` | | | | | 删除 | - | `logo` | `true` | `null` | VARCHAR 类型，长度 `255` | 话题 logo | 添加 | -- `feed_topic_user_links` 动态 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|----| - | `following_at` | `true` | `null` | 修改为 `timestamp` 类型 | 关注话题时间 | 改变 | -- `feeds` 动态 - * 表字段 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|----| - | `repostable_type` | `true` | `null` | VARCHAR 类型，长度 `255` | 可转发的资源类型 | 添加 | - | `repostable_id` | `true` | `0` | integer 类型，unsigned，长度 `10` | 可转发的资源 ID | 添加 | - | `hot` | `true` | `0` | int 类型，unsigned，长度 `10` | 热门排序值 | 添加 | - * 索引 - - | 字段 | 索引类型 | - |----|----| - | `hot` | index | - | `created_at` | index | -- `groups` **授权**，圈子 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|----| - | `im_group_id` | `true` | `null` | varchar 类型，长度 `255` | 环信群组 ID | 添加 | - | `excellen_posts_count` | `true` | `0` | integer 类型，unsigned ，长度 `10`| 圈子精华贴统计 | 添加 | - | `avatar` | `true` | `null` | VARCHAR 类型，长度 `255` | 圈子头像 | 添加 | -- `group_posts` **授权**，圈子 - * 表字段 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|----| - | `excellent_at` | `true` | `null` | timestamp 类型 | 设置精华时间，也表示是否是精华 | 添加 | - | `comment_updated_at` | `true` | `null` | timestamp 类型 | 评论最后更新时间 | 添加 | - * 索引 - - | 字段 | 索引类型 | - |----|----| - | `group_id` | index | - | `user_id` | index | - | `excellent_at` | index | - | `comment_updated_at` | index | -- `topics` **授权**，问答 - - | 字段 | 可为空 | 默认值 | 其他 | 描述 | 操作 | - |-----|----|----|----|----|----| - | `avatar` | `true` | `null` | varchar 类型，长度 `255` | 专题头像 | 添加 | - -上述数据表修改完成后进入 Plus 目录，执行下面的命令： - -```bash -php artisan migrate -``` - -至此，你的数据库已升级完成。 - -## 设置新的存储系统 - -**预计耗时：** `10 分钟` - -现在，打开你的 Web 服务，然后在浏览器进入后台，然后从左边侧栏中找到「存储设置」，目前新的存储仅支持本地和阿里云 OSS 点击顶部菜单中的「文件系统」进行对应设置，设置完成后点击「频道设置」公开频道选择你使用的存储系统。 - -接下来，点击「基础设置」页面有三处设置，设置完成后接口可正常使用，如果不设置那么接口不会允许任何上传请求。 - -图片设置推荐宽高范围是 `20 - 4000` 以兼容云存储。 - -## 清理缓存 - -**预计耗时：** `1 分钟` - -到了这一步，你已经将程序成功升级到 2.0 版本了，现在我们清理下历史数据缓存即可： - -``` -php artisan cache:clear -``` diff --git a/docs/merge-laravel-master-branch-to-plus-master-guide.md b/docs/merge-laravel-master-branch-to-plus-master-guide.md deleted file mode 100644 index e11e7fb50..000000000 --- a/docs/merge-laravel-master-branch-to-plus-master-guide.md +++ /dev/null @@ -1,103 +0,0 @@ -# 合并 Laravel `master` 分支至 Plus `master` 指南 - -- [场景描述](#overview) -- [Merging 时机](#merging-time) -- [添加 Laravel 远端到本地仓库](#add-laravel-repo) -- [步骤 1（合并 Plus `master` 分支）](#merged-plus-master-branch) -- [步骤 2（合并 Laravel `master` 分支）](#merged-laravel-master-branch) - - [解决合并冲突](#resolve-conflict) -- [步骤 3 提交 `merge_laravel`](#push-merge-laravel-branch) -- [步骤 4 将 `merge_laravel` 合并至 `master`](#merged-merge-laravel-branch-to-master) - - -## 场景描述 - -Plus（ThinkSNS Plus 缩写） 是基于 [laravel/laravel](https://github.com/laravel/laravel) 仓库进行开发的一个程序， -前期是无纪律的直接向 Plus `master` 分支进行 「merge」 操作，造成 Plus 的 Commits 线并非存粹， -而是包含了 Laravel 的 Commits。 - -本指南从而解决这个问题，本指南将指导如何干净的跟随 Laravel 的更新。 - - -## Merging 时机 - -首先，我们应当牢记或者合并前查看 [slimkit/thinksns-plus:merge_laravel](https://github.com/slimkit/thinksns-plus/tree/merge_laravel) 上次合并 Laravel 的 commit hash，当然，会在本节下记录当前合并信息。 - -其次，更应当至少以 **周** 为节点关注 [laravel/laravel:master](https://github.com/laravel/laravel/tree/master) 的变动情况， -但是这不是必须的。我们更应关注的是 [Laravel Releases](https://github.com/laravel/laravel/releases) 一旦发现基于 `master` 分支的新「tag」或者 `release` 发布时，我们应当进行 `merge` 操作。 - -上次 Merge 的 Larave 版本 | 上次 Merge 操作执行时间 -------------------------|---------------------- -5.7.* | 2018-11-28 - - -## 添加 Laravel 远端到本地仓库 - -首先记住一个重要信息，Laravel 远端仓库为：`https://github.com/laravel/laravel` - -执行 `git remote add laravel https://github.com/laravel/laravel` 此时，你本地已经添加了 Laravel 远端在本地， - -> 如果上述你本地早已完成，可忽略。 - - -## 步骤 1（合并 Plus `master` 分支） - -当我们发现可以 `merge` 操作的版本时，不要着急去进行合并。 - -首先我们使用 `git checkout merge_laravel` 进入 **合并操作分支**，进入 `merge_laravel` 分支后我们应该使用常规 `merge` 将 `master` -分支代码合并过来，我们现在执行 `git merge master` - -> 此时，我们已经把 master 代码合并到了 `merge_laravel` 分支了，如果你出现了冲突，那只能说明一个问题，团队成员以前的 `merge` 操作对 `merge_laravel` 产生了干扰。 -> 还有可能是另一个问题，团队成员在 `merge_laravel` 分支做出了非 merged 的干扰提交。 - - -## 步骤 2（合并 Laravel `master` 分支） - -首先，我们应该切换到 `merge_laravel` 分支，可以执行 `git checkout merge_laravel` 切换。 - -> 注意：在我们拉取 Laravel 源的代码前，请确认你的修改都已经保存并 commit。 - -接下来我们从 Laravel 远端的 `master` 拉取提交到本地的 `merge_laravel` 分支： - -```shell -git pull laravel master -``` - - -### 解决合并冲突 - -大多数情况下，因为我们也需要再 Laravel 远端的代码上增加我们自己的代码。一般拉取完成后基本上都会出现冲突的，冲突的部分就是 Laravel 更新，我们也修改过的地方，此时你应该根据合并结果找到 `CONFLICT (content): Merge conflict in xxxx.xxx` 部分的文件打开，找到 -冲突的地方合并修正就好了。 - -解决完冲突的代码结构就与 Laravel 官方一致了，而且这种合并方式不会让落下任何一个不同的地方。 - - -## 步骤 3 提交 `merge_laravel` - -上面步骤都完成后，你会在 `merge_laravel` 分支下产生几条 Commit 记录，此时，你应该先将这些没有提交到 Plus 远端的 Commit 提交上去，并且等待 **持续集成** 的测试结果，以此类方式与官方保持一致很少会出现持续集成失败的。 - -很多时候失败都是更新了一些配置版本导致，尤其是前端，此时请在 `merge_laravel` - 下解决合并带来的不兼容问题。然后执行 `git push` 将 Commit 推到远端。 - - -## 步骤 4 将 `merge_laravel` 合并至 `master` - -此时，我们距离合并工作只只剩下最后一步了，就是将 `merge_laravel` 合并完成并解决了冲入的 Laravel 最新代码结构合并到 `master` 分支中。 - -此时我们的合并必须采用 `squash` 模式进行合并，以免 Laravel 的更新工作给 Plus 的 Commits 线带来分叉扰乱团队的历史记录。 - -首要任务是切换回 `master` 分支：`git checkout master`，然后我们执行 `squash` 进行合并： - -```shell -git merge --squash merge_laravel -``` - -一般这个步骤都不会报错，如果报错，一定是团队有成员扰乱了 `merge_laravel` 的 Commits，因为我们已经解决了 Laravel 在 Plus 中的冲突，这一步骤不会报错。 - -好了，我们合并完成，剩下的就是将 `master` 提交到远端即可。 - -Commit message 推荐写法： - -``` -chore: Merged laravel:master to master branch, Updated Laravel version to x.x.x -```