From b4bf43910e6ebfeb9e150b051421c10409a2ff00 Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Sun, 2 Apr 2023 18:53:54 +0200 Subject: [PATCH] docs: move translated docs in `docs` folder --- CONTRIBUTING.md | 2 +- README.md | 9 +++++---- CONTRIBUTING.es.md => docs/CONTRIBUTING.es.md | 14 +++++++------- .../CONTRIBUTING.zh-cn.md | 5 +++-- README.es.md => docs/README.es.md | 15 +++++++-------- README.zh-cn.md => docs/README.zh-cn.md | 13 +++++++------ 6 files changed, 30 insertions(+), 28 deletions(-) rename CONTRIBUTING.es.md => docs/CONTRIBUTING.es.md (93%) rename CONTRIBUTING.zh-cn.md => docs/CONTRIBUTING.zh-cn.md (86%) rename README.es.md => docs/README.es.md (95%) rename README.zh-cn.md => docs/README.zh-cn.md (90%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34a9fd0..1d47183 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -*Read this in another language: [Spanish](CONTRIBUTING.es.md), [English](CONTRIBUTING.md), [Simplified Chinese](CONTRIBUTING.zh-cn.md)* +_Read this in another language: [Spanish](/docs/CONTRIBUTING.es.md), [English](/CONTRIBUTING.md), [Simplified Chinese](/docs/CONTRIBUTING.zh-cn.md)_ --- diff --git a/README.md b/README.md index 3abdfa4..b97f95a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ --- -*Read this in another language: [Spanish](README.es.md), [English](README.md), [Simplified Chinese](README.zh-cn.md)* +_Read this in another language: [Spanish](/docs/README.es.md), [English]/(README.md), [Simplified Chinese](/docs/README.zh-cn.md)_ --- @@ -95,10 +95,11 @@ docker compose up -d #### Stand-alone 1. Stop the running app - ```bash - pm2 stop pingvin-share-backend pingvin-share-frontend - ``` + ```bash + pm2 stop pingvin-share-backend pingvin-share-frontend + ``` 2. Repeat the steps from the [installation guide](#stand-alone-installation) except the `git clone` step. + ```bash cd pingvin-share diff --git a/CONTRIBUTING.es.md b/docs/CONTRIBUTING.es.md similarity index 93% rename from CONTRIBUTING.es.md rename to docs/CONTRIBUTING.es.md index ae324ef..8171454 100644 --- a/CONTRIBUTING.es.md +++ b/docs/CONTRIBUTING.es.md @@ -1,10 +1,10 @@ -*Leer esto en otro idioma: [Inglés](CONTRIBUTING.md), [Español](CONTRIBUTING.es.md), [Chino Simplificado](CONTRIBUTING.zh-cn.md)* +_Leer esto en otro idioma: [Inglés](/CONTRIBUTING.md), [Español](/docs/CONTRIBUTING.es.md), [Chino Simplificado](/docs/CONTRIBUTING.zh-cn.md)_ --- # Contribuyendo -¡Nos ❤️ encantaría que contribuyas a Pingvin Share y nos ayudes a hacerlo mejor! Todas las contribuciones son bienvenidas, incluyendo problemas, sugerencias, *pull requests* y más. +¡Nos ❤️ encantaría que contribuyas a Pingvin Share y nos ayudes a hacerlo mejor! Todas las contribuciones son bienvenidas, incluyendo problemas, sugerencias, _pull requests_ y más. ## Para comenzar @@ -15,17 +15,17 @@ Si encontraste un error, tienes una sugerencia o algo más, simplemente crea un Antes de enviar la pull request para su revisión, asegúrate de que: - El nombre de la pull request sigue las [especificaciones de Commits Convencionales](https://www.conventionalcommits.org/): - + `[ámbito opcional]: ` - + ejemplo: - + ``` feat(share): agregar protección con contraseña ``` - + Donde `tipo` puede ser: - + - **feat** - es una nueva función - **doc** - cambios solo en la documentación - **fix** - una corrección de error diff --git a/CONTRIBUTING.zh-cn.md b/docs/CONTRIBUTING.zh-cn.md similarity index 86% rename from CONTRIBUTING.zh-cn.md rename to docs/CONTRIBUTING.zh-cn.md index b9b6132..f693129 100644 --- a/CONTRIBUTING.zh-cn.md +++ b/docs/CONTRIBUTING.zh-cn.md @@ -1,4 +1,4 @@ -*选择合适的语言阅读: [西班牙语](CONTRIBUTING.es.md), [英语](CONTRIBUTING.md), [简体中文](CONTRIBUTING.zh-cn.md)* +_选择合适的语言阅读: [西班牙语](/docs/CONTRIBUTING.es.md), [英语](/CONTRIBUTING.md), [简体中文](/docs/CONTRIBUTING.zh-cn.md)_ --- @@ -55,7 +55,8 @@ $ git push origin [你的新分支的名字] 5. 提交你的代码以便代码审查 - 如果你进入你 fork 的 Github 仓库，你会看到一个 `Compare & pull request` 按钮，点击该按钮 + 如果你进入你 fork 的 Github 仓库，你会看到一个 `Compare & pull request` 按钮，点击该按钮 + 6. 发起一个 PR 7. 点击 `Create pull request` 来提交你的 PR 8. 等待代码审查，通过或以某些原因拒绝 diff --git a/README.es.md b/docs/README.es.md similarity index 95% rename from README.es.md rename to docs/README.es.md index ef5162f..abb97ce 100644 --- a/README.es.md +++ b/docs/README.es.md @@ -1,9 +1,8 @@ - #

Pingvin Share
--- -*Leer esto en otro idioma: [Inglés](README.md), [Español](README.es.md), [Chino Simplificado](README.zh-cn.md)* +_Leer esto en otro idioma: [Inglés](/README.md), [Español](/docs/README.es.md), [Chino Simplificado](/docs/README.zh-cn.md)_ --- @@ -31,7 +30,7 @@ Pingvin Share es una plataforma de intercambio de archivos autoalojada y una alt ### Instalación con Docker (recomendada) -1. Descarge el archivo `docker-compose.yml` +1. Descarge el archivo `docker-compose.yml` 2. Ejecute `docker-compose up -d` El sitio web ahora está esperando conexiones en `http://localhost:3000`, ¡diviértase usando Pingvin Share 🐧! @@ -96,24 +95,24 @@ docker compose up -d #### Instalación autónoma 1. Deten la aplicación en ejecución - + ```bash pm2 stop pingvin-share-backend pingvin-share-frontend ``` 2. Repite los pasos de la [guía de instalación](#instalación-autonoma) excepto el paso de `git clone`. - + ```bash cd pingvin-share - + # Consultar la última versión git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`) - + # Iniciar el backend cd backend npm run build pm2 restart pingvin-share-backend - + # Iniciar frontend cd ../frontend npm run build diff --git a/README.zh-cn.md b/docs/README.zh-cn.md similarity index 90% rename from README.zh-cn.md rename to docs/README.zh-cn.md index 42823b2..a0401bb 100644 --- a/README.zh-cn.md +++ b/docs/README.zh-cn.md @@ -2,7 +2,7 @@ --- -*选择合适的语言阅读: [西班牙语](README.es.md), [英语](README.md), [简体中文](README.zh-cn.md)* +_选择合适的语言阅读: [西班牙语](/docs/README.es.md), [英语](/README.md), [简体中文](/docs/README.zh-cn.md)_ --- @@ -30,7 +30,7 @@ Pingvin Share 是一个可自建的文件分享平台，是 WeTransfer 的一个 ### Docker 部署 (推荐) -1. 下载 `docker-compose.yml` +1. 下载 `docker-compose.yml` 2. 运行命令 `docker-compose up -d` 现在网站运行在 `http://localhost:3000`，尝试一下你本地的 Pingvin Share 🐧! @@ -85,7 +85,7 @@ pm2 start --name="pingvin-share-frontend" npm -- run start 因为 Pingvin Share 仍处在开发阶段，在升级前请务必阅读 release notes 避免不可逆的改变 -#### Docker 升级 +#### Docker 升级 ```bash docker compose pull @@ -95,10 +95,11 @@ docker compose up -d #### Stand-alone 升级 1. 停止正在运行的 app - ```bash - pm2 stop pingvin-share-backend pingvin-share-frontend - ``` + ```bash + pm2 stop pingvin-share-backend pingvin-share-frontend + ``` 2. 重复 [installation guide](#stand-alone-installation) 中的步骤，除了 `git clone` 这一步 + ```bash cd pingvin-share