Advanced Search Tool/Help Center

[mguidon]

Add new Advanced Search Tool or Help Center that allows to search:

• [ ] Html Manual
• [ ] API Reference
• [ ] Specific Tutorial section in Html Manual
• [ ] Video tutorials/How Tos
  • [ ] It was agreed with @eofli to have them served from a publicly available S3 bucket
  • [ ] we add metadata for the search directly to the objects
  • [ ] we will make sure that the S3 bucket cannot be "attacked" by malicious people

[jsaq007]

@mguidon, @ignapas and @SCA-ZMT I have taken the liberty if producing a couple screens of what our advanced search could look like. I tried to cover the basis but if I have missed something please let me know. I look forward to any input you might have.

1. Essentially the first screen covers the look of both default state, i.e prior to making a search and once the search has been made. The idea is simply the previous search made would remain persistent until cleared by the user or the session ends.

2. Searching all the documentation would in theory remain similar to what we have already. I missed adding the breadcrumbs into the result but the idea is that this would remain the same, (See image 2) except reverting back to a select method to show the details as before.

image 1

image 2

3. Searching videos / To dos is much the same only showing the metadata of the video. (Your thoughts as to what to display would be welcome)

4. Viewing the results in the internal content viewer.

To be decided. Primary action for clicking on the results, i.e the box containing the content. My ideas is this would perform the action. If it's a tool, a tooltip indicates that the tool will be opened.

The second line in the button would therefore be change to the matching paragraph in the documentation.

The secondary action, clicking on the info button, would show the section from the documentation in plain text/markdown. Clicking on open would open the content in interactive mode in the viewer.

Recent results and Bookmarking would essentially add the doc to the bookmarks or history list displayed on the side of the viewer but this would be for a separate topic?

Okay, I think that covers it for the moment. If you would like further thoughts or want to discuss anything please let me know.

[mguidon]

@jsaq007 This looks real nice. Some input/thoughts:

• I like the splitting of the main view into Results on the left and Details on the right. We should use the same thing for the tool search (i.e. partially revert what you have been doing)
• We could add Tools as a 5th category
• The videos could show a thumbnail (which we have to add to the metadata)
• I guess this makes having Markdown even more important
• I will spent some time with the search before I leave on vacation