Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Codeblocks with valid use of angular brackets mistaken for callout #431

Open
1 of 3 tasks
lcawl opened this issue Feb 5, 2025 · 0 comments
Open
1 of 3 tasks

Codeblocks with valid use of angular brackets mistaken for callout #431

lcawl opened this issue Feb 5, 2025 · 0 comments
Labels
authoring Relates to our markdown parser bug

Comments

@lcawl
Copy link
Contributor

lcawl commented Feb 5, 2025

Describe the bug

The example in https://www.elastic.co/guide/en/elasticsearch/hadoop/current/configuration.html#cfg-mapping contains a valid use of angular brackets:

es.mapping.parent = <123>

However in the new docs system, this is being treated as a callout that is missing an explanation and results in the following error:

:: fail: Documentation.Builder.Log[0] Code block with annotations is not followed by a list (/Users/lcawley/Documents/GitHub/asciidocalypse/docs/elasticsearch-hadoop/docs/reference/ingestion-tools/elasticsearch-hadoop/configuration.md:264)

Expected behavior

I think we need some way to indicate that a codeblock doesn't use callouts. Or an escape character or some other way to avoid this being captured as an error (though we wouldn't want that escape character to be picked up when folks cut and paste the example).

Steps to reproduce

Copy the codeblock from aforementioned page and run ./docs-builder -p <path>

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure
@lcawl lcawl added the bug label Feb 5, 2025
@bmorelli25 bmorelli25 added the authoring Relates to our markdown parser label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authoring Relates to our markdown parser bug
Projects
None yet
Development

No branches or pull requests

2 participants