Skip to content

Commit 4d8d53f

Browse files
authored
Fix formatting in CLI design doc (#1934)
1 parent 3610610 commit 4d8d53f

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

Diff for: docs/design-documents/20241024-conduit-cli.md

+29-28
Original file line numberDiff line numberDiff line change
@@ -214,14 +214,15 @@ It requires the pipeline id as argument.
214214

215215
#### Arguments
216216

217-
| Name | Description | Required | Default Value |
218-
|------|-------------|----------|---------------|
219-
| id | pipeline id to describe | Yes | |
217+
| Name | Description | Required | Default Value |
218+
|------|-------------------------|----------|---------------|
219+
| id | pipeline id to describe | Yes | |
220220

221221
#### Flags
222222

223-
| Name | Description | Required | Default Value |
224-
| grpc.address | address for serving the gRPC API | No | ":8084" |
223+
| Name | Description | Required | Default Value |
224+
|--------------|----------------------------------|----------|---------------|
225+
| grpc.address | address for serving the gRPC API | No | ":8084" |
225226

226227
#### `--help`
227228

@@ -269,15 +270,15 @@ It requires having Conduit previously running.
269270

270271
#### Arguments
271272

272-
| Name | Description | Required | Default Value |
273-
|------|-------------|----------|---------------|
274-
| id | connector id to describe | Yes | |
273+
| Name | Description | Required | Default Value |
274+
|------|--------------------------|----------|---------------|
275+
| id | connector id to describe | Yes | |
275276

276277
#### Flags
277278

278-
| Name | Description | Required | Default Value |
279-
|------|-------------|----------|---------------|
280-
| grpc.address | address for serving the gRPC API | No | ":8084" |
279+
| Name | Description | Required | Default Value |
280+
|--------------|----------------------------------|----------|---------------|
281+
| grpc.address | address for serving the gRPC API | No | ":8084" |
281282

282283
#### `--help`
283284

@@ -314,9 +315,9 @@ It does not require having Conduit previously running.
314315

315316
#### Arguments
316317

317-
| Name | Description | Required | Default Value |
318-
|------|-------------|----------|---------------|
319-
| PLUGIN | connector plugin to describe | Yes | |
318+
| Name | Description | Required | Default Value |
319+
|--------|------------------------------|----------|---------------|
320+
| PLUGIN | connector plugin to describe | Yes | |
320321

321322
#### `--help`
322323

@@ -338,9 +339,9 @@ It requires having Conduit previously running.
338339

339340
#### Flags
340341

341-
| Name | Description | Required | Default Value |
342-
|------|-------------|----------|---------------|
343-
| grpc.address | address for serving the gRPC API | No | ":8084" |
342+
| Name | Description | Required | Default Value |
343+
|--------------|----------------------------------|----------|---------------|
344+
| grpc.address | address for serving the gRPC API | No | ":8084" |
344345

345346
#### `--help`
346347

@@ -360,9 +361,9 @@ It requires having Conduit previously running.
360361

361362
#### Arguments
362363

363-
| Name | Description | Required | Default Value |
364-
|------|-------------|----------|---------------|
365-
| id | processor ID | Yes | |
364+
| Name | Description | Required | Default Value |
365+
|------|--------------|----------|---------------|
366+
| id | processor ID | Yes | |
366367

367368
#### `--help`
368369

@@ -400,9 +401,9 @@ It does not require having Conduit previously running.
400401

401402
#### Arguments
402403

403-
| Name | Description | Required | Default Value |
404-
|------|-------------|----------|---------------|
405-
| plugin | processor plugin name | Yes | |
404+
| Name | Description | Required | Default Value |
405+
|--------|-----------------------|----------|---------------|
406+
| plugin | processor plugin name | Yes | |
406407

407408
#### `--help`
408409

@@ -435,8 +436,8 @@ conduit version
435436
436437
#### Global flags
437438
438-
| Name | Description | Required | Default Value |
439-
|------|-------------|----------|---------------|
440-
| config.path | path to the Conduit working environment | No | `.` |
441-
| json | output json | No | |
442-
| version | prints current Conduit version (alias to `conduit version`) | No | |
439+
| Name | Description | Required | Default Value |
440+
|-------------|-------------------------------------------------------------|----------|---------------|
441+
| config.path | path to the Conduit working environment | No | `.` |
442+
| json | output json | No | |
443+
| version | prints current Conduit version (alias to `conduit version`) | No | |

0 commit comments

Comments
 (0)