From 60f5fe091dfb73139945c931a4fab2164d59cc92 Mon Sep 17 00:00:00 2001 From: gabriel376 Date: Tue, 30 Jan 2024 12:59:43 -0300 Subject: [PATCH] chore(docs): suggest make generate-component-docs (#19740) * chore(docs): fix CONTRIBUTING.md path * chore(docs): suggest make generate-component-docs --- docs/DOCUMENTING.md | 2 +- docs/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/DOCUMENTING.md b/docs/DOCUMENTING.md index 106106592a1ff..c84b6fa373d6a 100644 --- 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 index 68b4476de2ea1..cb3ed925a1158 100644 --- 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