[jira] [Updated] (SOLR-10692) Split Streaming Expressions docs into more manageable parts

["Cassandra Targett (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SOLR-10692?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Cassandra Targett updated SOLR-10692:
-------------------------------------
    Attachment: solr-10692.patch

The attached patch pulls the details of each expression in the streaming-expressions.adoc into 3 new files, stream-sources.adoc, stream-decorators.adoc and stream-evaluators.adoc. It adds a short section linking the old Streaming Expressions page to these new files.

In order to allow the docs build to pass, every section must have a unique title or a unique anchor tag. This is to protect inter-document linking, particularly in the PDF where all pages get combined into one massive page. The net effect of this is that we can't have repeated sections like "Parameters" or "Syntax" - I could have added unique anchors to each one, but for ease of linking, I changed them to "search Parameters", "commit Parameters", "search Syntax", "commit Syntax", etc. for each expression.

My hope is that we can put in an alternate layout as described in my patch to SOLR-10612 with a TOC on the right side to make long pages like these will be easier to use.

There are also some minor changes to the glossary to make the docs build pass the unique title requirement.

> Split Streaming Expressions docs into more manageable parts
> -----------------------------------------------------------
>
>                 Key: SOLR-10692
>                 URL: https://issues.apache.org/jira/browse/SOLR-10692
>             Project: Solr
>          Issue Type: Bug
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Cassandra Targett
>             Fix For: 6.6, master (7.0)
>
>         Attachments: solr-10692.patch
>
>
> The Streaming Expressions page is too big and a mix of How To and Reference materials. It should be split up a bit to make it easier to use.
> First pass at this will split all the expression types into new pages according to the type, so there will be 3 new sub-pages:
> * Stream Sources
> * Stream Decorators
> * Stream Evaluators
> Once that's done, we'll see if there's more we can do with this.
> Attn [~joel.bernstein].



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org