docs: move translated docs in docs folder

This commit is contained in:
Elias Schneider
2023-04-02 18:53:54 +02:00
parent 90aa919694
commit b4bf43910e
6 changed files with 30 additions and 28 deletions

View File

@@ -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)_
--- ---

View File

@@ -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 #### Stand-alone
1. Stop the running app 1. Stop the running app
```bash ```bash
pm2 stop pingvin-share-backend pingvin-share-frontend pm2 stop pingvin-share-backend pingvin-share-frontend
``` ```
2. Repeat the steps from the [installation guide](#stand-alone-installation) except the `git clone` step. 2. Repeat the steps from the [installation guide](#stand-alone-installation) except the `git clone` step.
```bash ```bash
cd pingvin-share cd pingvin-share

View File

@@ -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 # 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 ## 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: 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/): - El nombre de la pull request sigue las [especificaciones de Commits Convencionales](https://www.conventionalcommits.org/):
`<tipo>[ámbito opcional]: <descripción>` `<tipo>[ámbito opcional]: <descripción>`
ejemplo: ejemplo:
``` ```
feat(share): agregar protección con contraseña feat(share): agregar protección con contraseña
``` ```
Donde `tipo` puede ser: Donde `tipo` puede ser:
- **feat** - es una nueva función - **feat** - es una nueva función
- **doc** - cambios solo en la documentación - **doc** - cambios solo en la documentación
- **fix** - una corrección de error - **fix** - una corrección de error

View File

@@ -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. 提交你的代码以便代码审查 5. 提交你的代码以便代码审查
如果你进入你 fork 的 Github 仓库,你会看到一个 `Compare & pull request` 按钮,点击该按钮 如果你进入你 fork 的 Github 仓库,你会看到一个 `Compare & pull request` 按钮,点击该按钮
6. 发起一个 PR 6. 发起一个 PR
7. 点击 `Create pull request` 来提交你的 PR 7. 点击 `Create pull request` 来提交你的 PR
8. 等待代码审查,通过或以某些原因拒绝 8. 等待代码审查,通过或以某些原因拒绝

View File

@@ -1,9 +1,8 @@
# <div align="center"><img src="https://user-images.githubusercontent.com/58886915/166198400-c2134044-1198-4647-a8b6-da9c4a204c68.svg" width="40"/> </br>Pingvin Share</div> # <div align="center"><img src="https://user-images.githubusercontent.com/58886915/166198400-c2134044-1198-4647-a8b6-da9c4a204c68.svg" width="40"/> </br>Pingvin Share</div>
--- ---
*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) ### 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` 2. Ejecute `docker-compose up -d`
El sitio web ahora está esperando conexiones en `http://localhost:3000`, ¡diviértase usando Pingvin Share 🐧! 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 #### Instalación autónoma
1. Deten la aplicación en ejecución 1. Deten la aplicación en ejecución
```bash ```bash
pm2 stop pingvin-share-backend pingvin-share-frontend 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`. 2. Repite los pasos de la [guía de instalación](#instalación-autonoma) excepto el paso de `git clone`.
```bash ```bash
cd pingvin-share cd pingvin-share
# Consultar la última versión # Consultar la última versión
git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`) git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
# Iniciar el backend # Iniciar el backend
cd backend cd backend
npm run build npm run build
pm2 restart pingvin-share-backend pm2 restart pingvin-share-backend
# Iniciar frontend # Iniciar frontend
cd ../frontend cd ../frontend
npm run build npm run build

View File

@@ -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 部署 (推荐) ### Docker 部署 (推荐)
1. 下载 `docker-compose.yml` 1. 下载 `docker-compose.yml`
2. 运行命令 `docker-compose up -d` 2. 运行命令 `docker-compose up -d`
现在网站运行在 `http://localhost:3000`,尝试一下你本地的 Pingvin Share 🐧! 现在网站运行在 `http://localhost:3000`,尝试一下你本地的 Pingvin Share 🐧!
@@ -85,7 +85,7 @@ pm2 start --name="pingvin-share-frontend" npm -- run start
因为 Pingvin Share 仍处在开发阶段,在升级前请务必阅读 release notes 避免不可逆的改变 因为 Pingvin Share 仍处在开发阶段,在升级前请务必阅读 release notes 避免不可逆的改变
#### Docker 升级 #### Docker 升级
```bash ```bash
docker compose pull docker compose pull
@@ -95,10 +95,11 @@ docker compose up -d
#### Stand-alone 升级 #### Stand-alone 升级
1. 停止正在运行的 app 1. 停止正在运行的 app
```bash ```bash
pm2 stop pingvin-share-backend pingvin-share-frontend pm2 stop pingvin-share-backend pingvin-share-frontend
``` ```
2. 重复 [installation guide](#stand-alone-installation) 中的步骤,除了 `git clone` 这一步 2. 重复 [installation guide](#stand-alone-installation) 中的步骤,除了 `git clone` 这一步
```bash ```bash
cd pingvin-share cd pingvin-share