fix documentation errors
Signed-off-by: Morgan Martinet <morgan.martinet@montreal.ca>
This commit is contained in:
@@ -115,13 +115,14 @@ Specifies the app that provides the Kubernetes dashboard.
|
||||
This will be used for formatting links to kubernetes objects inside the
|
||||
dashboard.
|
||||
|
||||
The supported dashboards are: standard, rancher, openshift, gke, aks, eks
|
||||
The supported dashboards are: `standard`, `rancher`, `openshift`, `gke`, `aks`,
|
||||
`eks`
|
||||
|
||||
Note that it will default to the regular dashboard provided by the Kubernetes
|
||||
project (standard), that can run in any kubernetes cluster.
|
||||
project (`standard`), that can run in any Kubernetes cluster.
|
||||
|
||||
Note that you can add your own formatter by registering it to the formatters
|
||||
dictionary, in the app project.
|
||||
Note that you can add your own formatter by registering it to the
|
||||
`clusterLinksFormatters` dictionary, in the app project.
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@@ -98,7 +98,7 @@ export interface ClusterDetails {
|
||||
* @remarks
|
||||
* The existing apps are: standard, rancher, openshift, gke, aks, eks
|
||||
* Note that it will default to the regular dashboard provided by the Kubernetes project (standard).
|
||||
* Note that you can add your own formatter by registering it to the formatters dictionary.
|
||||
* Note that you can add your own formatter by registering it to the clusterLinksFormatters dictionary.
|
||||
* @defaultValue standard
|
||||
* @see dashboardUrl
|
||||
* @example
|
||||
|
||||
@@ -52,7 +52,7 @@ export interface ClusterAttributes {
|
||||
* @remarks
|
||||
* The supported dashboards are: standard, rancher, openshift, gke, aks, eks
|
||||
* Note that it will default to the regular dashboard provided by the Kubernetes project (standard).
|
||||
* Note that you can add your own formatter by registering it to the formatters dictionary.
|
||||
* Note that you can add your own formatter by registering it to the clusterLinksFormatters dictionary.
|
||||
* @defaultValue standard
|
||||
* @see dashboardUrl
|
||||
* @example
|
||||
|
||||
Reference in New Issue
Block a user