10000 Add YAML-based documentation for Metrics v2 (#712) · arangodb/docs@f7d6280 · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit f7d6280

Browse files
Simran-BSimran-B
authored
Add YAML-based documentation for Metrics v2 (#712)
* Remove hand-written section, extend include and update for Metrics v2 * Add 3.x/generated/allMetrics.yaml and symlinks 3.x-allMetrics.yaml in _data * Remove Grafana mention (at least for now) * Add Liquid filters is_set and has_key that prevent silent failure of the metrics include if it isn't used correctly or the source file is missing * Avoid having to adjust the version number for program option includes by using page.version.version (with the dot removed)
1 parent 609b298 commit f7d6280

File tree

52 files changed

+13236
-472
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+13236
-472
lines changed

‎3.6/programs-arangobackup-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Usage: `arangobackup <operation> [<options>]`
1010
The `--operation` option can be passed as positional argument to specify the
1111
desired action.
1212

13-
{% assign options = site.data["36-program-options-arangobackup"] %}
13+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangobackup" -%}
14+
{% assign options = site.data[optionsFile] -%}
1415
{% include program-option.html options=options name="arangobackup" %}

‎3.6/programs-arangobench-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Arangobench Startup Options
77

88
Usage: `arangobench [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangobench"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangobench" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangobench" %}
1213

1314
Notes

‎3.6/programs-arangod-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ See
3030
[Fetch Current Configuration Options](administration-configuration.html#fetch-current-configuration-options)
3131
if you want to query the `arangod` server for the current settings at runtime.
3232

33-
{% assign options = site.data["36-program-options-arangod"] %}
33+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangod" -%}
34+
{% assign options = site.data[optionsFile] -%}
3435
{% include program-option.html options=options name="arangod" %}

‎3.6/programs-arangodump-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Arangodump Options
77

88
Usage: `arangodump [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangodump"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangodump" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangodump" %}
1213

1314
Notes

‎3.6/programs-arangoexport-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangoexport Options
77

88
Usage: `arangoexport [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangoexport"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangoexport" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangoexport" %}

‎3.6/programs-arangoimport-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangoimport Options
77

88
Usage: `arangoimport [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangoimport"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangoimport" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangoimport" %}

‎3.6/programs-arangoinspect-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangoinspect Options
77

88
Usage: `arangoinspect [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangoinspect"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangoinspect" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangoinspect" %}

‎3.6/programs-arangorestore-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangorestore Options
77

88
Usage: `arangorestore [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangorestore"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangorestore" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangorestore" %}

‎3.6/programs-arangosh-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangosh Options
77

88
Usage: `arangosh [<options>]`
99

10-
{% assign options = site.data["36-program-options-arangosh"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangosh" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangosh" %}

‎3.7/programs-arangobackup-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Usage: `arangobackup <operation> [<options>]`
1010
The `--operation` option can be passed as positional argument to specify the
1111
desired action.
1212

13-
{% assign options = site.data["37-program-options-arangobackup"] %}
13+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangobackup" -%}
14+
{% assign options = site.data[optionsFile] -%}
1415
{% include program-option.html options=options name="arangobackup" %}

‎3.7/programs-arangobench-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Arangobench Startup Options
77

88
Usage: `arangobench [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangobench"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangobench" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangobench" %}
1213

1314
Notes

‎3.7/programs-arangod-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ See
3030
[Fetch Current Configuration Options](administration-configuration.html#fetch-current-configuration-options)
3131
if you want to query the `arangod` server for the current settings at runtime.
3232

33-
{% assign options = site.data["37-program-options-arangod"] %}
33+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangod" -%}
34+
{% assign options = site.data[optionsFile] -%}
3435
{% include program-option.html options=options name="arangod" %}

‎3.7/programs-arangodump-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Arangodump Options
77

88
Usage: `arangodump [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangodump"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangodump" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangodump" %}
1213

1314
Notes

‎3.7/programs-arangoexport-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangoexport Options
77

88
Usage: `arangoexport [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangoexport"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangoexport" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangoexport" %}

‎3.7/programs-arangoimport-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangoimport Options
77

88
Usage: `arangoimport [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangoimport"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangoimport" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangoimport" %}

‎3.7/programs-arangoinspect-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangoinspect Options
77

88
Usage: `arangoinspect [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangoinspect"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangoinspect" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangoinspect" %}

‎3.7/programs-arangorestore-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangorestore Options
77

88
Usage: `arangorestore [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangorestore"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangorestore" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangorestore" %}

‎3.7/programs-arangosh-options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Arangosh Options
77

88
Usage: `arangosh [<options>]`
99

10-
{% assign options = site.data["37-program-options-arangosh"] %}
10+
{% assign optionsFile = page.version.version | remove: "." | append: "-program-options-arangosh" -%}
11+
{% assign options = site.data[optionsFile] -%}
1112
{% include program-option.html options=options name="arangosh" %}

0 commit comments

Comments
 (0)
0