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

Nested inline anchors break definition lists & fail link checking #354

Closed
2 tasks
bmorelli25 opened this issue Jan 27, 2025 · 2 comments · Fixed by #359
Closed
2 tasks

Nested inline anchors break definition lists & fail link checking #354

bmorelli25 opened this issue Jan 27, 2025 · 2 comments · Fixed by #359
Assignees
Labels

Comments

@bmorelli25
Copy link
Member

bmorelli25 commented Jan 27, 2025

Summary

The following syntax exists in the ES Guide:

$$$search-type$$$

`search_type`
:   (Optional, string) How [distributed term frequencies]({{wikipedia}}/Tf–idf) are calculated for [relevance scoring](query-filter-context.md#relevance-scores).

    ::::{dropdown} Valid values for `search_type`
    `query_then_fetch`
    :   (Default) Distributed term frequencies are calculated locally for each shard running the search. We recommend this option for faster searches with potentially less accurate scoring.

    $$$dfs-query-then-fetch$$$

    `dfs_query_then_fetch`
    :   Distributed term frequencies are calculated globally, using information gathered from all shards running the search. While this option increases the accuracy of scoring, it adds a round-trip to each shard, which can result in slower searches.

    ::::

The built output looks like this:

Image

What I expect:

  • Both definition list items: query_then_fetch & dfs_query_then_fetch should be within the dropdown element.
  • The anchor tag $$$dfs-query-then-fetch$$$ which does exist in the output file, should work with link checking. The current error is:
    :: fail: Documentation.Builder.Log[0] `dfs-query-then-fetch` does not exist in search-search.md. (/Users/brandon/Documents/GitHub/elasticsearch.md/docs/consistent-scoring.md:29)
    
@bmorelli25 bmorelli25 added the bug label Jan 27, 2025
@bmorelli25
Copy link
Member Author

Note that nested inline anchors that are not in a dropdown directive also fail link checking. For example:

### Connection modes [sniff-proxy-modes] 

$$$sniff-mode$$$

Sniff mode
:   In sniff mode, a cluster alias is registered with a name of your choosing and a list of addresses of *seed* nodes specified with the `cluster.remote.<cluster_alias>.seeds` setting. When you register a remote cluster using sniff mode, {{es}} retrieves from one of the seed nodes the addresses of up to three *gateway nodes*. Each `remote_cluster_client` node in the local {{es}} cluster then opens several TCP connections to the publish addresses of the gateway nodes. This mode therefore requires that the gateway nodes' publish addresses are accessible to nodes in the local cluster.

    Sniff mode is the default connection mode. See [Sniff mode remote cluster settings](remote-clusters-settings.md#remote-cluster-sniff-settings) for more information about configuring sniff mode.

    $$$gateway-nodes-selection$$$
    The *gateway nodes* selection depends on the following criteria:

    * **version**: Remote nodes must be compatible with the cluster they are registered to.
    * **role**: By default, any non-[master-eligible](node-roles-overview.md#master-node-role) node can act as a gateway node. Dedicated master nodes are never selected as gateway nodes.
    * **attributes**: You can define the gateway nodes for a cluster by setting [`cluster.remote.node.attr.gateway`](remote-clusters-settings.md#cluster-remote-node-attr) to `true`. However, such nodes still have to satisfy the two above requirements.

Results in:

:: fail: Documentation.Builder.Log[0] `gateway-nodes-selection` does not exist in remote-clusters.md. (/Users/brandon/Documents/GitHub/elasticsearch.md/docs/remote-clusters.md:59)

@Mpdreamz Mpdreamz self-assigned this Jan 28, 2025
@Mpdreamz
Copy link
Member

This is fixed by #359

@Mpdreamz Mpdreamz linked a pull request Jan 28, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants