From 98c4cae89ac6a6c24c3580d3cead31ac43376114 Mon Sep 17 00:00:00 2001 From: CDN Date: Sat, 8 Mar 2025 17:48:11 +0000 Subject: [PATCH] [chore] update links in CONTRIBUTING.md (#3881) --- CONTRIBUTING.md | 6 +++--- docs/locales/zh/repo/CONTRIBUTING.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29209dcbf..fecceb5bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: -* 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` * Activate the environment: `conda activate gotosocial-docs` * Serve locally: `mkdocs serve` @@ -176,7 +176,7 @@ nodemon -e go --signal SIGTERM --exec "go run ./cmd/gotosocial --host localhost #### 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 @@ -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. -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: diff --git a/docs/locales/zh/repo/CONTRIBUTING.md b/docs/locales/zh/repo/CONTRIBUTING.md index 0da934c40..cee9cf47c 100644 --- a/docs/locales/zh/repo/CONTRIBUTING.md +++ b/docs/locales/zh/repo/CONTRIBUTING.md @@ -98,7 +98,7 @@ 我们支持基于 [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 activate gotosocial-docs` * 在本地运行：`mkdocs serve` @@ -175,7 +175,7 @@ nodemon -e go --signal SIGTERM --exec "go run ./cmd/gotosocial --host localhost #### Docker -对于以下两种方法，你需要安装 [Docker buildx](https://docs.docker.com/buildx/working-with-buildx/)。 +对于以下两种方法，你需要安装 [Docker buildx](https://docs.docker.com/build/concepts/overview/#buildx)。 ##### 使用 GoReleaser @@ -402,7 +402,7 @@ GoToSocial 提供了一个 [testrig](https://github.com/superseriousbusiness/got #### 独立测试环境与 Pinafore -你可以启动一个在本地主机运行的独立测试服务器 testrig，可以通过 [Pinafore](https://github.com/NickColley/pinafore/) 连接。 +你可以启动一个在本地主机运行的独立测试服务器 testrig，可以通过 [Pinafore](https://github.com/nolanlawson/pinafore/) 连接。 要做到这一点，首先用 `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 文档。 -你可以遵循 [此处](https://goswagger.io/install.html) 的说明安装 go-swagger。 +你可以遵循 [此处](https://goswagger.io/go-swagger/install/) 的说明安装 go-swagger。 如果你更改了任何 API 路径上的 Swagger 注释，可以通过运行以下命令在 `./docs/api/swagger.yaml` 生成一个新的 Swagger 文件：