Skip to content

Commit e101610

Browse files
committed
Add PPL docs website exporter script
Signed-off-by: Kyle Hounslow <kylhouns@amazon.com>
1 parent 5f963a0 commit e101610

7 files changed

Lines changed: 252 additions & 75 deletions

File tree

docs/user/ppl/cmd/trendline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The `trendline` command calculates moving averages of fields.
66
## Syntax
77

8-
trendline [sort <[+\|-] sort-field>] [sma\|wma](number-of-datapoints, field) [as \<alias\>] [[sma\|wma](number-of-datapoints, field) [as \<alias\>]]...
8+
trendline [sort <[+\|-] sort-field>] \[sma\|wma\](number-of-datapoints, field) [as \<alias\>] [\[sma\|wma\](number-of-datapoints, field) [as \<alias\>]]...
99
* [+\|-]: optional. The plus [+] stands for ascending order and NULL/MISSING first and a minus [-] stands for descending order and NULL/MISSING last. **Default:** ascending order and NULL/MISSING first.
1010
* sort-field: mandatory when sorting is used. The field used to sort.
1111
* sma\|wma: mandatory. Simple Moving Average (sma) applies equal weighting to all values, Weighted Moving Average (wma) applies greater weight to more recent values.

docs/user/ppl/functions/cryptographic.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
### Description
66

7-
Version: 3.1.0
8-
Usage: `md5(str)` calculates the MD5 digest and returns the value as a 32 character hex string.
9-
Argument type: STRING
10-
Return type: STRING
11-
Example
7+
Version: 3.1.0
8+
Usage: `md5(str)` calculates the MD5 digest and returns the value as a 32 character hex string.
9+
Argument type: STRING
10+
Return type: STRING
11+
Example
1212

1313
```ppl
1414
source=people
@@ -31,11 +31,11 @@ fetched rows / total rows = 1/1
3131

3232
### Description
3333

34-
Version: 3.1.0
35-
Usage: `sha1(str)` returns the hex string result of SHA-1.
36-
Argument type: STRING
37-
Return type: STRING
38-
Example
34+
Version: 3.1.0
35+
Usage: `sha1(str)` returns the hex string result of SHA-1.
36+
Argument type: STRING
37+
Return type: STRING
38+
Example
3939

4040
```ppl
4141
source=people
@@ -58,12 +58,12 @@ fetched rows / total rows = 1/1
5858

5959
### Description
6060

61-
Version: 3.1.0
62-
Usage: `sha2(str, numBits)` returns the hex string result of SHA-2 family of hash functions (SHA-224, SHA-256, SHA-384, and SHA-512).
63-
The numBits indicates the desired bit length of the result, which must have a value of 224, 256, 384, or 512.
64-
Argument type: STRING, INTEGER
65-
Return type: STRING
66-
Example
61+
Version: 3.1.0
62+
Usage: `sha2(str, numBits)` returns the hex string result of SHA-2 family of hash functions (SHA-224, SHA-256, SHA-384, and SHA-512).
63+
The numBits indicates the desired bit length of the result, which must have a value of 224, 256, 384, or 512.
64+
Argument type: STRING, INTEGER
65+
Return type: STRING
66+
Example
6767

6868
```ppl
6969
source=people

docs/user/ppl/functions/datetime.md

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

33
All PPL date and time functions use the UTC time zone. Both input and output values are interpreted as UTC.
44
For instance, an input timestamp literal like '2020-08-26 01:01:01' is assumed to be in UTC, and the now()
5-
function also returns the current date and time in UTC.
5+
function also returns the current date and time in UTC.
6+
67
## ADDDATE
78

89
### Description

docs/user/ppl/functions/json.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ fetched rows / total rows = 4/4
5252

5353
### Description
5454

55-
Version: 3.1.0
56-
Limitation: Only works when plugins.calcite.enabled=true
57-
Usage: `json_valid(value)` Evaluates whether a string uses valid JSON syntax. Returns TRUE if valid, FALSE if invalid. NULL input returns NULL.
58-
Argument type: STRING
59-
Return type: BOOLEAN
60-
Example
55+
Version: 3.1.0
56+
Limitation: Only works when plugins.calcite.enabled=true
57+
Usage: `json_valid(value)` Evaluates whether a string uses valid JSON syntax. Returns TRUE if valid, FALSE if invalid. NULL input returns NULL.
58+
Argument type: STRING
59+
Return type: BOOLEAN
60+
Example
6161

6262
```ppl
6363
source=people

docs/user/ppl/general/datatypes.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
##
2-
31
# Data Types
42

53
## Overview

docs/user/ppl/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The query start with search command and then flowing a set of command delimited
1111

1212
for example, the following query retrieve firstname and lastname from accounts if age large than 18.
1313

14-
```
14+
```ppl ignore
1515
source=accounts
1616
| where age > 18
1717
| fields firstname, lastname

0 commit comments

Comments
 (0)