From 4b2b7130e71d82fbbebce91cfab4f0c5afbfa2fe Mon Sep 17 00:00:00 2001 From: neuronull Date: Wed, 11 Jan 2023 11:50:59 -0700 Subject: [PATCH] chore(internal docs): add note about cue versioning (#15910) Add note about CUE versioning --- docs/DOCUMENTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/DOCUMENTING.md b/docs/DOCUMENTING.md index a90f8c6408bf1..649feebc95177 100644 --- a/docs/DOCUMENTING.md +++ b/docs/DOCUMENTING.md @@ -45,6 +45,14 @@ is driven by structured data defined in the [`/website/cue`](../website/cue) directory. [CUE](https://cuelang.org) is a declarative configuration language suitable for complex data definitions. +### Installing CUE + +Cue can be [installed](https://cuelang.org/docs/install/) from package managers, +however it may be necesary to install it from source in order to use the correct +version that Vector depends on. Currently Vector is using `v0.4.2`. 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)). + ### Formatting Vector has some CUE-related CI checks that are run whenever changes are made to