rtables icon indicating copy to clipboard operation
rtables copied to clipboard

Adding search engine for website

Open Melkiades opened this issue 2 years ago • 14 comments

I would love to be able to search for strings in online documentation like it is possible in tern. Is it possible to add this functionality also here @cicdguy?

Melkiades avatar Dec 08 '22 14:12 Melkiades

@Melkiades - the search here doesn't do the trick?

Screen Shot 2022-12-08 at 9 37 08 AM

cicdguy avatar Dec 08 '22 15:12 cicdguy

A larger question @cicdguy is if the search can be expanded to include formatters (and possibly rlistings) due to how things are split up.

gmbecker avatar Dec 08 '22 15:12 gmbecker

My apologies @cicdguy! I saw it like this (which is formatters) but maybe I was looking at something else. Sorry! Screenshot 2022-12-08 171358

Melkiades avatar Dec 08 '22 16:12 Melkiades

Ok yeah, formatters needs to up updated. Will do that there.

cicdguy avatar Dec 08 '22 16:12 cicdguy

but so why is this (https://roche.github.io/rtables/reference/custom_split_funs.html) is rendered like this (that is where I saw it)? Screenshot 2022-12-08 171930

Melkiades avatar Dec 08 '22 16:12 Melkiades

The URL is different: https://roche.github.io/rtables/main/reference/custom_split_funs.html Let me remove the old one.

cicdguy avatar Dec 08 '22 16:12 cicdguy

A larger question @cicdguy is if the search can be expanded to include formatters (and possibly rlistings) due to how things are split up.

This can be the subject of a new issue if it is a possible thing to do @cicdguy. In the meantime, I will close this issue as soon as the old links are removed

Melkiades avatar Dec 13 '22 10:12 Melkiades

@Melkiades Isn't it done?

pawelru avatar Feb 03 '23 11:02 pawelru

@pawelru The issue is that for this to be fully useful, it would be nice if the search engine could cover both rtables and formatters, because as you saw, the divisions of code make sense technically but can be a bit confusing to the end user.

@cicdguy is that something that is possible?

gmbecker avatar Feb 03 '23 20:02 gmbecker

@pawelru The issue is that for this to be fully useful, it would be nice if the search engine could cover both rtables and formatters, because as you saw, the divisions of code make sense technically but can be a bit confusing to the end user.

@cicdguy is that something that is possible?

We can look into the technical feasibility of this.

cicdguy avatar Feb 06 '23 14:02 cicdguy

@cicdguy any update on this? Is this (the combined rtables + formatters search index) still a live issue on your plate? Should this just be closed?

gmbecker avatar Jun 27 '23 23:06 gmbecker

Not for now. We can scope it in for a future enhancement, though.

cicdguy avatar Jun 27 '23 23:06 cicdguy

That is kind of what I figured. Does this issue belong here, or in the automation team's project board (or both)? @cicdguy

gmbecker avatar Jun 28 '23 01:06 gmbecker

Let's move it to ours

cicdguy avatar Jun 28 '23 02:06 cicdguy

Closing this as there are no current plans to complete this. {rtables} remains the point of reference for all user-facing docs

Melkiades avatar Jul 09 '24 15:07 Melkiades