[
https://issues.apache.org/jira/browse/SOLR-11766?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16332680#comment-16332680
]
Joel Bernstein edited comment on SOLR-11766 at 1/19/18 6:23 PM:
----------------------------------------------------------------
I was mainly thinking about the evaluators with sub-categories.
I think the stream sources and decorators will not grow much further. But the
evaluators will keep growing.
I really like the designs you've put up and I think they will be very helpful.
Now I think it makes sense to think about the overall structure of the
documentation. I think something like this makes sense, and I'll be adding
lot's of user guides in the next couple of months:
*Stream Sources*
* Function Reference
* User guide
*Stream Decorators*
* Function Reference
* User guide
*Stream Evaluators*
* Function Reference
* Statistical and Mathematics Programming
* Probability Distributions and Simulations
* Interpolation, Derivatives and Integrals
* Curve Fitting and Regression
* Machine Learning and Text Mining
* Time Series Analysis
* Linear Algebra / Vector & Matrix Math
* Digital Signal Processing
was (Author: joel.bernstein):
I was mainly thinking about the evaluators with sub-categories.
I think the stream sources and decorators will not grow much further. But the
evaluators will keep growing.
I really like the designs you've put up and I think they will be very helpful.
Now I think it makes sense to think about the overall structure of the
documentation. I think something like this makes sense, and I'll be adding
lot's of user guides in the next couple of months:
*Stream Sources*
* Function Reference
* User guide
*Stream Decorators*
* Function Reference
* User guide
*Stream Evaluators*
* Function Reference
* Statistical and Mathematics Programming
* Probability distributions and simulations
* Interpolation, Derivatives and Integrals
* Curve Fitting and Regression
* Machine Learning and Text Mining
* Time Series Analysis
* Linear Algebra / Vector & Matrix Math
* Digital Signal Processing
> 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]
