Skip to content

Commit 93ef6c3

Browse files
authored
chore(docs): add instructions for regenerating component docs and licenses (vectordotdev#17828)
1 parent 77ac63c commit 93ef6c3

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

docs/DEVELOPING.md

+4
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,8 @@ Loosely, you'll need the following:
123123
- **To build Vector:** Have working Rustup, Protobuf tools, C++/C build tools (LLVM, GCC, or MSVC), Python, and Perl, `make` (the GNU one preferably), `bash`, `cmake`, `GNU coreutils`, and `autotools`.
124124
- **To run integration tests:** Have `docker` available, or a real live version of that service. (Use `AUTOSPAWN=false`)
125125
- **To run `make check-component-features`:** Have `remarshal` installed.
126+
- **To run `make check-licenses` or `cargo vdev build licenses`:** Have `rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
127+
- **To run `cargo vdev build component-docs`:** Have `cue` [installed](https://cuelang.org/docs/install/).
126128

127129
If you find yourself needing to run something inside the Docker environment described above, that's totally fine, they won't collide or hurt each other. In this case, you'd just run `make environment-generate`.
128130

@@ -156,6 +158,8 @@ cargo bench transforms::example
156158
# Format your code before pushing!
157159
make fmt
158160
cargo fmt
161+
# Build component documentation for the website
162+
cargo vdev build component-docs
159163
```
160164

161165
If you run `make` you'll see a full list of all our tasks. Some of these will start Docker containers, sign commits, or even make releases. These are not common development commands and your mileage may vary.

docs/DOCUMENTING.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ documentation in tandem with code changes.
99

1010
1. [Responsibilities](#responsibilities)
1111
2. [Reference documentation](#reference-documentation)
12-
1. [Formatting](#formatting)
13-
2. [Validating](#validating)
12+
1. [Installing CUE](#installing-cue)
13+
2. [Generating from source code](#generating-from-source-code)
14+
3. [Formatting](#formatting)
15+
4. [Validating](#validating)
1416
1. [Tips & tricks](#tips--tricks)
1517
1. [Make small incremental changes](#make-small-incremental-changes)
16-
3. [Changelog](#changelog)
17-
4. [Release highlights](#release-highlights)
18+
5. [Changelog](#changelog)
19+
6. [Release highlights](#release-highlights)
1820
1. [FAQ](#faq)
1921
1. [What makes a release highlight noteworthy?](#what-makes-a-release-highlight-noteworthy)
2022
2. [How is a release highlight different from a blog post?](#how-is-a-release-highlight-different-from-a-blog-post)
@@ -53,6 +55,15 @@ version that Vector depends on. Currently Vector is using `v0.5.0`. Using a CUE
5355
version different than this may result in CUE check/build errors. We are aiming
5456
to improve the developer experience around external tool dependencies ([#15909](https://github.com/vectordotdev/vector/issues/15909)).
5557

58+
### Generating from source code
59+
60+
Much of Vector's reference documentation is automatically compiled from source code (e.g., doc comments).
61+
To regenerate this content, run:
62+
63+
```bash
64+
cargo vdev build component-docs
65+
```
66+
5667
### Formatting
5768

5869
Vector has some CUE-related CI checks that are run whenever changes are made to

0 commit comments

Comments
 (0)