[
https://issues.apache.org/jira/browse/SOLR-11766?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16329162#comment-16329162
]
Jason Gerlowski edited comment on SOLR-11766 at 1/17/18 6:31 PM:
-----------------------------------------------------------------
A few things:
1. Link to our current Streaming Expressions documentation, for the lazy:
http://lucene.apache.org/solr/guide/7_2/streaming-expressions.html
2. I'm a big fan of the Redis-inspired screenshot you attached above. It's a
big improvement on making these more compact. A related but different approach
would be to have the a small summary line for each Streaming Expression, that
expands-on-click to show more details. The default display for "Swagger" docs
comes close to what I'm suggesting: http://petstore.swagger.io/#/. It may be a
bit more compact, but is otherwise very similar. Not sure which people prefer
aesthetically. Just suggesting an alternative.
And lastly, a more general question:
bq. 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 is the second time (that I know of) where we've run into sticking points
dealing with formatting in our PDF vs HTML ref-guide. (SOLR-11584 being the
other). And I imagine these sorts of issues will continue to come up, as we
try to find better, more helpful ways of presenting information to our users.
Do we see ourselves continuing to support both formats for the foreseeable
future? (I'm not questioning the utility of our PDF release format. Just
curious whether anyone else is worried that it'll start to restrict our
flexibility sometime soon. Maybe I should've posted this as a mailing list
question instead of tacking it on here...)
was (Author: gerlowskija):
A few things:
1. Link to our current Streaming Expressions documentation, for the lazy:
http://lucene.apache.org/solr/guide/7_2/streaming-expressions.html
2. I'm a big fan of the Redis-inspired screenshot you attached above. It's a
big improvement on making these more compact. A related but different approach
would be to have the a small summary line for each Streaming Expression, that
expands-on-click to show more details. The default display for "Swagger" docs
comes close to what I'm suggesting: http://petstore.swagger.io/#/. It may be a
bit more compact, but is otherwise very similar. Not sure which people prefer
aesthetically. Just suggesting an alternative.
And lastly, a more general question:
bq. 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 is the second time (that I know of) where we've run into sticking points
dealing with formatting in our PDF vs HTML ref-guide. (SOLR-11584 being the
other). And I imagine these sorts of issues will continue to come up, as we
try to find better, more helpful ways of presenting information to our users.
Do we see ourselves continuing to support both formats for the foreseeable
future? (I'm not questioning the utility of our PDF release format. Just
curious whether anyone else is worried that it'll start to restrict our
flexibility sometime soon. Maybe I should've posted this as a mailing list
question instead of tacking it on here...)
bq. These ideas focus on the HTML layout of expressions - ideally we come up
with a solution for PDF that's better also
> 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: StreamQuickRef-sample.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]
