Skip to content

Commit

Permalink
Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maeb committed Apr 4, 2022
1 parent c86981f commit b111960
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/veidemannctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ veidemannctl [flags]
* [veidemannctl login](veidemannctl_login.md) - Initiate browser session for logging in to Veidemann
* [veidemannctl logout](veidemannctl_logout.md) - Log out of Veidemann
* [veidemannctl pause](veidemannctl_pause.md) - Pause crawler
* [veidemannctl report](veidemannctl_report.md) - Get log report
* [veidemannctl report](veidemannctl_report.md) - Get report
* [veidemannctl run](veidemannctl_run.md) - Immediately run a crawl
* [veidemannctl script-parameters](veidemannctl_script-parameters.md) - Get the active script parameters for a Crawl Job
* [veidemannctl status](veidemannctl_status.md) - Get crawler status
Expand Down
4 changes: 0 additions & 4 deletions docs/veidemannctl_logconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ Configure logging

Configure logging.

```
veidemannctl logconfig [flags]
```

### Options

```
Expand Down
8 changes: 2 additions & 6 deletions docs/veidemannctl_report.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
## veidemannctl report

Get log report
Get report

### Synopsis

Request a report.

```
veidemannctl report [flags]
```

### Options

```
Expand All @@ -34,5 +30,5 @@ veidemannctl report [flags]
* [veidemannctl report crawllog](veidemannctl_report_crawllog.md) - View crawl log
* [veidemannctl report jobexecution](veidemannctl_report_jobexecution.md) - Get current status for job executions
* [veidemannctl report pagelog](veidemannctl_report_pagelog.md) - View page log
* [veidemannctl report query](veidemannctl_report_query.md) - Run a databse query
* [veidemannctl report query](veidemannctl_report_query.md) - Run a database query

9 changes: 7 additions & 2 deletions docs/veidemannctl_report_crawlexecution.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,18 @@ veidemannctl report crawlexecution [flags]
### Options

```
--desc Order descending
-f, --filename string File name to write to
-q, --filter string Filter objects by field (i.e. meta.description=foo
-q, --filter strings Filter objects by field (i.e. meta.description=foo)
--from string From start time
-h, --help help for crawlexecution
--order-by string Order by path
-o, --output string Output format (table|wide|json|yaml|template|template-file) (default "table")
-p, --page int32 The page number
-s, --pagesize int32 Number of objects to get (default 10)
--state strings Filter objects by state. Valid states are UNDEFINED, FETCHING, SLEEPING, FINISHED or FAILED
-t, --template string A Go template used to format the output
--to string To start time
-w, --watch Get a continous stream of changes
```

Expand All @@ -36,5 +41,5 @@ veidemannctl report crawlexecution [flags]

### SEE ALSO

* [veidemannctl report](veidemannctl_report.md) - Get log report
* [veidemannctl report](veidemannctl_report.md) - Get report

2 changes: 1 addition & 1 deletion docs/veidemannctl_report_crawllog.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ veidemannctl report crawllog [flags]

### SEE ALSO

* [veidemannctl report](veidemannctl_report.md) - Get log report
* [veidemannctl report](veidemannctl_report.md) - Get report

9 changes: 7 additions & 2 deletions docs/veidemannctl_report_jobexecution.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,18 @@ veidemannctl report jobexecution [flags]
### Options

```
--desc Order descending
-f, --filename string File name to write to
-q, --filter string Filter objects by field (i.e. meta.description=foo
-q, --filter strings Filter objects by field (i.e. meta.description=foo
--from string From start time
-h, --help help for jobexecution
--order-by string Order by path
-o, --output string Output format (table|wide|json|yaml|template|template-file) (default "table")
-p, --page int32 The page number
-s, --pagesize int32 Number of objects to get (default 10)
--state strings Filter objects by state(s)
-t, --template string A Go template used to format the output
--to string To start time
-w, --watch Get a continous stream of changes
```

Expand All @@ -36,5 +41,5 @@ veidemannctl report jobexecution [flags]

### SEE ALSO

* [veidemannctl report](veidemannctl_report.md) - Get log report
* [veidemannctl report](veidemannctl_report.md) - Get report

2 changes: 1 addition & 1 deletion docs/veidemannctl_report_pagelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ veidemannctl report pagelog [flags]

### SEE ALSO

* [veidemannctl report](veidemannctl_report.md) - Get log report
* [veidemannctl report](veidemannctl_report.md) - Get report

6 changes: 3 additions & 3 deletions docs/veidemannctl_report_query.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## veidemannctl report query

Run a databse query
Run a database query

### Synopsis

Run a databse query. The query should be a java script string like the ones used by RethinkDb javascript driver.
Run a database query. The query should be a java script string like the ones used by RethinkDb javascript driver.

```
veidemannctl report query [queryString|file] args... [flags]
Expand Down Expand Up @@ -34,5 +34,5 @@ veidemannctl report query [queryString|file] args... [flags]

### SEE ALSO

* [veidemannctl report](veidemannctl_report.md) - Get log report
* [veidemannctl report](veidemannctl_report.md) - Get report

0 comments on commit b111960

Please sign in to comment.