Skip to content

Commit

Permalink
fix(external docs): add CI flag and use cue.sh (#21634)
Browse files Browse the repository at this point in the history
* fix(external docs): add CI flag and use cue.sh

* cd ..

* add extra context

* revert accidental edit
  • Loading branch information
pront authored Oct 28, 2024
1 parent b242e4a commit 42e2bb6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/DOCUMENTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ properly formatted. To run CUE's autoformatting, first [install cue](https://cue
then run this command from the `vector` root:

```bash
cue fmt ./website/**/*.cue
./website/scripts/cue.sh fmt
```

If that rewrites any files, make sure to commit your changes or else you'll see
Expand All @@ -85,9 +85,13 @@ the provided data needs to conform to various CUE schemas. To check the validity
of the CUE sources:

```bash
make check-docs
cd .. # Change to the repo root directory
CI=true make check-docs
```

> When the CI flag is on, then the checker will also run a CUE format validation step.
> Also, note that when this flag on, CUE files might be modified. See `scripts/check-docs.sh` for details.
#### Tips & tricks

##### Make small incremental changes
Expand Down

0 comments on commit 42e2bb6

Please sign in to comment.