From b1119602a5caca38f4d0fd43204c6f3a9114d46b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marius=20Andr=C3=A9=20Elsfjordstrand=20Beck?= Date: Mon, 4 Apr 2022 10:36:03 +0200 Subject: [PATCH] Generate docs --- docs/veidemannctl.md | 2 +- docs/veidemannctl_logconfig.md | 4 ---- docs/veidemannctl_report.md | 8 ++------ docs/veidemannctl_report_crawlexecution.md | 9 +++++++-- docs/veidemannctl_report_crawllog.md | 2 +- docs/veidemannctl_report_jobexecution.md | 9 +++++++-- docs/veidemannctl_report_pagelog.md | 2 +- docs/veidemannctl_report_query.md | 6 +++--- 8 files changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/veidemannctl.md b/docs/veidemannctl.md index d8ba4d5..3afe131 100644 --- a/docs/veidemannctl.md +++ b/docs/veidemannctl.md @@ -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 diff --git a/docs/veidemannctl_logconfig.md b/docs/veidemannctl_logconfig.md index 59a87dd..8ccbb77 100644 --- a/docs/veidemannctl_logconfig.md +++ b/docs/veidemannctl_logconfig.md @@ -6,10 +6,6 @@ Configure logging Configure logging. -``` -veidemannctl logconfig [flags] -``` - ### Options ``` diff --git a/docs/veidemannctl_report.md b/docs/veidemannctl_report.md index 034a506..3f4b546 100644 --- a/docs/veidemannctl_report.md +++ b/docs/veidemannctl_report.md @@ -1,15 +1,11 @@ ## veidemannctl report -Get log report +Get report ### Synopsis Request a report. -``` -veidemannctl report [flags] -``` - ### Options ``` @@ -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 diff --git a/docs/veidemannctl_report_crawlexecution.md b/docs/veidemannctl_report_crawlexecution.md index 9922f54..4134c09 100644 --- a/docs/veidemannctl_report_crawlexecution.md +++ b/docs/veidemannctl_report_crawlexecution.md @@ -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 ``` @@ -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 diff --git a/docs/veidemannctl_report_crawllog.md b/docs/veidemannctl_report_crawllog.md index 523489a..6eb2f42 100644 --- a/docs/veidemannctl_report_crawllog.md +++ b/docs/veidemannctl_report_crawllog.md @@ -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 diff --git a/docs/veidemannctl_report_jobexecution.md b/docs/veidemannctl_report_jobexecution.md index ea60ee0..523b18a 100644 --- a/docs/veidemannctl_report_jobexecution.md +++ b/docs/veidemannctl_report_jobexecution.md @@ -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 ``` @@ -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 diff --git a/docs/veidemannctl_report_pagelog.md b/docs/veidemannctl_report_pagelog.md index 4a19b57..916bf42 100644 --- a/docs/veidemannctl_report_pagelog.md +++ b/docs/veidemannctl_report_pagelog.md @@ -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 diff --git a/docs/veidemannctl_report_query.md b/docs/veidemannctl_report_query.md index aeaa023..008993a 100644 --- a/docs/veidemannctl_report_query.md +++ b/docs/veidemannctl_report_query.md @@ -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] @@ -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