[
https://issues.apache.org/jira/browse/SOLR-11766?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16336520#comment-16336520
]
Cassandra Targett commented on SOLR-11766:
------------------------------------------
I've been working on this the past few days, and have some new pages up at
people.apache.org. This is the main page for Streaming Expressions, similar to
how it is today:
http://people.apache.org/~ctargett/StreamingExpressions/streaming-expressions.html.
All the other pages are also there, as well as several new pages. It's still
WIP, though - Sources & Decorators have not been touched yet at all.
In the left-nav, note a new organization for the sub-sections, and new pages
for Stream Sources, Decorators, and Evaluators. Under the Evaluators, there are
new pages for each of the proposed sub-sections.
I took a crack at splitting up the evaluators - from looking at the evaluator
classes, mostly, but there are many leftover and I can't progress without a
list or further guidance. The ones I don't know where to put are still on the
general "Stream Evaluator Reference" page (the idea being that that page will
go away once they're all on their proper pages).
My plan for the next day or two is to work through the Sources and Decorators
pages. Once I've done as much as I can, I will put up a patch here but I
figured it was easier while iterating to see the built pages rather than trying
to apply a patch and build locally.
> 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: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
