Skip to content

Commit 5529c11

Browse files
kevinwang5658kevinwang5658
committed
feat: Added documentation links to all schemas
1 parent e82c869 commit 5529c11

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

‎scripts/upload-resources.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ async function main() {
3434
plugin_id: pluginId,
3535
plugin_name: pluginName,
3636
schema: JSON.stringify(resource),
37+
documentation_url: resource.$comment,
3738
}, {onConflict: ['type', 'plugin_id']})
3839
.select();
3940

‎src/schemastore/codify-schema.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
"additionalProperties": false
3636
},
3737
{
38+
"$comment": "https://docs.codifycli.com/core-resources/git/git/",
3839
"description": "Set and manage global git settings (email and username)",
3940
"type": "object",
4041
"properties": {
@@ -93,6 +94,7 @@
9394
]
9495
},
9596
{
97+
"$comment": "https://docs.codifycli.com/core-resources/path/",
9698
"description": "Manages user paths. It will permanently save paths by adding them to the shell startup script.",
9799
"type": "object",
98100
"properties": {
@@ -139,6 +141,7 @@
139141
]
140142
},
141143
{
144+
"$comment": "https://docs.codifycli.com/core-resources/alias/",
142145
"description": "Manages user aliases. It permanently saves the alias by adding it to the shell startup script.",
143146
"type": "object",
144147
"properties": {
@@ -175,6 +178,7 @@
175178
"additionalProperties": false
176179
},
177180
{
181+
"$comment": "https://docs.codifycli.com/core-resources/homebrew/",
178182
"description": "Install homebrew and manages formulae, casks and taps.",
179183
"type": "object",
180184
"properties": {
@@ -230,6 +234,7 @@
230234
]
231235
},
232236
{
237+
"$comment": "https://docs.codifycli.com/core-resources/python/pyenv/",
233238
"type": "object",
234239
"description": "Install and manage Python versions using pyenv.",
235240
"properties": {
@@ -267,6 +272,7 @@
267272
]
268273
},
269274
{
275+
"$comment": "https://docs.codifycli.com/core-resources/git/git-lfs/",
270276
"description": "Installs git-lfs. This resource will automatically activate git-lfs as well.",
271277
"type": "object",
272278
"properties": {
@@ -293,6 +299,7 @@
293299
]
294300
},
295301
{
302+
"$comment": "https://docs.codifycli.com/core-resources/aws-cli/",
296303
"type": "object",
297304
"description": "Installs aws-cli.",
298305
"properties": {
@@ -319,6 +326,7 @@
319326
]
320327
},
321328
{
329+
"$comment": "https://docs.codifycli.com/core-resources/aws-profile/",
322330
"type": "object",
323331
"description": "Configures AWS profiles.",
324332
"properties": {
@@ -378,6 +386,7 @@
378386
]
379387
},
380388
{
389+
"$comment": "https://docs.codifycli.com/core-resources/terraform/",
381390
"description": "Installs Terraform.",
382391
"type": "object",
383392
"properties": {
@@ -412,6 +421,7 @@
412421
]
413422
},
414423
{
424+
"$comment": "https://docs.codifycli.com/core-resources/javascript/nvm/",
415425
"description": "Install and manage Node versions using nvm.",
416426
"type": "object",
417427
"properties": {
@@ -449,6 +459,7 @@
449459
]
450460
},
451461
{
462+
"$comment": "https://docs.codifycli.com/core-resources/jenv/",
452463
"type": "object",
453464
"description": "Install jenv and manage Java versions using jenv. Jenv cannot install Java directly, it needs to be installed separately and added to Jenv.",
454465
"properties": {
@@ -486,6 +497,7 @@
486497
]
487498
},
488499
{
500+
"$comment": "https://docs.codifycli.com/core-resources/pgcli/",
489501
"type": "object",
490502
"description": "Installs pgcli.",
491503
"properties": {
@@ -512,6 +524,7 @@
512524
]
513525
},
514526
{
527+
"$comment": "https://docs.codifycli.com/core-resources/vscode/",
515528
"description": "Installs Vscode.",
516529
"type": "object",
517530
"properties": {
@@ -543,6 +556,7 @@
543556
]
544557
},
545558
{
559+
"$comment": "https://docs.codifycli.com/core-resources/git/git-repository/",
546560
"description": "Git clone a repository. Choose either to specify the exact directory to clone into or the parent directory (it deduces the folder name using the repository name).",
547561
"type": "object",
548562
"properties": {
@@ -585,6 +599,7 @@
585599
]
586600
},
587601
{
602+
"$comment": "https://docs.codifycli.com/core-resources/android-studio/",
588603
"type": "object",
589604
"description": "Install Android Studios.",
590605
"properties": {
@@ -620,6 +635,7 @@
620635
]
621636
},
622637
{
638+
"$comment": "https://docs.codifycli.com/core-resources/asdf/asdf/",
623639
"type": "object",
624640
"description": "Installs asdf and manages asdf plugins. Use 'asdf-install' or 'asdf-plugin' to install the actual tool. Use 'asdf-global' or 'asdf-local' to activate the tool in the shell.",
625641
"properties": {
@@ -653,6 +669,7 @@
653669
]
654670
},
655671
{
672+
"$comment": "https://docs.codifycli.com/core-resources/asdf/asdf-plugin/",
656673
"description": "Installs a plugin and manages specific tool versions.",
657674
"type": "object",
658675
"properties": {
@@ -695,6 +712,7 @@
695712
"additionalProperties": false
696713
},
697714
{
715+
"$comment": "https://docs.codifycli.com/core-resources/asdf/asdf-global/",
698716
"type": "object",
699717
"description": "Manage the asdf global version for a tool. An asdf-global or asdf-local resource must be specified before a tool installed with asdf is active in the shell.",
700718
"properties": {
@@ -731,6 +749,7 @@
731749
"additionalProperties": false
732750
},
733751
{
752+
"$comment": "https://docs.codifycli.com/core-resources/asdf/asdf-local/",
734753
"description": "Manage the asdf local version for a tool. An asdf-global or asdf-local resource must be specified before a tool installed with asdf is active in the shell.",
735754
"type": "object",
736755
"properties": {
@@ -778,6 +797,7 @@
778797
"additionalProperties": false
779798
},
780799
{
800+
"$comment": "https://docs.codifycli.com/core-resources/asdf/asdf-install/",
781801
"type": "object",
782802
"description": "Install a .tools-version file or directly install an asdf plugin + tool version.",
783803
"properties": {
@@ -819,6 +839,7 @@
819839
]
820840
},
821841
{
842+
"$comment": "https://docs.codifycli.com/core-resources/ssh/ssh-key/",
822843
"description": "Generate and manage a ssh private/public key.",
823844
"type": "object",
824845
"properties": {
@@ -877,6 +898,7 @@
877898
"additionalProperties": false
878899
},
879900
{
901+
"$comment": "https://docs.codifycli.com/core-resources/ssh/ssh-config/",
880902
"description": "Configures the ssh config file.",
881903
"type": "object",
882904
"properties": {
@@ -962,6 +984,7 @@
962984
"additionalProperties": false
963985
},
964986
{
987+
"$comment": "https://docs.codifycli.com/core-resources/ssh/ssh-add/",
965988
"description": "Adds ssh private keys to the ssh agent.",
966989
"type": "object",
967990
"properties": {
@@ -997,6 +1020,7 @@
9971020
"additionalProperties": false
9981021
},
9991022
{
1023+
"$comment": "https://docs.codifycli.com/core-resources/scripting/action/",
10001024
"description": "Run custom scripts using the action resource. A condition can be specified to conditionally trigger a script.",
10011025
"type": "object",
10021026
"properties": {
@@ -1036,6 +1060,7 @@
10361060
"additionalProperties": false
10371061
},
10381062
{
1063+
"$comment": "https://docs.codifycli.com/core-resources/files/file/",
10391064
"description": "Manages a file.",
10401065
"type": "object",
10411066
"properties": {
@@ -1076,6 +1101,7 @@
10761101
"additionalProperties": false
10771102
},
10781103
{
1104+
"$comment": "https://docs.codifycli.com/core-resources/files/remote-file/",
10791105
"description": "Represents a file stored on codify cloud. Use apply to pull changes from remote and save to local. Use refresh and import to upload changes to remote.",
10801106
"type": "object",
10811107
"properties": {
@@ -1120,6 +1146,7 @@
11201146
"additionalProperties": false
11211147
},
11221148
{
1149+
"$comment": "https://docs.codifycli.com/core-resources/python/virtualenv-project/",
11231150
"type": "object",
11241151
"description": "Install and manage local packages with virtualenv",
11251152
"properties": {
@@ -1146,6 +1173,7 @@
11461173
]
11471174
},
11481175
{
1176+
"$comment": "https://docs.codifycli.com/core-resources/python/virtualenv-project/",
11491177
"type": "object",
11501178
"description": "Install and manage local packages for a project with virtualenv",
11511179
"properties": {
@@ -1201,6 +1229,7 @@
12011229
]
12021230
},
12031231
{
1232+
"$comment": "https://docs.codifycli.com/core-resources/javascript/pnpm/",
12041233
"description": "Install and manage Node dependencies and versions using pnpm.",
12051234
"type": "object",
12061235
"properties": {
@@ -1259,6 +1288,7 @@
12591288
]
12601289
},
12611290
{
1291+
"$comment": "https://docs.codifycli.com/core-resources/python/venv-project/",
12621292
"type": "object",
12631293
"description": "Install and manage local packages for a project with venv",
12641294
"properties": {
@@ -1330,6 +1360,7 @@
13301360
]
13311361
},
13321362
{
1363+
"$comment": "https://docs.codifycli.com/core-resources/python/pip/",
13331364
"type": "object",
13341365
"description": "Install and manage packages using pip",
13351366
"properties": {
@@ -1393,6 +1424,7 @@
13931424
]
13941425
},
13951426
{
1427+
"$comment": "https://docs.codifycli.com/core-resources/python/pip-sync/",
13961428
"type": "object",
13971429
"description": "Install and manage though pip-tools by installing + uninstalling packages using pip-sync",
13981430
"properties": {
@@ -1435,6 +1467,7 @@
14351467
]
14361468
},
14371469
{
1470+
"$comment": "https://docs.codifycli.com/core-resources/macports/",
14381471
"description": "Install macports and manage packages.",
14391472
"type": "object",
14401473
"properties": {
@@ -1486,6 +1519,7 @@
14861519
]
14871520
},
14881521
{
1522+
"$comment": "https://docs.codifycli.com/core-resources/javascript/npm/",
14891523
"description": "Install and manage packages using NPM.",
14901524
"type": "object",
14911525
"properties": {
@@ -1540,6 +1574,7 @@
15401574
]
15411575
},
15421576
{
1577+
"$comment": "https://docs.codifycli.com/core-resources/docker/",
15431578
"type": "object",
15441579
"description": "Installs docker.",
15451580
"properties": {

0 commit comments

Comments
 (0)