chore(vdev): Update README.md and cleanup unused commands (#24936)

* chore(vdev): Update README.md and cleanup unused commands

* Update spelling allow/expect

Author: thomasqueirozb

.github/actions/spelling/allow.txt

@@ -60,6 +60,7 @@ Bedove
 Benss
 bigendian
 bindir
+binstall
 binfmt
 bitcast
 bitcode

.github/actions/spelling/expect.txt

@@ -170,11 +170,13 @@ duser
 dynamicwireless
 dyno
 ebfcee
+ector
 edenhill
 edns
 eeyun
 efgh
 Elhage
+elopment
 emerg
 endianess
 endler

vdev/README.md

@@ -1,81 +1,77 @@
 # vdev
 
------
+---
 
-This is the command line tooling for Vector development.
+The V(ector) Dev(elopment) tool.
+
+This is the command line tooling for Vector development. You don't need to use or install this
+unless you are doing development in the Vector repo.
 
 Table of Contents:
 
+- [Pre-requisites](#pre-requisites)
 - [Installation](#installation)
-- [Configuration](#configuration)
-  - [Repository](#repository)
-  - [Starship](#starship)
-- [CLI](#cli)
 - [Running Tests](#running-tests)
+  - [Running Integration tests](#running-integration-tests)
+- [Developing vdev](#developing-vdev)
 
 ## Pre-requisites
 
 This assumes that you have the following tools installed:
 
-- cargo-nextest - https://nexte.st/
+- [git](https://git-scm.com/)
+- [cargo](https://rustup.rs/)
+- [docker](https://www.docker.com/)
+- [npm](https://www.npmjs.com/)
+- [ruby](https://www.ruby-lang.org/en/)
+
+Some other tools may need to be installed depending on the command you are running. All other
+dependencies can be installed by running
+
+```sh
+./scripts/environment/prepare.sh
+```
 
 ## Installation
 
+Note that installation is not required, since `cargo vdev` commands will invoke vdev from within the
+repository.
+
 Run the following command from the root of the Vector repository:
 
-```text
+```sh
 cargo install -f --path vdev
 ```
 
-## Configuration
-
-### Repository
+You can also install vdev from [crates.io](https://crates.io/crates/vdev)
 
-Setting the path to the repository explicitly allows the application to be used at any time no matter the current working directory.
-
-```text
-vdev config set repo .
+```sh
+cargo install vdev
 ```
 
-To test, enter your home directory and then run:
+Or using [binstall](https://github.com/cargo-bins/cargo-binstall), which will download a
+pre-compiled binary (fastest)
 
-```text
-vdev exec ls
+```sh
+cargo binstall vdev
 ```
 
-### Starship
-
-A custom command for the [Starship](https://starship.rs) prompt is available.
 
-```toml
-format = """
-...
-${custom.vdev}\
-...
-$line_break\
-...
-$character"""
+## Running Tests
 
-# <clipped>
+Unit tests can be run by calling `make test`.
 
-[custom.vdev]
-command = "vdev meta starship"
-when = true
-# Windows
-# shell = ["cmd", "/C"]
-# Other
-# shell = ["sh", "--norc"]
-```
+### Running Integration tests
 
-## CLI
+Integration tests require docker or podman to run.
 
-The CLI uses [Clap](https://github.com/clap-rs/clap) with the `derive` construction mechanism and is stored in the [commands](src/commands) directory.
+Integration tests are not run by default when running `make test`. Instead, they are accessible via the integration subcommand `cargo vdev int` (example: `cargo vdev int test aws` runs aws-related integration tests).
 
-Every command group/namespace has its own directory with a `cli` module, including the root `vdev` command group. All commands have an `exec` method that provides the actual implementation, which in the case of command groups will be calling sub-commands.
+You should use `./scripts/run-integration-test.sh`, which is the wrapper used by CI and which suits most development needs. Integration tests require a `cargo vdev int start`, `cargo vdev int test`, and `cargo vdev int stop`, which the script handles automatically. You can find the list of available integration tests using `cargo vdev int show`.
 
 
-## Running Tests
+## Developing vdev
 
-Unit tests can be run by calling `cargo vdev test`.
+The CLI uses [Clap](https://github.com/clap-rs/clap) with the `derive` construction mechanism and is stored in the [commands](src/commands) directory.
 
-Integration tests are not run by default when running `cargo vdev test`. Instead, they are accessible via the integration subcommand (example: `cargo vdev int test aws` runs aws-related integration tests). You can find the list of available integration tests using `cargo vdev int show`. Integration tests require docker or podman to run.
+Every command group/namespace has its own directory with a `cli` module, including the root `vdev` command group. All commands have an `exec` method that provides the actual implementation, which in the case of command groups will be calling sub-commands.

vdev/src/commands/exec.rs

@@ -1,8 +1,6 @@
 mod install_git_hooks;
-mod starship;
 
 crate::cli_subcommands! {
     "Collection of meta-utilities..."
-    starship,
     install_git_hooks,
 }

vdev/src/commands/meta/mod.rs

@@ -72,7 +72,6 @@ mod check;
 mod complete;
 mod crate_versions;
 mod e2e;
-mod exec;
 mod features;
 mod fmt;
 mod info;
@@ -92,7 +91,6 @@ cli_commands! {
     complete,
     crate_versions,
     e2e,
-    exec,
     features,
     fmt,
     info,