docs: update README

GZTimeWalker · Sep 20, 2024 · ab69fea · ab69fea
1 parent db7533e
commit ab69fea
Show file tree

Hide file tree

Showing 10 changed files with 451 additions and 422 deletions.
diff --git a/README.ja.md b/README.ja.md
@@ -22,9 +22,13 @@ GZ::CTF は ASP.NET Core を基づいたオープンソース CTF プラット
 > **お使いの前にドキュメントを読むことは極めてお勧めします：[https://docs.ctf.gzti.me/ja](https://docs.ctf.gzti.me/ja)**
 
 > [!WARNING]
-> 2024/01/01 より，`develop` ブランチから構築されたイメージのデータベーススキーマに破壊的変更が行われたため、従来のデータベースとの交換性はありません。従来のバージョンを引き続き使いたかった場合は `v0.17` を使ってください。
+> **アップグレードと移行に関する注意事項:**
 >
-> 新しい機能の開発期間で `develop` イメージを生産環境にデプロイすることはお勧めしません。データ損失が発生する恐れがあります。
+> 1. プラットフォームをアップグレードするには、最新のイメージを取得して再起動するだけで、データベースの移行が自動的に行われます。
+> 2. 一般的に、**ダウングレード** 操作はサポートされていません。時間スパンが大きいバージョンのアップグレードは、データの非互換性を引き起こす可能性があるため、**データのバックアップを取ることをお勧めします**。
+> 3. アップグレード後、新しい構成項目やファイル構造の変更がある場合があります。公式ドキュメントやコミュニティに相談することをお勧めします。
+> 4. 別のブランチプロジェクトに移行する場合は、データベース構造が変更されていないかどうかに注意してください。**変更後のデータベースは元のバージョンにロールバックできません**。
+> 5. コミュニティと公式メンテナーは、データの損失、データの非互換性、その他の問題について責任を負いません。ブランチプロジェクトの問題については、対応するプロジェクトメンテナーに連絡してください。
 
 ## 機能 🛠️
 
@@ -84,7 +88,7 @@ GZ::CTF は ASP.NET Core を基づいたオープンソース CTF プラット
 
 ## i18n について 🌐
 
-多言語対応についてはいま取り込んでいます、詳細や翻訳を提供するなどは [translate.ctf.gzti.me](https://translate.ctf.gzti.me) まで参照してください。
+翻訳について詳しくは [translate.ctf.gzti.me](https://translate.ctf.gzti.me) を参照してください。
 
 ## 貢献者 👋
 

diff --git a/README.md b/README.md
@@ -22,9 +22,13 @@ GZ::CTF is an open source CTF platform based on ASP.NET Core.
 > **To save your effort, please read the documentation carefully before using: [https://docs.ctf.gzti.me/en](https://docs.ctf.gzti.me/en)**
 
 > [!WARNING]
-> Since 01/01/2024, the database structure of the `develop` image is no longer compatible with previous versions. If you prefer to use it, please go to `v0.17`.
+> **Upgrade and migration considerations:**
 >
-> During the rapid development of new features, it is not recommended to use the `develop` image for production deployment, and the database structure changes will cause data loss.
+> 1. To upgrade the platform, simply pull the latest image and restart, and the database migration will be performed automatically.
+> 2. In general, **downgrade** operations are not supported. Upgrading versions with a large time span may result in data incompatibility, so **please make sure to back up your data**.
+> 3. After the upgrade, there may be new configuration items and changes in file structure. It is recommended to consult the official documentation or the community.
+> 4. If you are migrating to another branch project, please pay attention to whether the database structure has changed. **The database after the change does not support rollback to the original version**.
+> 5. The community and the official maintainers are not responsible for data loss, data incompatibility, and other issues. For issues with branch projects, please contact the corresponding project maintainer.
 
 ## Features 🛠️
 
@@ -84,7 +88,7 @@ GZ::CTF is an open source CTF platform based on ASP.NET Core.
 
 ## About i18n 🌐
 
-Localization support is in progress, please refer to [translate.ctf.gzti.me](https://translate.ctf.gzti.me) to learn more or participate in the translation work.
+Please refer to [translate.ctf.gzti.me](https://translate.ctf.gzti.me) to learn more or participate in the translation work.
 
 ## Contributors 👋
 

diff --git a/README.zh.md b/README.zh.md
@@ -22,9 +22,13 @@ GZ::CTF 是一个基于 ASP.NET Core 的开源 CTF 平台。
 > **为了避免不必要的时间浪费，使用前请详细阅读使用文档：[https://docs.ctf.gzti.me/zh](https://docs.ctf.gzti.me/zh)**
 
 > [!WARNING]
-> 2024/01/01 起，`develop` 镜像的数据库结构不再与之前的版本兼容，如果继续使用请转至 `v0.17`。
+> **升级和迁移注意事项：**
 >
-> 在新特性的快速开发期，不建议使用 `develop` 镜像进行生产部署，相关数据库结构变更将导致数据丢失。
+> 1. 如需升级平台，只需拉取最新的镜像并重新启动，数据库迁移会自动进行。
+> 2. 一般情况下，不支持 **降级** 操作，时间跨度过大的版本升级可能会导致数据不兼容，请做好数据备份。
+> 3. 升级后可能会有新的配置项和文件结构变更，建议查看官方文档或咨询社区。
+> 4. 如迁移到其他分支项目，请注意数据库结构是否存在变更，**变更后的数据库不支持回退到原始版本**。
+> 5. 社区及官方不对数据丢失、数据不兼容等问题负责，分支项目问题请联系对应项目维护者。
 
 ## 特性 🛠️
 
@@ -84,7 +88,7 @@ GZ::CTF 是一个基于 ASP.NET Core 的开源 CTF 平台。
 
 ## 关于 i18n 🌐
 
-目前多语言适配工作正在进行中，请在 [translate.ctf.gzti.me](https://translate.ctf.gzti.me) 中了解详情或参与翻译工作。
+请在 [translate.ctf.gzti.me](https://translate.ctf.gzti.me) 中了解详情或参与翻译工作。
 
 ## 贡献者 👋
 

diff --git a/docs/package.json b/docs/package.json
@@ -10,16 +10,16 @@
   },
   "dependencies": {
     "@vercel/analytics": "^1.3.1",
-    "next": "^14.2.7",
+    "next": "^14.2.13",
     "nextra": "^2.13.4",
     "nextra-theme-docs": "^2.13.4",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
   "devDependencies": {
-    "@types/node": "^22.5.2",
-    "@types/react": "^18.3.5",
+    "@types/node": "^22.5.5",
+    "@types/react": "^18.3.8",
     "prettier": "^3.3.3",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   }
 }
diff --git a/docs/pages/index.en.mdx b/docs/pages/index.en.mdx
@@ -10,9 +10,13 @@ GZ::CTF is open source under AGPLv3 license, use and modification are subject to
 
 <Callout type="warning">
 
-Since January 1, 2024, the database structure of the `develop` image is no longer compatible with previous versions. If you prefer to use it, please go to `v0.17`.
+**Upgrade and migration considerations:**
 
-During the rapid development of new features, it is not recommended to use the `develop` image for production deployment, and the database structure changes will cause data loss.
+1. To upgrade the platform, simply pull the latest image and restart, and the database migration will be performed automatically.
+2. In general, **downgrade** operations are not supported. Upgrading versions with a large time span may result in data incompatibility, so **please make sure to back up your data**.
+3. After the upgrade, there may be new configuration items and changes in file structure. It is recommended to consult the official documentation or the community.
+4. If you are migrating to another branch project, please pay attention to whether the database structure has changed. **The database after the change does not support rollback to the original version**.
+5. The community and the official maintainers are not responsible for data loss, data incompatibility, and other issues. For issues with branch projects, please contact the corresponding project maintainer.
 
 </Callout>
 

diff --git a/docs/pages/index.ja.mdx b/docs/pages/index.ja.mdx
@@ -10,9 +10,13 @@ GZ::CTF は AGPLv3 契約に基づいたオープンソースであり、その
 
 <Callout type="warning">
 
-2024/01/01 より，`develop` ブランチから構築されたイメージのデータベーススキーマに破壊的変更が行われたため、従来のデータベースとの交換性はありません。従来のバージョンを引き続き使いたかった場合は `v0.17` を使ってください。
+**アップグレードと移行に関する注意事項:**
 
-新しい機能の開発期間で `develop` イメージを生産環境にデプロイすることはお勧めしません。データ損失が発生する恐れがあります。
+1. プラットフォームをアップグレードするには、最新のイメージを取得して再起動するだけで、データベースの移行が自動的に行われます。
+2. 一般的に、**ダウングレード** 操作はサポートされていません。時間スパンが大きいバージョンのアップグレードは、データの非互換性を引き起こす可能性があるため、**データのバックアップを取ることをお勧めします**。
+3. アップグレード後、新しい構成項目やファイル構造の変更がある場合があります。公式ドキュメントやコミュニティに相談することをお勧めします。
+4. 別のブランチプロジェクトに移行する場合は、データベース構造が変更されていないかどうかに注意してください。**変更後のデータベースは元のバージョンにロールバックできません**。
+5. コミュニティと公式メンテナーは、データの損失、データの非互換性、その他の問題について責任を負いません。ブランチプロジェクトの問題については、対応するプロジェクトメンテナーに連絡してください。
 
 </Callout>
 

diff --git a/docs/pages/index.zh.mdx b/docs/pages/index.zh.mdx
@@ -10,9 +10,13 @@ GZ::CTF 基于 AGPLv3 协议开源，使用和修改均需遵守开源协议。
 
 <Callout type="warning">
 
-2024/01/01 起，`develop` 镜像的数据库结构不再与之前的版本兼容，如果继续使用请转至 `v0.17`。
+**升级和迁移注意事项：**
 
-在新特性的快速开发期，不建议使用 `develop` 镜像进行生产部署，相关数据库结构变更将导致数据丢失。
+1. 如需升级平台，只需拉取最新的镜像并重新启动，数据库迁移会自动进行。
+2. 一般情况下，不支持 **降级** 操作，时间跨度过大的版本升级可能会导致数据不兼容，请做好数据备份。
+3. 升级后可能会有新的配置项和文件结构变更，建议查看官方文档或咨询社区。
+4. 如迁移到其他分支项目，请注意数据库结构是否存在变更，**变更后的数据库不支持回退到原始版本**。
+5. 社区及官方不对数据丢失、数据不兼容等问题负责，分支项目问题请联系对应项目维护者。
 
 </Callout>