Skip to content

Reusable type definition results in incorrect (missing) table rows in README #10

@NickVolynkin

Description

@NickVolynkin

Example from monitoring/values.yaml, type resources is defined first and then reused.

## @field resources.cpu {*quantity} CPU resources
## @field resources.memory {*quantity} Memory resources

# ...

## @field alerta.resources {*alertaResources} Resources configuration for alerta
## @field alertaResources.limits {*resources} Resources limits for alerta
## @field alertaResources.requests {*resources} Resources requests for alerta

# ...

## @field grafana.resources {*grafanaResources} Resources configuration for grafana
## @field grafanaResources.limits {*resources} Resources limits for grafana
## @field grafanaResources.requests {*resources} Resources requests for grafana

actual result: resource definitions are mentioned once, where they were first defined:

### Metrics storage configuration     
| `grafana.resources.requests.cpu`          | CPU resources                      | `*quantity`        |        |   
| `grafana.resources.requests.memory`       | Memory resources                   | `*quantity`        |        |   

### Alerta configuration        
  
| `alerta.resources`                        | Resources configuration for alerta | `object`           |        |  
| `alerta.resources.limits`                 | Resources limits for alerta        | `object`           |        |  
| `alerta.resources.requests`               | Resources requests for alerta      | `object`           |        |  

### Grafana configuration    

| `grafana.resources`                       | Resources configuration for grafana| `object`           |        |  
| `grafana.resources.limits`                | Resources limits for grafana       | `object`           |        |  
| `grafana.resources.requests`              | Resources requests for grafana     | `object`           |        |  

Expected result: resource defined where they're used

### Alerta configuration        
  
| `alerta.resources`                        | Resources configuration for alerta | `object`           |        |  
| `alerta.resources.limits`                 | Resources limits for alerta        | `object`           |        |  
| `alerta.resources.requests`               | Resources requests for alerta      | `object`           |        |  
| `alerta.resources.requests.cpu`           | CPU resources                      | `*quantity`        |        |  
| `alerta.resources.requests.memory`        | Memory resources                   | `*quantity`        |        |  


### Grafana configuration    

| `grafana.resources`                       | Resources configuration for grafana| `object`           |        |  
| `grafana.resources.limits`                | Resources limits for grafana       | `object`           |        |  
| `grafana.resources.requests`              | Resources requests for grafana     | `object`           |        |  
| `grafana.resources.requests.cpu`          | CPU resources                      | `*quantity`        |        |  
| `grafana.resources.requests.memory`       | Memory resources                   | `*quantity`        |        |  

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions