chore(docs): suggest make generate-component-docs (vectordotdev#19740)

* chore(docs): fix CONTRIBUTING.md path * chore(docs): suggest make generate-component-docs
threatcode · Jan 30, 2024 · 60f5fe0 · 60f5fe0
1 parent 83be425
commit 60f5fe0
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/DOCUMENTING.md b/docs/DOCUMENTING.md
@@ -61,7 +61,7 @@ Much of Vector's reference documentation is automatically compiled from source c
 To regenerate this content, run:
 
 ```bash
-cargo vdev build component-docs
+make generate-component-docs
 ```
 
 ### Formatting

diff --git a/docs/README.md b/docs/README.md
@@ -10,7 +10,7 @@ Whether you're a Vector team member, or an outside contributor, this is the best
 place to start. This folder contains internal documentation to help with the
 development of Vector and ensuring your change gets approved in a timely manner.
 
-1. **[CONTRIBUTING.md](CONTRIBUTING.md)** - Start here, contributor basics and workflow
+1. **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Start here, contributor basics and workflow
 2. **[DEVELOPING.md](DEVELOPING.md)** - Everything necessary to develop
 3. **[DOCUMENTING.md](DOCUMENTING.md)** - Preparing your change for Vector users