Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: ci error due to the docs lint #482

Merged
merged 1 commit into from
Jun 12, 2024
Merged

fix: ci error due to the docs lint #482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/atest-vscode.png → docs/site/assets/atest-vscode.png
View file
Open in desktop
File renamed without changes
2 changes: 0 additions & 2 deletions docs/site/content/en/contributions/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
7 changes: 3 additions & 4 deletions docs/site/content/en/latest/tasks/grpc-manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 0 additions & 2 deletions docs/site/content/zh/contributions/CONTRIBUTING-ZH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ weight: -1
description: "API Testing 贡献指南."
---

> 中文 | [English](CONTRIBUTING.md)

请加入我们，共同完善这个项目。

后端由 [Golang](https://go.dev/) 编写，前端由 [Vue](https://vuejs.org/) 编写。
Expand Down
4 changes: 3 additions & 1 deletion docs/grpc-TLS.md → .../site/content/zh/latest/tasks/grpc-TLS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/site/content/zh/latest/tasks/grpc-manual-zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title = "gRPC测试用例编写指南"

本文档将介绍如何编写`api-testing`的 gRPC API 的测试用例。

阅读本文档之前，您需要先安装并配置好`api-testing`，具体操作可以参考[官方文档](./README.md)。如果您已经完成了这些步骤，可以继续阅读本文档的后续部分。
阅读本文档之前，您需要先安装并配置好`api-testing`，具体操作可以参考[安装](../install/_index.md)章节。如果您已经完成了这些步骤，可以继续阅读本文档的后续部分。

## 创建测试项目

Expand Down
3 changes: 2 additions & 1 deletion tools/make/docs.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading