Skip to content
This repository was archived by the owner on Feb 13, 2024. It is now read-only.

Commit b7aa1e1

Browse files
lechnerc77lechnerc77
authored
Finalization of docu generation (#283)
finalize docu generation and enhance README.md
1 parent 90a4903 commit b7aa1e1

File tree

4,024 files changed

+69102
-8
lines changed

Some content is hidden

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

4,024 files changed

+69102
-8
lines changed

‎.github/workflows/generate-param-docu.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Generate Parameter Documentation
2-
# Based on the JSON schemas available for the parameter.json and usecase.json we generate the documentation as markdown
2+
# Based on the JSON schemas available for the parameters.json and usecase.json we generate the documentation as markdown
33

44
on:
55
workflow_dispatch:
@@ -15,19 +15,20 @@ jobs:
1515
uses: actions/setup-node@v3
1616
with:
1717
node-version: '18'
18-
18+
1919
- name: Install jsonschema2md
20-
run: npm install -g jsonschema2md
21-
20+
run: npm install -g @adobe/jsonschema2md
21+
2222
- name: Create/Clear output folder
2323
run: |
2424
mkdir -p docs/generated/
2525
rm -rf docs/generated/*
2626
27+
2728
- name: Copy base files to output folder
2829
run: |
2930
cp libs/btpsa-parameters.json docs/generated/
30-
cp libs/btpsa-usecases.json docs/generated/
31+
cp libs/btpsa-usecase.json docs/generated/
3132
3233
- name: Generate documentation
3334
run: jsonschema2md -d "docs/generated/" -o "docs/generated/" -e json -v 07 -h false -x -
@@ -36,13 +37,13 @@ jobs:
3637
# remove the source files as well as the generated main README.md
3738
run: |
3839
rm docs/generated/btpsa-parameters.json
39-
rm docs/generated/btpsa-usecases.json
40+
rm docs/generated/btpsa-usecase.json
4041
rm docs/generated/README.md
4142
4243
- name: Commit and push changes
4344
run: |
4445
git add -A
4546
git config user.email "[email protected]"
4647
git config user.name "[btpsa bot] docu generation"
47-
git diff --quiet && git diff --staged --quiet || git commit -m "[bot] Add dev.to link to metadata"
48-
git push origin main
48+
git diff --quiet && git diff --staged --quiet || git commit -m "[btpsa bot] Generate parameter documentation"
49+
git push

‎docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,3 +203,14 @@ docker container wait test01
203203
docker container rm -f test01
204204
docker image rmi -f test01
205205
```
206+
207+
## Documentation of the parameters
208+
209+
As we have seen the setup-automator is configured via the `parameters.json` and the `usecase.json` files. These fies allow an extensive configuration of the setup-automator. You find the documentation of the possible parameters of the files here:
210+
211+
- `parameters.json`: [Link](./generated/btpsa-parameters.md)
212+
- `usecase.json`: [Link](./generated/btpsa-usecase.md)
213+
214+
*Be ware that the documentation is generated via [JSON Schema Markdown Tools](https://github.com/adobe/jsonschema2md) which gives us some rough edges in the documentation when it comes to the allowed values.*
215+
216+
> 📝 Tip - The `parameters.json` and the `usecase.json` files are backed by a [JSON schema](https://json-schema.org/). This helps you when editing the files via type-ahead support, so no need to have the documentation open side-by-side to check for possible values. Indeed the documentation is generated based on the JSON schemas.

‎docs/generated/btpsa-parameters-allof-0-if-properties-region-anyof-0.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## 0 Type
2+
3+
unknown
4+
5+
## 0 Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :------- | :---------- |
11+
| `"us10"` | |
12+
| `"eu10"` | |
13+
| `"br10"` | |
14+
| `"jp10"` | |
15+
| `"ca10"` | |
16+
| `"ap12"` | |
17+
| `"ap10"` | |
18+
| `"ap11"` | |

‎docs/generated/btpsa-parameters-allof-0-if-properties-region.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## region Type
2+
3+
merged type ([Details](btpsa-parameters-allof-0-if-properties-region.md))
4+
5+
any of
6+
7+
* [Untitled undefined type in JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-0-if-properties-region-anyof-0.md "check type definition")

‎docs/generated/btpsa-parameters-allof-0-if-properties.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## properties Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-0-if.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## if Type
2+
3+
unknown
4+
5+
# if Properties
6+
7+
| Property | Type | Required | Nullable | Defined by |
8+
| :---------------- | :----- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| [region](#region) | Merged | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-0-if-properties-region.md "undefined#/allOf/0/if/properties/region") |
10+
11+
## region
12+
13+
14+
15+
`region`
16+
17+
* is optional
18+
19+
* Type: merged type ([Details](btpsa-parameters-allof-0-if-properties-region.md))
20+
21+
* cannot be null
22+
23+
* defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-0-if-properties-region.md "undefined#/allOf/0/if/properties/region")
24+
25+
### region Type
26+
27+
merged type ([Details](btpsa-parameters-allof-0-if-properties-region.md))
28+
29+
any of
30+
31+
* [Untitled undefined type in JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-0-if-properties-region-anyof-0.md "check type definition")

‎docs/generated/btpsa-parameters-allof-0-then-properties-clusterregion.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## clusterregion Type
2+
3+
unknown
4+
5+
## clusterregion Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :----------------- | :---------- |
11+
| `"eu-central-1"` | |
12+
| `"eu-west-2"` | |
13+
| `"ca-central-1"` | |
14+
| `"sa-east-1"` | |
15+
| `"us-east-1"` | |
16+
| `"us-west-1"` | |
17+
| `"ap-northeast-1"` | |
18+
| `"ap-northeast-2"` | |
19+
| `"ap-south-1"` | |
20+
| `"ap-southeast-1"` | |
21+
| `"ap-southeast-2"` | |

‎docs/generated/btpsa-parameters-allof-0-then-properties.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## properties Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-0-then.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## then Type
2+
3+
unknown
4+
5+
# then Properties
6+
7+
| Property | Type | Required | Nullable | Defined by |
8+
| :------------------------------ | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| [clusterregion](#clusterregion) | Not specified | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-0-then-properties-clusterregion.md "undefined#/allOf/0/then/properties/clusterregion") |
10+
11+
## clusterregion
12+
13+
14+
15+
`clusterregion`
16+
17+
* is optional
18+
19+
* Type: unknown
20+
21+
* cannot be null
22+
23+
* defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-0-then-properties-clusterregion.md "undefined#/allOf/0/then/properties/clusterregion")
24+
25+
### clusterregion Type
26+
27+
unknown
28+
29+
### clusterregion Constraints
30+
31+
**enum**: the value of this property must be equal to one of the following values:
32+
33+
| Value | Explanation |
34+
| :----------------- | :---------- |
35+
| `"eu-central-1"` | |
36+
| `"eu-west-2"` | |
37+
| `"ca-central-1"` | |
38+
| `"sa-east-1"` | |
39+
| `"us-east-1"` | |
40+
| `"us-west-1"` | |
41+
| `"ap-northeast-1"` | |
42+
| `"ap-northeast-2"` | |
43+
| `"ap-south-1"` | |
44+
| `"ap-southeast-1"` | |
45+
| `"ap-southeast-2"` | |

‎docs/generated/btpsa-parameters-allof-0.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 0 Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-1-if-properties-region-anyof-0.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## 0 Type
2+
3+
unknown
4+
5+
## 0 Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :------- | :---------- |
11+
| `"us30"` | |

‎docs/generated/btpsa-parameters-allof-1-if-properties-region.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## region Type
2+
3+
merged type ([Details](btpsa-parameters-allof-1-if-properties-region.md))
4+
5+
any of
6+
7+
* [Untitled undefined type in JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-1-if-properties-region-anyof-0.md "check type definition")

‎docs/generated/btpsa-parameters-allof-1-if-properties.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## properties Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-1-if.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## if Type
2+
3+
unknown
4+
5+
# if Properties
6+
7+
| Property | Type | Required | Nullable | Defined by |
8+
| :---------------- | :----- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| [region](#region) | Merged | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-1-if-properties-region.md "undefined#/allOf/1/if/properties/region") |
10+
11+
## region
12+
13+
14+
15+
`region`
16+
17+
* is optional
18+
19+
* Type: merged type ([Details](btpsa-parameters-allof-1-if-properties-region.md))
20+
21+
* cannot be null
22+
23+
* defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-1-if-properties-region.md "undefined#/allOf/1/if/properties/region")
24+
25+
### region Type
26+
27+
merged type ([Details](btpsa-parameters-allof-1-if-properties-region.md))
28+
29+
any of
30+
31+
* [Untitled undefined type in JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-1-if-properties-region-anyof-0.md "check type definition")

‎docs/generated/btpsa-parameters-allof-1-then-properties-clusterregion.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## clusterregion Type
2+
3+
unknown
4+
5+
## clusterregion Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :--------------- | :---------- |
11+
| `"asia-south1"` | |
12+
| `"us-central1"` | |
13+
| `"europe-west3"` | |

‎docs/generated/btpsa-parameters-allof-1-then-properties.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## properties Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-1-then.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## then Type
2+
3+
unknown
4+
5+
# then Properties
6+
7+
| Property | Type | Required | Nullable | Defined by |
8+
| :------------------------------ | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| [clusterregion](#clusterregion) | Not specified | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-1-then-properties-clusterregion.md "undefined#/allOf/1/then/properties/clusterregion") |
10+
11+
## clusterregion
12+
13+
14+
15+
`clusterregion`
16+
17+
* is optional
18+
19+
* Type: unknown
20+
21+
* cannot be null
22+
23+
* defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-1-then-properties-clusterregion.md "undefined#/allOf/1/then/properties/clusterregion")
24+
25+
### clusterregion Type
26+
27+
unknown
28+
29+
### clusterregion Constraints
30+
31+
**enum**: the value of this property must be equal to one of the following values:
32+
33+
| Value | Explanation |
34+
| :--------------- | :---------- |
35+
| `"asia-south1"` | |
36+
| `"us-central1"` | |
37+
| `"europe-west3"` | |

‎docs/generated/btpsa-parameters-allof-1.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 1 Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-2-if-properties-region-anyof-0.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## 0 Type
2+
3+
unknown
4+
5+
## 0 Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :------- | :---------- |
11+
| `"ap21"` | |
12+
| `"us20"` | |
13+
| `"jp20"` | |
14+
| `"us21"` | |
15+
| `"eu20"` | |

‎docs/generated/btpsa-parameters-allof-2-if-properties-region.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## region Type
2+
3+
merged type ([Details](btpsa-parameters-allof-2-if-properties-region.md))
4+
5+
any of
6+
7+
* [Untitled undefined type in JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-2-if-properties-region-anyof-0.md "check type definition")

‎docs/generated/btpsa-parameters-allof-2-if-properties.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## properties Type
2+
3+
unknown

‎docs/generated/btpsa-parameters-allof-2-if.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## if Type
2+
3+
unknown
4+
5+
# if Properties
6+
7+
| Property | Type | Required | Nullable | Defined by |
8+
| :---------------- | :----- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| [region](#region) | Merged | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-2-if-properties-region.md "undefined#/allOf/2/if/properties/region") |
10+
11+
## region
12+
13+
14+
15+
`region`
16+
17+
* is optional
18+
19+
* Type: merged type ([Details](btpsa-parameters-allof-2-if-properties-region.md))
20+
21+
* cannot be null
22+
23+
* defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-2-if-properties-region.md "undefined#/allOf/2/if/properties/region")
24+
25+
### region Type
26+
27+
merged type ([Details](btpsa-parameters-allof-2-if-properties-region.md))
28+
29+
any of
30+
31+
* [Untitled undefined type in JSON Schema for service parameters used in BTPSA](btpsa-parameters-allof-2-if-properties-region-anyof-0.md "check type definition")

‎docs/generated/btpsa-parameters-allof-2-then-properties-clusterregion.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## clusterregion Type
2+
3+
unknown
4+
5+
## clusterregion Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :---------------- | :---------- |
11+
| `"centralus"` | |
12+
| `"eastus"` | |
13+
| `"westus2"` | |
14+
| `"northeurope"` | |
15+
| `"uksouth"` | |
16+
| `"japaneast"` | |
17+
| `"southeastasia"` | |
18+
| `"westeurope"` | |

0 commit comments

Comments
 (0)