kyfx
/
api-testing
mirror of https://github.com/LinuxSuRen/api-testing.git
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix: ci error due to the docs lint (#482) 

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
This commit is contained in:
YuLuo 2024-06-12 21:14:48 +08:00 committed by GitHub
parent 4a7f92c824
commit d6162c7f2c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/atest-vscode.png → docs/site/assets/atest-vscode.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

2
docs/site/content/en/contributions/CONTRIBUTING.md
View File

@ -4,8 +4,6 @@ weight: -1
description: "This section contributing of API Testing."
---
> English | [中文](CONTRIBUTING-ZH.md)
Please join us to improve this project.
The backend is written by [Golang](https://go.dev/), and the front-end is written by [Vue](https://vuejs.org/).

7
docs/site/content/en/latest/tasks/grpc-manual.md
View File

@ -1,15 +1,14 @@
+++
title = "gRPC testsuite writing manual"
weight = -99
+++
This document will introduce how to write testsuite for the gRPC API of `api-testing`.
Before reading this document, you need to install and configure `api-testing`. For specific operations, please refer to [Official Document](./README.md). If you have completed these steps, you can continue reading the rest of this document.
Before reading this document, you need to install and configure `api-testing`. For specific operations, please refer to [Install Document](../install/_index.md). If you have completed these steps, you can continue reading the rest of this document.
## Create testsuite
## Create testsuite
To create a gRPC testsuite based on service reflection, just add the following content to the `spec` path of the yaml file:
To create a gRPC testsuite based on service reflection, just add the following content to the `spec` path of the yaml file:
```yaml
spec:

2
docs/site/content/zh/contributions/CONTRIBUTING-ZH.md
View File

@ -4,8 +4,6 @@ weight: -1
description: "API Testing 贡献指南."
---
> 中文 | [English](CONTRIBUTING.md)
请加入我们，共同完善这个项目。
后端由 [Golang](https://go.dev/) 编写，前端由 [Vue](https://vuejs.org/) 编写。

4
docs/grpc-TLS.md → docs/site/content/zh/latest/tasks/grpc-TLS.md
View File

@ -1,4 +1,6 @@
# gRPC TLS verification
+++
title = "gRPC TLS verification"
+++
If you want to enable gRPC TLS, you need to generate your certificates in the workspace, or you can use an absolute path

2
docs/site/content/zh/latest/tasks/grpc-manual-zh.md
View File

@ -4,7 +4,7 @@ title = "gRPC测试用例编写指南"
本文档将介绍如何编写`api-testing`的 gRPC API 的测试用例。
阅读本文档之前，您需要先安装并配置好`api-testing`，具体操作可以参考[官方文档](./README.md)。如果您已经完成了这些步骤，可以继续阅读本文档的后续部分。
阅读本文档之前，您需要先安装并配置好`api-testing`，具体操作可以参考[安装](../install/_index.md)章节。如果您已经完成了这些步骤，可以继续阅读本文档的后续部分。
## 创建测试项目

3
tools/make/docs.mk
View File

@ -22,7 +22,8 @@ docs-check-links:
@$(LOG_TARGET)
# Check for broken links
npm install -g linkinator@6.0.4
linkinator docs -r --concurrency 25 -s "github.com"
# https://github.com/JustinBeckwith/linkinator?tab=readme-ov-file#command-usage
linkinator docs/site/public -r --concurrency 25 -s "github.com _print v0.0.1"
# Docs site, make by hexo.