opensearch-project / opensearch-learning-to-rank-base

Fork of https://github.com/o19s/elasticsearch-learning-to-rank to work with OpenSearch
Apache License 2.0
16 stars 15 forks source link

[BUG] The docs refer to the demo directory, however it isn't in our code base. #43

Open epugh opened 1 month ago

epugh commented 1 month ago

What is the bug?

In the docs, that we are coping over, we have http://localhost:4000/docs/latest/search-plugins/ltr/logging-features/ page that says:

image

However, that link, which should be https://github.com/o19s/OpenSearch-learning-to-rank/tree/master/demo doesn't work because that directory was never ported over.

How can one reproduce the bug?

Use this PR for the documentation and stand it up: https://github.com/opensearch-project/documentation-website/pull/8336

What is the expected behavior?

Either the link works, or we rework it to not have a link

epugh commented 1 month ago

Good candidate for @johannesdaniel to pick up...

dblock commented 1 month ago

[Catch All Triage - 1, 2, 3, 4]

sstults commented 11 hours ago

@epugh it looks like this was edited out of the docs. Okay to close?

epugh commented 11 hours ago

I suppose so... Did we add back the docs though? I see https://github.com/opensearch-project/opensearch-learning-to-rank-base/tree/main/demo, is that the missing dir? Looking back at the original docs, they pointed to https://github.com/o19s/elasticsearch-learning-to-rank/tree/main/demo.

So I think the right fix is to add a PR to the docs website restoring the link to our demo dir...!