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

List items with multiple block elements become separate lists #239

Closed
1 of 3 tasks
colleenmcginnis opened this issue Jan 15, 2025 · 2 comments
Closed
1 of 3 tasks
Labels

Comments

@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Jan 15, 2025

Describe the bug

Note

I'm not sure how widespread this issue and in which conditions it occurs, but here's an example. (I'll keep an eye out for more!)

In list items with multiple block elements (paragraphs, code blocks, etc), block elements only the first block element is included in the li resulting in multiple lists (in this case ol) where there should be one.

<ol>
	<li> On any node in your existing cluster, generate a node enrollment token:</li>
</ol>
<div class="highlight-sh notranslate">
	<div class="highlight">
		<pre><code class="language-sh hljs language-bash" data-highlighted="yes">/usr/share/elasticsearch/bin/elasticsearch-create-enrollment-token -s node
</code></pre>
		<button class="copybtn o-tooltip--left" data-tooltip="Copy" data-clipboard-target="#codecell0">
			<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44"
				viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round"
				stroke-linejoin="round">
				<title>Copy to clipboard</title>
				<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
				<rect x="8" y="8" width="12" height="12" rx="2"></rect>
				<path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2"></path>
			</svg>
		</button>
	</div>
</div>
<ol start="2">
	<li> Copy the enrollment token, which is output to your terminal.</li>
	<li> On your new Elasticsearch node, pass the enrollment token as a parameter to the<br>
		<code>elasticsearch-reconfigure-node</code> tool:
	</li>
</ol>
<div class="highlight-sh notranslate">
	<div class="highlight">
		<pre><code class="language-sh hljs language-bash" data-highlighted="yes">/usr/share/elasticsearch/bin/elasticsearch-reconfigure-node --enrollment-token &lt;enrollment-token&gt;
</code></pre>
		<button class="copybtn o-tooltip--left" data-tooltip="Copy" data-clipboard-target="#codecell0">
			<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44"
				viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round"
				stroke-linejoin="round">
				<title>Copy to clipboard</title>
				<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
				<rect x="8" y="8" width="12" height="12" rx="2"></rect>
				<path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2"></path>
			</svg>
		</button>
	</div>
</div>
<p>Elasticsearch is now configured to join the existing cluster.</p>
<ol start="4">
	<li> <a href="deb.html#deb-running-systemd">Start your new node using <code>systemd</code></a>.</li>
</ol>

The concerns here are: (1) visually indentation isn't rendered correctly so it might be difficult to follow in long/complex lists and (2) this might make it more difficult to interpret content via screenreader.

AsciiDoc docs-builder
Image
Link
Image
Link

Expected behavior

In this example, instead of having three ordered lists, there should be one ordered list with four list items.

Steps to reproduce

I'm not sure how widespread this issue and in which conditions it occurs, but here's an example (I'll keep an eye out for more!):

  1. Build the elasticsearch.md doc set
  2. Go to http://localhost:5000/deb.html#_reconfigure_a_node_to_join_an_existing_cluster

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure
@colleenmcginnis
Copy link
Contributor Author

Related to #227

@bmorelli25
Copy link
Member

Like you mention above, this is happening because of #227. I'm going to close this as a duplicate of that issue but add a note to that issue to verify this is working as intended.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants