[
https://issues.apache.org/jira/browse/SOLR-11766?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16340090#comment-16340090
]
Joel Bernstein commented on SOLR-11766:
---------------------------------------
I took a look the new pages. My first instinct when I saw them was that it may
be time to think about putting the Streaming Expressions documentation in it's
own guide rather then as part of the reference guide.
Here are three reasons for doing this:
1) Streaming Expressions tend to hold up the release of the main reference
guide. If they we're in there own guide they could release later without
causing other documentation to slip as well.
2) Right now the Streaming Expression documentation is being wedged into an
existing format. If we we're able to break it out this would free us up to find
better ways to organize and display the information.
3) Streaming Expression documentation is now so big that it probably deserves
it's own guide. The docs include Parallel SQL, Graph, Stream Sources, Stream
Decorators, Stream Evaluators and the Statistical programming syntax. With all
the functions and planned user guides the sheer number of pages makes it
worthwhile to break out in it's own guide.
> 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]
