rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-01-06 05:12:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: use toml2docs to generate config docs (#3704)

Browse Source 
* refactor: use toml2docs to generate config docs

* ci: add docs check in 'check-typos-and-docs'
This commit is contained in:
zyy17
2024-04-15 17:08:32 +08:00
committed by GitHub
parent e6507aaf34
commit 8060c81e1d
8 changed files with 1386 additions and 398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.github/workflows/develop.yml vendored
View File

@@ -33,12 +33,17 @@ env:
RUST_TOOLCHAIN: nightly-2023-12-19
jobs:
typos:
name: Spell Check with Typos
check-typos-and-docs:
name: Check typos and docs
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
- uses: crate-ci/typos@v1.13.10
- name: Check the config docs
run: |
make config-docs && \
git diff --name-only --exit-code ./config/config.md \
|| (echo "'config/config.md' is not up-to-date, please run 'make config-docs'." && exit 1)
check:
name: Check