[
https://issues.apache.org/jira/browse/SOLR-11766?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16332638#comment-16332638
]
Cassandra Targett commented on SOLR-11766:
------------------------------------------
Before I go too much farther, I've uploaded a couple of sample pages that show
what I'm thinking about.
*
http://people.apache.org/~ctargett/StreamingExpressions/streaming-reference.html
shows a new page for all the expressions in one place, presented as small
boxes with a short description and basic example.
** Labels will help users differentiate between the different types of
expressions.
** I haven't decided the order for how to present the summary info yet - you'll
see two examples. One is Expression, Description, Example (row 1); while the
other is Expression, Example, Description (rows 2 & 3). I feel like the
examples are getting lost in either option...I think it might need to be bold
and/or another color.
** Layout of row 3 in the current example is weird because there's only 2 there
- should straighten out when a 3rd expression is added to that row.
*
http://people.apache.org/~ctargett/StreamingExpressions/stream-evaluator-reference.html
shows new layout of expression sections: Expression, basic example again,
short description. Clicking "more details" shows the Parameters & Syntax
examples.
** There's more we could do here - change the text "more details" to "less
details" when it's open (or use an icon instead of text or in addition to text).
Thoughts?
I realized that I may have misinterpreted [~joel.bernstein]'s comment earlier -
I assumed you were only speaking of the Evaluators page when you mentioned
categories, but now realize that you may have meant organizing all the
expressions into those categories. I like this idea - with a single overview
summary page of all the expressions like I've started here, we could put each
category into it's own page so someone working with Machine Learning sees all
the expressions in one place.
> Ref Guide: redesign Streaming Expression reference pages
> --------------------------------------------------------
>
> Key: SOLR-11766
> URL: https://issues.apache.org/jira/browse/SOLR-11766
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation, streaming expressions
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Major
> Attachments: Stream-collapsed-panels.png, StreamQuickRef-sample.png,
> Streaming-expanded-panel.png
>
>
> There are a very large number of streaming expressions and they need some
> special info design to be more easily accessible. The current way we're
> presenting them doesn't really work. This issue is to track ideas and POC
> patches for possible approaches.
> A couple of ideas I have, which may or may not all work together:
> # Provide a way to filter the list of commands by expression type (would need
> to figure out the types)
> # Present the available expressions in smaller sections, similar in UX
> concept to https://redis.io/commands. On that page, I can see 9-12 commands
> above "the fold" on my laptop screen, as compared to today when I can see
> only 1 expression at a time & each expression probably takes more space than
> necessary. This idea would require figuring out where people go when they
> click a command to get more information.
> ## One solution for where people go is to put all the commands back in one
> massive page, but this isn't really ideal
> ## Another solution would be to have an individual .adoc file for each
> expression and present them all individually.
> # Some of the Bootstrap.js options may help - collapsing panels or tabs, if
> properly designed, may make it easier to see an overview of available
> expressions and get more information if interested.
> I'll post more ideas as I come up with them.
> These ideas focus on the HTML layout of expressions - ideally we come up with
> a solution for PDF that's better also, but we are much more limited in what
> we can do there.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
