elastic / elastic/docs-builder

Code annotations don't render if the rest of the line is "empty"

Open
#3,141 3 comments 0 reactions 0 assignees View on GitHub
ai-triaged ai:quick-fix bug needs triage
Dominant language
C#
Stars
24
Forks
44
Avg merge
1d 7h
Merged PRs (30d)
146

Description

### Describe the bug

https://github.com/elastic/docs-content/issues/5951

Two annotations on empty lines, both not rendering as cute icons

Image

### Expected behavior

The icons render regardless of whether there is other content on the line

### Steps to reproduce

this snippet on any page

````
```yaml
count: 1
version: {version} <1>
image:
pipelines:
- pipeline.id: main
config.string: |
input {
jdbc {
<2>
jdbc_driver_class => "org.postgresql.Driver"
<3>
}
}
```

1. The correct version is required as ECK reasons about available APIs and capabilities based on the version field.
2. Note that when you place the JAR file on the {{ls}} classpath, you do not need to specify the `jdbc_driver_library` location in the plugin configuration.
3. Remainder of plugin configuration goes here
````

workaround (this works)

````
```yaml
count: 1
version: {version} <1>
image:
pipelines:
- pipeline.id: main
config.string: |
input {
jdbc {
// <2>
jdbc_driver_class => "org.postgresql.Driver"
// <3>
}
}
```

1. The correct version is required as ECK reasons about available APIs and capabilities based on the version field.
2. Note that when you place the JAR file on the {{ls}} classpath, you do not need to specify the `jdbc_driver_library` location in the plugin configuration.
3. Remainder of plugin configuration goes here
````

### Tooling

- [x] docs-builder
- [ ] migration tooling
- [ ] I'm not sure

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.