elastic / elastic/crd-ref-docs

Indention in the fields's comments is not preserved in the generated document

Open
#188 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

For example, the comment in the field is like the following

```

// Policy defines user-defined RBAC policies and role definitions in CSV format.
// Example:
//
// policy: |
// p, role:devops, applications, *, */*, allow
// p, role:devops, clusters, get, *, allow
// g, Alice, role:devops
// g, Bob, role:admin
//
Policy string `json:"policy,omitempty"`

```

but in the generated document, the indentions are all missing, the result is like

```
Policy defines user-defined RBAC policies and role definitions in CSV format.

Example:

policy: |
p, role:devops, applications, , */, allow
p, role:devops, clusters, get, *, allow
g, Alice, role:devops
g, Bob, role:admin
```

Is it possible to preserve the indention? Thanks

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.