From 9dc5cf4ba2e86c43eb4dbecc2a9e9ccd63668ac2 Mon Sep 17 00:00:00 2001 From: "delong.wang" Date: Thu, 10 Aug 2023 17:30:24 +0800 Subject: [PATCH] feat: rename docs folder --- website/README.md | 28 +++++++++---------- .../01-install.md} | 6 ++-- .../02-guide_login.md => 02-guide/02-login.md} | 0 .../03-guide_config.md => 02-guide/03-config.md} | 2 +- .../04-guide_test.md => 02-guide/04-test.md} | 4 +-- .../05-upgrade.md} | 0 .../{02-上手指南 => 02-guide}/_category_.json | 0 .../01-faq_install.md => 03-faq/01-install.md} | 0 .../02-faq_login.md => 03-faq/02-login.md} | 0 .../03-faq_access.md => 03-faq/03-access.md} | 0 .../04-faq_config.md => 03-faq/04-config.md} | 0 .../05-faq_other.md => 03-faq/05-other.md} | 0 .../_category_.json | 0 .../01-syntaxanalysis.md} | 0 .../02-challenge.md} | 0 .../03-changelog.md} | 4 +-- .../04-chaitin.md} | 0 .../{04-关于雷池 => 04-about}/_category_.json | 0 website/docusaurus.config.js | 2 +- 19 files changed, 23 insertions(+), 23 deletions(-) rename website/docs/{02-上手指南/01-guide_install.md => 02-guide/01-install.md} (94%) rename website/docs/{02-上手指南/02-guide_login.md => 02-guide/02-login.md} (100%) rename website/docs/{02-上手指南/03-guide_config.md => 02-guide/03-config.md} (93%) rename website/docs/{02-上手指南/04-guide_test.md => 02-guide/04-test.md} (97%) rename website/docs/{02-上手指南/05-guide_upgrade.md => 02-guide/05-upgrade.md} (100%) rename website/docs/{02-上手指南 => 02-guide}/_category_.json (100%) rename website/docs/{03-常见问题排查/01-faq_install.md => 03-faq/01-install.md} (100%) rename website/docs/{03-常见问题排查/02-faq_login.md => 03-faq/02-login.md} (100%) rename website/docs/{03-常见问题排查/03-faq_access.md => 03-faq/03-access.md} (100%) rename website/docs/{03-常见问题排查/04-faq_config.md => 03-faq/04-config.md} (100%) rename website/docs/{03-常见问题排查/05-faq_other.md => 03-faq/05-other.md} (100%) rename website/docs/{03-常见问题排查 => 03-faq}/_category_.json (100%) rename website/docs/{04-关于雷池/01-about_syntaxanalysis.md => 04-about/01-syntaxanalysis.md} (100%) rename website/docs/{04-关于雷池/02-about_challenge.md => 04-about/02-challenge.md} (100%) rename website/docs/{04-关于雷池/03-about_changelog.md => 04-about/03-changelog.md} (98%) rename website/docs/{04-关于雷池/04-about_chaitin.md => 04-about/04-chaitin.md} (100%) rename website/docs/{04-关于雷池 => 04-about}/_category_.json (100%) diff --git a/website/README.md b/website/README.md index 9fd8448..0fc2938 100644 --- a/website/README.md +++ b/website/README.md @@ -29,20 +29,20 @@ docker run --name site -p 3000:80 -d website:latest location / { rewrite /posts/guide_introduction /docs/; - rewrite /posts/guide_install /docs/上手指南/guide_install; - rewrite /posts/guide_login /docs/上手指南/guide_login; - rewrite /posts/guide_config /docs/上手指南/guide_config; - rewrite /posts/guide_test /docs/上手指南/guide_test; - rewrite /posts/guide_upgrade /docs/上手指南/guide_upgrade; - rewrite /posts/faq_install /docs/常见问题排查/faq_install; - rewrite /posts/faq_login /docs/常见问题排查/faq_login; - rewrite /posts/faq_access /docs/常见问题排查/faq_access; - rewrite /posts/faq_config /docs/常见问题排查/faq_config; - rewrite /posts/faq_other /docs/常见问题排查/faq_other; - rewrite /posts/about_syntaxanalysis /docs/关于雷池/about_syntaxanalysis; - rewrite /posts/about_challenge /docs/关于雷池/about_challenge; - rewrite /posts/about_changelog /docs/关于雷池/about_changelog; - rewrite /posts/about_chaitin /docs/关于雷池/about_chaitin; + rewrite /posts/guide_install /docs/guide/install; + rewrite /posts/guide_login /docs/guide/login; + rewrite /posts/guide_config /docs/guide/config; + rewrite /posts/guide_test /docs/guide/test; + rewrite /posts/guide_upgrade /docs/guide/upgrade; + rewrite /posts/faq_install /docs/faq/install; + rewrite /posts/faq_login /docs/faq/login; + rewrite /posts/faq_access /docs/faq/access; + rewrite /posts/faq_config /docs/faq/config; + rewrite /posts/faq_other /docs/faq/other; + rewrite /posts/about_syntaxanalysis /docs/about/syntaxanalysis; + rewrite /posts/about_challenge /docs/about/challenge; + rewrite /posts/about_changelog /docs/about/changelog; + rewrite /posts/about_chaitin /docs/about/chaitin; proxy_pass http://upstream; } diff --git a/website/docs/02-上手指南/01-guide_install.md b/website/docs/02-guide/01-install.md similarity index 94% rename from website/docs/02-上手指南/01-guide_install.md rename to website/docs/02-guide/01-install.md index 0c63f2f..292761e 100644 --- a/website/docs/02-上手指南/01-guide_install.md +++ b/website/docs/02-guide/01-install.md @@ -42,7 +42,7 @@ bash -c "$(curl -fsSLk https://waf-ce.chaitin.cn/release/latest/setup.sh)" > 如果连接 Docker Hub 网络不稳，导致镜像下载失败，可以采用 [离线安装](#离线安装) 方式 -经过以上步骤，你的雷池已经安装好了，下一步请参考 [登录雷池](/docs/上手指南/guide_login) +经过以上步骤，你的雷池已经安装好了，下一步请参考 [登录雷池](/docs/guide/login) ## 离线安装 @@ -82,7 +82,7 @@ echo "SUBNET_PREFIX=172.22.222" >> .env docker compose up -d ``` -经过以上步骤，你的雷池已经安装好了，下一步请参考 [登录雷池](/docs/上手指南/guide_login) +经过以上步骤，你的雷池已经安装好了，下一步请参考 [登录雷池](/docs/guide/login) ## 使用牧云助手安装 @@ -94,4 +94,4 @@ docker compose up -d ## 常见安装问题 -请参考 [安装问题](/docs/常见问题排查/faq_install) +请参考 [安装问题](/docs/faq/install) diff --git a/website/docs/02-上手指南/02-guide_login.md b/website/docs/02-guide/02-login.md similarity index 100% rename from website/docs/02-上手指南/02-guide_login.md rename to website/docs/02-guide/02-login.md diff --git a/website/docs/02-上手指南/03-guide_config.md b/website/docs/02-guide/03-config.md similarity index 93% rename from website/docs/02-上手指南/03-guide_config.md rename to website/docs/02-guide/03-config.md index 4f76e9e..8c4b517 100644 --- a/website/docs/02-上手指南/03-guide_config.md +++ b/website/docs/02-guide/03-config.md @@ -21,4 +21,4 @@ title: "配置防护站点" ## 测试防护效果 -[测试防护效果](/docs/上手指南/guide_test) +[测试防护效果](/docs/guide/test) diff --git a/website/docs/02-上手指南/04-guide_test.md b/website/docs/02-guide/04-test.md similarity index 97% rename from website/docs/02-上手指南/04-guide_test.md rename to website/docs/02-guide/04-test.md index e4fbcaa..a51708e 100644 --- a/website/docs/02-上手指南/04-guide_test.md +++ b/website/docs/02-guide/04-test.md @@ -14,7 +14,7 @@ title: "测试防护效果" > 主机名可以是雷池的 IP，也可以是网站的域名（确保域名已经解析到雷池） > 端口是你在雷池页面中配置的网站端口 -若网站访问不正常，请参考 [网站无法访问](/docs/03-常见问题排查/03-faq_access.md)。 +若网站访问不正常，请参考 [网站无法访问](/docs/03-faq/03-access.md)。 ## 尝试手动模拟攻击 @@ -25,7 +25,7 @@ title: "测试防护效果" 通过浏览器，你将会看到雷池已经发现并阻断了攻击请求。 -若请求没有被阻断，请参考 [防护不生效](/docs/03-常见问题排查/05-faq_other.md) +若请求没有被阻断，请参考 [防护不生效](/docs/03-faq/05-other.md) ## 自动化测试防护效果 diff --git a/website/docs/02-上手指南/05-guide_upgrade.md b/website/docs/02-guide/05-upgrade.md similarity index 100% rename from website/docs/02-上手指南/05-guide_upgrade.md rename to website/docs/02-guide/05-upgrade.md diff --git a/website/docs/02-上手指南/_category_.json b/website/docs/02-guide/_category_.json similarity index 100% rename from website/docs/02-上手指南/_category_.json rename to website/docs/02-guide/_category_.json diff --git a/website/docs/03-常见问题排查/01-faq_install.md b/website/docs/03-faq/01-install.md similarity index 100% rename from website/docs/03-常见问题排查/01-faq_install.md rename to website/docs/03-faq/01-install.md diff --git a/website/docs/03-常见问题排查/02-faq_login.md b/website/docs/03-faq/02-login.md similarity index 100% rename from website/docs/03-常见问题排查/02-faq_login.md rename to website/docs/03-faq/02-login.md diff --git a/website/docs/03-常见问题排查/03-faq_access.md b/website/docs/03-faq/03-access.md similarity index 100% rename from website/docs/03-常见问题排查/03-faq_access.md rename to website/docs/03-faq/03-access.md diff --git a/website/docs/03-常见问题排查/04-faq_config.md b/website/docs/03-faq/04-config.md similarity index 100% rename from website/docs/03-常见问题排查/04-faq_config.md rename to website/docs/03-faq/04-config.md diff --git a/website/docs/03-常见问题排查/05-faq_other.md b/website/docs/03-faq/05-other.md similarity index 100% rename from website/docs/03-常见问题排查/05-faq_other.md rename to website/docs/03-faq/05-other.md diff --git a/website/docs/03-常见问题排查/_category_.json b/website/docs/03-faq/_category_.json similarity index 100% rename from website/docs/03-常见问题排查/_category_.json rename to website/docs/03-faq/_category_.json diff --git a/website/docs/04-关于雷池/01-about_syntaxanalysis.md b/website/docs/04-about/01-syntaxanalysis.md similarity index 100% rename from website/docs/04-关于雷池/01-about_syntaxanalysis.md rename to website/docs/04-about/01-syntaxanalysis.md diff --git a/website/docs/04-关于雷池/02-about_challenge.md b/website/docs/04-about/02-challenge.md similarity index 100% rename from website/docs/04-关于雷池/02-about_challenge.md rename to website/docs/04-about/02-challenge.md diff --git a/website/docs/04-关于雷池/03-about_changelog.md b/website/docs/04-about/03-changelog.md similarity index 98% rename from website/docs/04-关于雷池/03-about_changelog.md rename to website/docs/04-about/03-changelog.md index c0dcefa..c4702c8 100644 --- a/website/docs/04-关于雷池/03-about_changelog.md +++ b/website/docs/04-about/03-changelog.md @@ -4,7 +4,7 @@ title: "版本更新记录" # 版本更新记录 -[版本升级方法](/docs/上手指南/guide_upgrade) +[版本升级方法](/docs/guide/upgrade) ## [2.6.0] - 2023-08-10 @@ -88,7 +88,7 @@ title: "版本更新记录" ### 新增 -- 支持自定义站点的 nginx conf，详情可见[官网文档](/docs/常见问题排查/faq_other#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9-nginx-conf) +- 支持自定义站点的 nginx conf，详情可见[官网文档](/docs/faq/other#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9-nginx-conf) - 添加/编辑站点时，自动检查端口占用情况，避免保存后配置不生效 - [站点列表支持按域名、端口或访问量进行排序](https://github.com/chaitin/safeline/issues/14) - [绑定 TOTP 密钥时，支持直接复制密钥；登录时的 6 位动态密码输入框，支持粘贴](https://github.com/chaitin/safeline/issues/30) diff --git a/website/docs/04-关于雷池/04-about_chaitin.md b/website/docs/04-about/04-chaitin.md similarity index 100% rename from website/docs/04-关于雷池/04-about_chaitin.md rename to website/docs/04-about/04-chaitin.md diff --git a/website/docs/04-关于雷池/_category_.json b/website/docs/04-about/_category_.json similarity index 100% rename from website/docs/04-关于雷池/_category_.json rename to website/docs/04-about/_category_.json diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 10d356a..fd44933 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -134,7 +134,7 @@ const config = { }, { label: "关于我们", - to: "/docs/关于雷池/about_chaitin", + to: "/docs/about/chaitin", }, ], },