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

chore(docs): add instructions for regenerating component docs and licenses #17828

Merged
merged 1 commit into from
Jul 1, 2023
Merged

chore(docs): add instructions for regenerating component docs and licenses #17828

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
4 changes: 4 additions & 0 deletions docs/DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Loosely, you'll need the following:
- **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`.
- **To run integration tests:** Have `docker` available, or a real live version of that service. (Use `AUTOSPAWN=false`)
- **To run `make check-component-features`:** Have `remarshal` installed.
- **To run `make check-licenses` or `cargo vdev build licenses`:** Have `rust-license-tool` [installed](https://github.com/DataDog/rust-license-tool).
- **To run `cargo vdev build component-docs`:** Have `cue` [installed](https://cuelang.org/docs/install/).

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`.

Expand Down Expand Up @@ -156,6 +158,8 @@ cargo bench transforms::example
# Format your code before pushing!
make fmt
cargo fmt
# Build component documentation for the website
cargo vdev build component-docs
```

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.
Expand Down
19 changes: 15 additions & 4 deletions docs/DOCUMENTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ documentation in tandem with code changes.

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

### Generating from source code

Much of Vector's reference documentation is automatically compiled from source code (e.g., doc comments).
To regenerate this content, run:

```bash
cargo vdev build component-docs
```

### Formatting

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