[
https://issues.apache.org/jira/browse/SOLR-10892?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16065048#comment-16065048
]
Cassandra Targett commented on SOLR-10892:
------------------------------------------
The only tables left that could be considered for changing are those on pages
like {{faceting.adoc}} and the various edismax/dismax/etc. query parser pages,
where the table might have some reference value - as a quick reference for the
available params - and the names link to lower sections of the page where the
parameter is (supposedly) discussed in more detail. I haven't yet decided to
eliminate these intro tables or try to keep it in some fashion.
For the query parser pages, a table might really be handy to consolidate all
the various query params in one place - maybe a new page, or a new table on an
existing page - noting in the table which parser supports each param; then the
individual pages could omit the table and only have a description list.
> Ref Guide: Move parameters out of tables
> ----------------------------------------
>
> Key: SOLR-10892
> URL: https://issues.apache.org/jira/browse/SOLR-10892
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Fix For: master (7.0)
>
>
> We've overused a bit the concept of using tables to explain various config
> parameters. We have some tables that are massive and try to cram a ton of
> complex information into a row (see function-queries.adoc), while other
> tables are only 1 or 2 rows. It's not impossible, but it's also difficult to
> link directly to parameters when they are in a table
> AsciiDoc format now allows us to use "description lists" or "definition
> lists" which in many cases might be better. This issue would change many of
> the current tables to definition lists. However, some of them may remain,
> depending on how they work within the content.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
