Skip to content

CI: add Vale to apply Google style guide to all md files #4141

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.

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

Draft
wants to merge 34 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
7c32c58
add vale ci test files and style files
CharLotteiu Nov 3, 2020
893e8c7
update config and add test file
CharLotteiu Nov 3, 2020
51f596f
Update config.yml
CharLotteiu Nov 3, 2020
4f8de35
Update config.yml
CharLotteiu Nov 3, 2020
dbc3161
Update config.yml
CharLotteiu Nov 3, 2020
0fb791a
Update config.yml
CharLotteiu Nov 3, 2020
29ac11c
add test files
CharLotteiu Nov 3, 2020
913c657
remove dead anchors in test-file-2.md
CharLotteiu Nov 3, 2020
ef09eff
Update test-file-2.md
CharLotteiu Nov 3, 2020
c5ccd47
add ignored words file and related yamal rules
CharLotteiu Nov 4, 2020
3837323
update test files
CharLotteiu Nov 4, 2020
fdf66f9
Revert "update test files"
CharLotteiu Nov 4, 2020
bee13f1
Revert "add ignored words file and related yamal rules"
CharLotteiu Nov 4, 2020
1bc78b5
add ignored word list and related yaml rule again
CharLotteiu Nov 4, 2020
09e85e7
update test files and config
CharLotteiu Nov 4, 2020
f9de474
Update config.yml
CharLotteiu Nov 4, 2020
fc6500d
Update config.yml
CharLotteiu Nov 4, 2020
8a28aff
Update config.yml
CharLotteiu Nov 4, 2020
d69e6af
Merge remote-tracking branch 'upstream/master' into add-vale-test
CharLotteiu Nov 4, 2020
7957859
Update test-file-2.md
CharLotteiu Nov 4, 2020
74a951d
remove true positives
Nov 4, 2020
fad85b8
Merge branch 'master' into add-vale-test
yikeke Nov 6, 2020
b073408
Merge branch 'master' into add-vale-test
yikeke Nov 6, 2020
e4f07c5
stash
CharLotteiu Nov 30, 2020
b416d32
Merge remote-tracking branch 'upstream/master' into add-vale-test
CharLotteiu Nov 30, 2020
87d9559
simplify rules and test
CharLotteiu Nov 30, 2020
ee28ae9
refine file format
CharLotteiu Nov 30, 2020
5008cf1
delete some test files
CharLotteiu Nov 30, 2020
1013ecc
Merge branch 'master' into add-vale-test
CharLotteiu Nov 30, 2020
14bcd20
update rules
CharLotteiu Nov 30, 2020
babb990
Merge branch 'add-vale-test' of https://github.com/CharLotteiu/docs i…
CharLotteiu Nov 30, 2020
c95ff64
Merge remote-tracking branch 'origin/count-terms'
CharLotteiu Jul 13, 2021
03fdab5
delete unnecessary rules
CharLotteiu Jul 13, 2021
3f2dfd6
Merge remote-tracking branch 'upstream/master' into add-vale-test
CharLotteiu Jul 13, 2021
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
7 changes: 7 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,13 @@ jobs:
wget https://raw.githubusercontent.com/CharLotteiu/pingcap-docs-checks/main/check-manual-line-breaks.py
python3 check-manual-line-breaks.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')

- run:
name: "Vale linter"
command: |
sudo curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s latest
export PATH="./bin:$PATH"
vale $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')

build:
docker:
- image: andelf/doc-build:0.1.9
Expand Down
5 changes: 5 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
StylesPath = styles
MinAlertLevel = error

[*.md]
BasedOnStyles = Google, PingCAP
19 changes: 19 additions & 0 deletions a-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Distinct Optimization
summary: Introduce the `distinct` optimization in the TiDB query optimizer.
---

# Migrate from Azure to TiDB

This document introduces the `distinct` optimization in the TiDB query optimizer, including `SELECT DISTINCT` and `DISTINCT` in the aggregate functions.

## Distinct Optimize

The `DISTINCT` modifier specifies removal of duplicate rows from the result set. `SELECT DISTINCT` is transformed to `GROUP BY`, for example:

* Check whether the TiKV process is normal, the network is isolated, and the load is too high, and recover the service as much as possible.
* This document introduces its concept, implementation principles, auto-increment related features and restrictions.

### Distinct Data

The value of this parameter should be between 7 - 10 in github.
Loading