mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2025-10-31 14:22:25 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

[chore] update links in CONTRIBUTING.md (#3881)

Browse source
This commit is contained in:
CDN 2025-03-08 17:48:11 +00:00 • committed by tobi
commit 10ad4b22cc
2 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -99,7 +99,7 @@ If you see something in the documentation that's missing, wrong, or unclear, fee
We support a [Conda](https://docs.conda.io/en/latest/)-based workflow for hacking, building & publishing the documentation. Here's how you can get started locally: We support a [Conda](https://docs.conda.io/en/latest/)-based workflow for hacking, building & publishing the documentation. Here's how you can get started locally:
* Install [`miniconda`](https://docs.conda.io/en/latest/miniconda.html) * Install [`miniconda`](https://www.anaconda.com/docs/getting-started/miniconda/main)
* Create your conda environment: `conda env create -f ./docs/environment.yml` * Create your conda environment: `conda env create -f ./docs/environment.yml`
* Activate the environment: `conda activate gotosocial-docs` * Activate the environment: `conda activate gotosocial-docs`
* Serve locally: `mkdocs serve` * Serve locally: `mkdocs serve`
@ -176,7 +176,7 @@ nodemon -e go --signal SIGTERM --exec "go run ./cmd/gotosocial --host localhost
#### Docker #### Docker
For both of the below methods, you need to have [Docker buildx](https://docs.docker.com/buildx/working-with-buildx/) installed. For both of the below methods, you need to have [Docker buildx](https://docs.docker.com/build/concepts/overview/#buildx) installed.
##### With GoReleaser ##### With GoReleaser
@ -484,7 +484,7 @@ You'll additionally need functioning DNS for your two instance names, which you
GoToSocial uses [go-swagger](https://goswagger.io) to generate Swagger API documentation from code annotations. GoToSocial uses [go-swagger](https://goswagger.io) to generate Swagger API documentation from code annotations.
You can install go-swagger following the instructions [here](https://goswagger.io/install.html). You can install go-swagger following the instructions [here](https://goswagger.io/go-swagger/install/).
If you change Swagger annotations on any of the API paths, you can generate a new Swagger file at `./docs/api/swagger.yaml` by running: If you change Swagger annotations on any of the API paths, you can generate a new Swagger file at `./docs/api/swagger.yaml` by running:

8
docs/locales/zh/repo/CONTRIBUTING.md
View file

@ -98,7 +98,7 @@
我们支持基于 [Conda](https://docs.conda.io/en/latest/) 的工作流程，用于修改、构建和发布文档。以下是你可以在本地开始编辑的步骤： 我们支持基于 [Conda](https://docs.conda.io/en/latest/) 的工作流程，用于修改、构建和发布文档。以下是你可以在本地开始编辑的步骤：
* 安装 [`miniconda`](https://docs.conda.io/en/latest/miniconda.html) * 安装 [`miniconda`](https://www.anaconda.com/docs/getting-started/miniconda/main)
* 创建你的 conda 环境：`conda env create -f ./docs/environment.yml` * 创建你的 conda 环境：`conda env create -f ./docs/environment.yml`
* 激活环境：`conda activate gotosocial-docs` * 激活环境：`conda activate gotosocial-docs`
* 在本地运行：`mkdocs serve` * 在本地运行：`mkdocs serve`
@ -175,7 +175,7 @@ nodemon -e go --signal SIGTERM --exec "go run ./cmd/gotosocial --host localhost
#### Docker #### Docker
对于以下两种方法，你需要安装 [Docker buildx](https://docs.docker.com/buildx/working-with-buildx/)。 对于以下两种方法，你需要安装 [Docker buildx](https://docs.docker.com/build/concepts/overview/#buildx)。
##### 使用 GoReleaser ##### 使用 GoReleaser
@ -402,7 +402,7 @@ GoToSocial 提供了一个 [testrig](https://github.com/superseriousbusiness/got
#### 独立测试环境与 Pinafore #### 独立测试环境与 Pinafore
你可以启动一个在本地主机运行的独立测试服务器 testrig，可以通过 [Pinafore](https://github.com/NickColley/pinafore/) 连接。 你可以启动一个在本地主机运行的独立测试服务器 testrig，可以通过 [Pinafore](https://github.com/nolanlawson/pinafore/) 连接。
要做到这一点，首先用 `DEBUG=1 ./scripts/build.sh` 构建 gotosocial 二进制文件。 要做到这一点，首先用 `DEBUG=1 ./scripts/build.sh` 构建 gotosocial 二进制文件。
@ -483,7 +483,7 @@ GTS_DB_TYPE="postgres" GTS_DB_ADDRESS="localhost" go test -p 1 ./...
GoToSocial 使用 [go-swagger](https://goswagger.io) 根据代码注释生成 Swagger API 文档。 GoToSocial 使用 [go-swagger](https://goswagger.io) 根据代码注释生成 Swagger API 文档。
你可以遵循 [此处](https://goswagger.io/install.html) 的说明安装 go-swagger。 你可以遵循 [此处](https://goswagger.io/go-swagger/install/) 的说明安装 go-swagger。
如果你更改了任何 API 路径上的 Swagger 注释，可以通过运行以下命令在 `./docs/api/swagger.yaml` 生成一个新的 Swagger 文件： 如果你更改了任何 API 路径上的 Swagger 注释，可以通过运行以下命令在 `./docs/api/swagger.yaml` 生成一个新的 Swagger 文件：