diff --git a/.github/workflows/deploy-to-gh-pages.yml b/.github/workflows/deploy-to-gh-pages.yml index 3049bd0b1..422f4e7d5 100644 --- a/.github/workflows/deploy-to-gh-pages.yml +++ b/.github/workflows/deploy-to-gh-pages.yml @@ -38,8 +38,10 @@ jobs: sed -i 's/defaultLocale: '\''zh'\''/defaultLocale: '\''en'\''/' docusaurus.config.js # Uncomment and update Algolia search path for GitHub Pages deployment - sed -i '/replaceSearchResultPathname: {/,/},/ s/^ \/\/ / /' docusaurus.config.js - sed -i 's|from: '\''/docs/'\''|from: '\''/en/'\''|' docusaurus.config.js + sed -i '/{ type: '\''localeDropdown'\'', position: '\''right'\'' }/d' docusaurus.config.js + sed -i -e "s/defaultLocale: 'zh'/defaultLocale: 'en'/" -e "s/locales: \['zh', 'en'\]/locales: \['en'\]/" -e 's|coscene.cn|coscene.io|g' docusaurus.config.js + find docs blog src i18n -type f \( -name "*.md" -o -name "*.mdx" -o -name "*.js" -o -name "*.ts" -name "*.tsx" -o -name "*.json" \) -exec sed -i -e 's|https://coscene.cn|https://portal.coscene.io|g' {} + + find docs blog src i18n -type f \( -name "*.md" -o -name "*.mdx" -o -name "*.js" -o -name "*.ts" -name "*.tsx" -o -name "*.json" \) -exec sed -i -e 's|coscene.cn|coscene.io|g' {} + pnpm build echo "docs.coscene.io" > ./build/CNAME diff --git a/docs/client-apps/_category_.json b/docs/client-apps/_category_.json deleted file mode 100644 index 730f8083a..000000000 --- a/docs/client-apps/_category_.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "label": "端侧软件", - "position": 7, - "collapsible": true, - "link": { - "type": "generated-index", - "slug": "/category/clients-apps" - } - } - \ No newline at end of file diff --git a/docs/client-apps/_coStudio/1-intro-to-studio.md b/docs/client-apps/_coStudio/1-intro-to-studio.md deleted file mode 100644 index c1b6a4f58..000000000 --- a/docs/client-apps/_coStudio/1-intro-to-studio.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -# 关于 coScene Studio - -coScene Studio 旨在帮助优化上传设备文件至云端并生成记录这一流程。 - -应用 coScene Studio 可以实现本地文件快速上传至云端并自动生成或更新记录，且对于使用向日葵等远程控制设备的场景，你可以直接在 PC 中将设备文件从设备拉取到云端，免去下载、上传的步骤。 diff --git a/docs/client-apps/_coStudio/2-install-studio.md b/docs/client-apps/_coStudio/2-install-studio.md deleted file mode 100644 index fa0fdab78..000000000 --- a/docs/client-apps/_coStudio/2-install-studio.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 2 ---- - -# 安装 - -你可以根据 PC 操作系统版本，按照相应引导进行 coScene Studio 的安装。 - -- **Windows** - - [点击下载 Windows 安装包](https://coscene-artifacts-prod.oss-cn-hangzhou.aliyuncs.com/studio/latest/coScene-studio-Windows-Setup.exe) - -- **macOS** - - [点击下载 macOS 安装包](https://coscene-artifacts-prod.oss-cn-hangzhou.aliyuncs.com/studio/latest/coScene-studio-Mac-Installer.dmg) - - 当出现下示「无法打开“coScene-studio”，因为无法验证开发者」警告时， - - ![install-studio-1](../img/install-studio-1.png) - - 请选择「设置」-「隐私与安全性」-「安全性」-「仍要打开」，完成安装。 - - ![install-studio-2](../img/install-studio-2.png) diff --git a/docs/client-apps/_coStudio/3-login-to-studio.md b/docs/client-apps/_coStudio/3-login-to-studio.md deleted file mode 100644 index ee00f94c5..000000000 --- a/docs/client-apps/_coStudio/3-login-to-studio.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -sidebar_position: 3 ---- - -# 登录 - -请在 coScene 网页端登录后，选择「设置」-「安全」-「生成登录令牌」并点击复制： - -![login-to-studio-1](../img/login-to-studio-1.png) - -![login-to-studio-2](../img/login-to-studio-2.png) - -打开 coScene Studio，粘贴复制的令牌并点击「登录」： - -![login-to-studio-3](../img/login-to-studio-3.png) - -请注意每次生成的登录令牌有效时限为一天；若超过有效时限或用户更换登录设备，则需重新生成登录令牌进行登录。 diff --git a/docs/client-apps/_coStudio/4-config-studio.md b/docs/client-apps/_coStudio/4-config-studio.md deleted file mode 100644 index 616e61ee0..000000000 --- a/docs/client-apps/_coStudio/4-config-studio.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 4 ---- - -# 初次使用时的配置 - -## 1. 选择上传项目 - -项目是刻行进行数据管理的基本类型，云端生成的记录需要被归档于某一项目中，所以您需要先选择您希望数据要上传至哪一项目中。 - -点击「选择项目」，选择文件要上传至云端的项目（您可以在搜索框中输入项目名称进行查找）并点击「确认」： - -![config-studio-1](../img/config-studio-1.png) - -## 2. 选择上传路径 - -您需要指定一个本地文件夹作为上传路径，本地拖拽至此文件夹中的文件将会被自动上传至云端对应的记录中。 - -点击「选择文件夹」，选择一个本地文件夹作为上传路径，之后点击「打开」确认： - -![config-studio-2](../img/config-studio-2.png) - -![config-studio-3](../img/config-studio-3.png) diff --git a/docs/client-apps/_coStudio/5-upload-file.md b/docs/client-apps/_coStudio/5-upload-file.md deleted file mode 100644 index b0443316e..000000000 --- a/docs/client-apps/_coStudio/5-upload-file.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_position: 5 ---- - -# 上传文件 - -## 1. 从本地上传文件 - -您可以在设置的上传路径下创建多级分类目录，每个非空的末级文件夹会在云端对应创建一条记录；您可以将文件拖动到文件夹中，文件夹中的文件会自动上传至所属文件夹对应的记录中： - -![upload-file-1](../img/upload-file-1.png) - -## 2. 远程从设备拉取文件 - -如果您使用向日葵等远程拉取文件的应用，可以直接在该应用中将数据从设备下的文件拖动到指定的上传路径下: - -![upload-file-2](../img/upload-file-2.png) - -## 3. 查看文件上传信息 - -您可以通过 coScene Studio 界面查看上传的文件信息与上传状态等： - -![upload-file-3](../img/upload-file-3.png) - -在「上传状态」栏显示「上传成功」后即完成文件上传。 - -您可以在 coScene 网页端看到生成的记录与上传成功的设备文件： - -![upload-file-4](../img/upload-file-4.png) diff --git a/docs/client-apps/_coStudio/6-modify.md b/docs/client-apps/_coStudio/6-modify.md deleted file mode 100644 index 8918c6aa7..000000000 --- a/docs/client-apps/_coStudio/6-modify.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -sidebar_position: 6 ---- - -# 修改上传路径 - -## 1. 上传路径中编辑文件 - -您对上传路径中的文件的移动、修改、删除等操作，对于已上传到云端的文件不会有任何影响。 - -## 2. 上传路径中编辑文件夹 - -您可以对上传路径中的文件夹进行重命名、删除、更改内容等操作。 - -- ### 重命名 - - 您可以在指定的上传路径中选择要重命名的子文件夹，点击右键，选择「重新命名」，对子文件夹进行重命名: - - ![modify-1](../img/modify-1.png) - - 请注意若要重命名某一文件夹，请先关闭 coScene Studio，否则有可能出现「文件夹正在使用」警告，无法进行文件夹重命名。 - -- ### 删除 - - 您可以删除指定的上传路径中的子文件夹。 - -- ### 更改内容 - - 您可以在指定的上传路径及其子文件夹中增加、删除或编辑文件。 - -- ### 其他情况 - - 若您删除了上传路径，您会收到重新选择的提示。 diff --git a/docs/client-apps/_coStudio/_category_.json b/docs/client-apps/_coStudio/_category_.json deleted file mode 100644 index 8a66a13f4..000000000 --- a/docs/client-apps/_coStudio/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "coScene Studio", - "position": 11, - "collapsible": true, - "link": { - "type": "generated-index" - } -} diff --git a/docusaurus.config.js b/docusaurus.config.js index 8c0acbe51..682862192 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -100,10 +100,7 @@ const config = { label: '文档', }, { to: '/changelog', label: '更新历史', position: 'left' }, - { - type: 'localeDropdown', - position: 'right', - }, + { type: 'localeDropdown', position: 'right' }, { href: 'https://www.coscene.cn', label: '官方网站', position: 'right' }, { href: 'https://github.com/coscene-io', label: 'GitHub', position: 'right' }, { diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_category_.json b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_category_.json deleted file mode 100644 index 730f8083a..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_category_.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "label": "端侧软件", - "position": 7, - "collapsible": true, - "link": { - "type": "generated-index", - "slug": "/category/clients-apps" - } - } - \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/1-intro-to-studio.md b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/1-intro-to-studio.md deleted file mode 100644 index 0e1618b36..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/1-intro-to-studio.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Introduction - -coScene Studio aims to optimize the process of uploading device files to the cloud and generating records. - -By using coScene Studio, you can quickly upload local files to the cloud and automatically generate or update records. Moreover, for scenarios where remote control devices such as Sunflower are used, you can directly pull device files from the device to the cloud on your PC, eliminating the need to download and upload. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/2-install-studio.md b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/2-install-studio.md deleted file mode 100644 index 629f9369e..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/2-install-studio.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Installation - -You can install coScene Studio based on the version of your PC's operating system by following the respective guide. - -- **Windows** - - [Click to download the Windows installer package](https://coscene-artifacts-prod.oss-cn-hangzhou.aliyuncs.com/studio/latest/coScene-studio-Windows-Setup.exe) - -- **macOS** - - [Click to download the macOS installer package](https://coscene-artifacts-prod.oss-cn-hangzhou.aliyuncs.com/studio/latest/coScene-studio-Mac-Installer.dmg) - - If you encounter the warning "Cannot open 'coScene-studio' because the developer cannot be verified", - - ![install-studio-1](../img/install-studio-1.png) - - Go to "System Preferences" > "Security & Privacy" > "General" > "Open Anyway" to complete the installation. - - ![install-studio-2](../img/install-studio-2.png) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/3-login-to-studio.md b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/3-login-to-studio.md deleted file mode 100644 index 0e788c5fd..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/3-login-to-studio.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Login - -After logging in to the coScene web interface, go to "Settings" > "Security" > "Generate Login Token" and click "Copy": - -![login-to-studio-1](./img/login-to-studio-1.png) - -![login-to-studio-2](./img/login-to-studio-2.png) - -Open coScene Studio, paste the copied token, and click "Login": - -![login-to-studio-3](./img/login-to-studio-3.png) - -Please note that each generated login token is valid for one day. If you exceed this duration or change the login device, you will need to regenerate the login token to log in. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/4-config-studio.md b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/4-config-studio.md deleted file mode 100644 index f30143f33..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/4-config-studio.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Initial Configuration - -## 1. Select Upload Project - -A project is the basic type for data management in coScene. Cloud-generated records need to be archived in a specific project, so you need to choose which project you want the data to be uploaded to. - -Click "Select Project", choose the project to which the file will be uploaded (you can search for the project name in the search box), and then click "Confirm": - -![config-studio-1](./img/config-studio-1.png) - -## 2. Specify Upload Path - -You need to designate a local directory as the upload path. Files dragged into this local directory will be automatically uploaded to the corresponding cloud record. - -Click "Choose Folder", select a local directory as the upload path, and then click "Open" to confirm: - -![config-studio-2](./img/config-studio-2.png) - -![config-studio-3](./img/config-studio-3.png) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/5-upload-file.md b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/5-upload-file.md deleted file mode 100644 index edcc2ab54..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/5-upload-file.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Upload Files - -## 1. Upload Files from Local - -You can create multi-level categorized directories under the specified upload path. Each non-empty end-level folder will correspond to a record created in the cloud. You can drag files into these folders, and the files in the folder will be automatically uploaded to the corresponding record of the folder: - -![upload-file-1](../img/upload-file-1.png) - -## 2. Remotely Fetch Files from Devices - -If you use applications like Sunflower for remote file fetching, you can directly drag data from the device directory into the specified upload path within that application: - -![upload-file-2](../img/upload-file-2.png) - -## 3. View File Upload Information - -You can view the uploaded file information and its upload status through the coScene Studio interface: - -![upload-file-3](../img/upload-file-3.png) - -Once the "Upload Status" displays "Upload Successful", the file upload is complete. - -You can see the generated record and the successfully uploaded device files on the coScene web interface: - -![upload-file-4](../img/upload-file-4.png) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/6-modify.md b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/6-modify.md deleted file mode 100644 index 2a1648c30..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/6-modify.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Configurations - -## 1. Edit Files in Upload Path - -Any operations you perform on the files in the upload path, such as moving, modifying, or deleting, will not affect the files already uploaded to the cloud. - -## 2. Edit Folders in Upload Path - -You can rename, delete, or modify the content of folders in the upload path. - -- ### Rename - - Within the specified upload path, you can choose the subfolder you wish to rename, right-click, and select "Rename" to rename the subfolder: - - ![modify-1](../img/modify-1.png) - - Please note that if you want to rename a folder, you should first close coScene Studio. Otherwise, a "Folder is in use" warning might appear, preventing the folder from being renamed. - -- ### Delete - - You can delete subfolders within the specified upload path. - -- ### Modify Content - - You can add, delete, or edit files within the specified upload path and its subfolders. - -- ### Other Situations - - If you delete the upload path, you will receive a prompt to select it again. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/_category_.json b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/_category_.json deleted file mode 100644 index 8a66a13f4..000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "coScene Studio", - "position": 11, - "collapsible": true, - "link": { - "type": "generated-index" - } -} diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-1.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-1.png deleted file mode 100644 index 9fafa9a89..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-1.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-2.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-2.png deleted file mode 100644 index d19f3a170..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-2.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-3.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-3.png deleted file mode 100644 index cbca330a8..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/config-studio-3.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/install-studio-1.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/install-studio-1.png deleted file mode 100644 index c36da7d0d..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/install-studio-1.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/install-studio-2.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/install-studio-2.png deleted file mode 100644 index 06e1fb6f0..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/install-studio-2.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-1.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-1.png deleted file mode 100644 index b0588470d..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-1.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-2.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-2.png deleted file mode 100644 index a1c0141e8..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-2.png and /dev/null differ diff --git a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-3.png b/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-3.png deleted file mode 100644 index 6b30588e9..000000000 Binary files a/i18n/en/docusaurus-plugin-content-docs/current/client-apps/_coStudio/img/login-to-studio-3.png and /dev/null differ