Skip to content

Commit

Permalink
Improve rendering in IntelliJ and VSCode
Browse files Browse the repository at this point in the history
  • Loading branch information
@dgageot
dgageot committed Feb 28, 2019
1 parent 72dff0e commit 30509cc
Show file tree
Hide file tree
Showing 13 changed files with 1,174 additions and 547 deletions.
2 changes: 1 addition & 1 deletion docs/content/en/docs/references/yaml/main.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function* template(definitions, parentDefinition, ref, ident) {

let index = -1
for (var [key, definition] of allProperties) {
var desc = definition.description;
var desc = definition['x-intellij-html-description'];
let value = definition.default;
index++;

Expand Down
25 changes: 17 additions & 8 deletions docs/content/en/schemas/v1alpha1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"$ref": "#/definitions/SkaffoldPipeline"
}
],
"$schema": "http://json-schema-org/draft-07/schema#",
"definitions": {
"Artifact": {
"properties": {
Expand Down Expand Up @@ -32,7 +33,8 @@
"buildArgs"
],
"additionalProperties": false,
"description": "represents items that need should be built, along with the context in which they should be built."
"description": "represents items that need should be built, along with the context in which they should be built.",
"x-intellij-html-description": "represents items that need should be built, along with the context in which they should be built.\n"
},
"BuildConfig": {
"anyOf": [
Expand Down Expand Up @@ -99,7 +101,8 @@
"additionalProperties": false
}
],
"description": "contains all the configuration for the build steps"
"description": "contains all the configuration for the build steps",
"x-intellij-html-description": "contains all the configuration for the build steps\n"
},
"BuildType": {
"properties": {
Expand All @@ -115,7 +118,8 @@
"googleCloudBuild"
],
"additionalProperties": false,
"description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated."
"description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated.",
"x-intellij-html-description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated.\n"
},
"DeployConfig": {
"anyOf": [
Expand Down Expand Up @@ -161,7 +165,8 @@
"additionalProperties": false
}
],
"description": "contains all the configuration needed by the deploy steps"
"description": "contains all the configuration needed by the deploy steps",
"x-intellij-html-description": "contains all the configuration needed by the deploy steps\n"
},
"DeployType": {
"properties": {
Expand All @@ -177,7 +182,8 @@
"kubectl"
],
"additionalProperties": false,
"description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated."
"description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated.",
"x-intellij-html-description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated.\n"
},
"GoogleCloudBuild": {
"properties": {
Expand Down Expand Up @@ -252,7 +258,8 @@
"manifests"
],
"additionalProperties": false,
"description": "contains the configuration needed for deploying with <code>kubectl apply</code>"
"description": "contains the configuration needed for deploying with `kubectl apply`",
"x-intellij-html-description": "contains the configuration needed for deploying with <code>kubectl apply</code>\n"
},
"LocalBuild": {
"properties": {
Expand All @@ -264,7 +271,8 @@
"skipPush"
],
"additionalProperties": false,
"description": "contains the fields needed to do a build on the local docker daemon and optionally push to a repository."
"description": "contains the fields needed to do a build on the local docker daemon and optionally push to a repository.",
"x-intellij-html-description": "contains the fields needed to do a build on the local docker daemon and optionally push to a repository.\n"
},
"Manifest": {
"properties": {
Expand Down Expand Up @@ -311,7 +319,8 @@
"deploy"
],
"additionalProperties": false,
"description": "top level config object that is parsed from a skaffold.yaml"
"description": "top level config object that is parsed from a skaffold.yaml",
"x-intellij-html-description": "top level config object that is parsed from a skaffold.yaml\n"
}
}
}
67 changes: 45 additions & 22 deletions docs/content/en/schemas/v1alpha2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"$ref": "#/definitions/SkaffoldPipeline"
}
],
"$schema": "http://json-schema-org/draft-07/schema#",
"definitions": {
"Artifact": {
"anyOf": [
Expand Down Expand Up @@ -62,7 +63,8 @@
"additionalProperties": false
}
],
"description": "represents items that need to be built, along with the context in which they should be built."
"description": "represents items that need to be built, along with the context in which they should be built.",
"x-intellij-html-description": "represents items that need to be built, along with the context in which they should be built.\n"
},
"ArtifactType": {
"properties": {
Expand Down Expand Up @@ -177,7 +179,8 @@
"additionalProperties": false
}
],
"description": "contains all the configuration for the build steps"
"description": "contains all the configuration for the build steps",
"x-intellij-html-description": "contains all the configuration for the build steps\n"
},
"BuildType": {
"properties": {
Expand All @@ -197,7 +200,8 @@
"kaniko"
],
"additionalProperties": false,
"description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated."
"description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated.",
"x-intellij-html-description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated.\n"
},
"DateTimeTagger": {
"properties": {
Expand All @@ -213,7 +217,8 @@
"timezone"
],
"additionalProperties": false,
"description": "contains the configuration for the DateTime tagger."
"description": "contains the configuration for the DateTime tagger.",
"x-intellij-html-description": "contains the configuration for the DateTime tagger.\n"
},
"DeployConfig": {
"anyOf": [
Expand Down Expand Up @@ -254,7 +259,8 @@
"additionalProperties": false
}
],
"description": "contains all the configuration needed by the deploy steps"
"description": "contains all the configuration needed by the deploy steps",
"x-intellij-html-description": "contains all the configuration needed by the deploy steps\n"
},
"DeployType": {
"properties": {
Expand All @@ -274,7 +280,8 @@
"kustomize"
],
"additionalProperties": false,
"description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated."
"description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated.",
"x-intellij-html-description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated.\n"
},
"DockerArtifact": {
"properties": {
Expand Down Expand Up @@ -317,10 +324,12 @@
"template"
],
"additionalProperties": false,
"description": "contains the configuration for the envTemplate tagger."
"description": "contains the configuration for the envTemplate tagger.",
"x-intellij-html-description": "contains the configuration for the envTemplate tagger.\n"
},
"GitTagger": {
"description": "contains the configuration for the git tagger."
"description": "contains the configuration for the git tagger.",
"x-intellij-html-description": "contains the configuration for the git tagger.\n"
},
"GoogleCloudBuild": {
"properties": {
Expand Down Expand Up @@ -348,10 +357,12 @@
"dockerImage"
],
"additionalProperties": false,
"description": "contains the fields needed to do a remote build on Google Cloud Build."
"description": "contains the fields needed to do a remote build on Google Cloud Build.",
"x-intellij-html-description": "contains the fields needed to do a remote build on Google Cloud Build.\n"
},
"HelmConventionConfig": {
"description": "represents image config in the syntax of image.repository and image.tag"
"description": "represents image config in the syntax of image.repository and image.tag",
"x-intellij-html-description": "represents image config in the syntax of image.repository and image.tag\n"
},
"HelmDeploy": {
"properties": {
Expand All @@ -366,7 +377,8 @@
"releases"
],
"additionalProperties": false,
"description": "contains the configuration needed for deploying with helm"
"description": "contains the configuration needed for deploying with helm",
"x-intellij-html-description": "contains the configuration needed for deploying with helm\n"
},
"HelmFQNConfig": {
"properties": {
Expand All @@ -378,7 +390,8 @@
"property"
],
"additionalProperties": false,
"description": "represents image config to use the FullyQualifiedImageName as param to set"
"description": "represents image config to use the FullyQualifiedImageName as param to set",
"x-intellij-html-description": "represents image config to use the FullyQualifiedImageName as param to set\n"
},
"HelmImageConfig": {
"properties": {
Expand Down Expand Up @@ -428,19 +441,22 @@
"properties": {
"appVersion": {
"type": "string",
"description": "set the appVersion on the chart to this version"
"description": "set the appVersion on the chart to this version",
"x-intellij-html-description": "set the appVersion on the chart to this version\n"
},
"version": {
"type": "string",
"description": "sets the version on the chart to this semver version."
"description": "sets the version on the chart to this semver version.",
"x-intellij-html-description": "sets the version on the chart to this semver version.\n"
}
},
"preferredOrder": [
"version",
"appVersion"
],
"additionalProperties": false,
"description": "represents parameters for packaging helm chart."
"description": "represents parameters for packaging helm chart.",
"x-intellij-html-description": "represents parameters for packaging helm chart.\n"
},
"HelmRelease": {
"properties": {
Expand Down Expand Up @@ -543,7 +559,8 @@
"timeout"
],
"additionalProperties": false,
"description": "contains the fields needed to do a on-cluster build using the kaniko image"
"description": "contains the fields needed to do a on-cluster build using the kaniko image",
"x-intellij-html-description": "contains the fields needed to do a on-cluster build using the kaniko image\n"
},
"KubectlDeploy": {
"properties": {
Expand Down Expand Up @@ -571,7 +588,8 @@
"flags"
],
"additionalProperties": false,
"description": "contains the configuration needed for deploying with <code>kubectl apply</code>"
"description": "contains the configuration needed for deploying with `kubectl apply`",
"x-intellij-html-description": "contains the configuration needed for deploying with <code>kubectl apply</code>\n"
},
"KubectlFlags": {
"properties": {
Expand Down Expand Up @@ -603,7 +621,8 @@
"delete"
],
"additionalProperties": false,
"description": "describes additional options flags that are passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete)."
"description": "describes additional options flags that are passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).",
"x-intellij-html-description": "describes additional options flags that are passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).\n"
},
"KustomizeDeploy": {
"properties": {
Expand Down Expand Up @@ -640,7 +659,8 @@
"useBuildkit"
],
"additionalProperties": false,
"description": "contains the fields needed to do a build on the local docker daemon and optionally push to a repository."
"description": "contains the fields needed to do a build on the local docker daemon and optionally push to a repository.",
"x-intellij-html-description": "contains the fields needed to do a build on the local docker daemon and optionally push to a repository.\n"
},
"Profile": {
"properties": {
Expand All @@ -660,10 +680,12 @@
"deploy"
],
"additionalProperties": false,
"description": "additional configuration that overrides default configuration when it is activated."
"description": "additional configuration that overrides default configuration when it is activated.",
"x-intellij-html-description": "additional configuration that overrides default configuration when it is activated.\n"
},
"ShaTagger": {
"description": "contains the configuration for the SHA tagger."
"description": "contains the configuration for the SHA tagger.",
"x-intellij-html-description": "contains the configuration for the SHA tagger.\n"
},
"SkaffoldPipeline": {
"properties": {
Expand Down Expand Up @@ -717,7 +739,8 @@
"dateTime"
],
"additionalProperties": false,
"description": "contains all the configuration for the tagging step"
"description": "contains all the configuration for the tagging step",
"x-intellij-html-description": "contains all the configuration for the tagging step\n"
}
}
}
Loading

0 comments on commit 30509cc

Please sign in to comment.