[
https://issues.apache.org/jira/browse/SOLR-14444?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17360833#comment-17360833
]
Cassandra Targett commented on SOLR-14444:
------------------------------------------
FYI, once I'm ready to put up the PR I'm going to post to this issue the URL
and user/pass for seeing it in action on my people pages - hopefully in the
next week (I'm traveling this weekend).
bq. For TOC organization, I see you have "Schema and Indexing Guide" with
Indexing underneath that. To me, Indexing deserves to be top level just as
Query is; Index/Query are twins in a sense. Schema could go underneath
"Configuration Guide" or remain top level because it's so important. WDYT?
[~dsmiley] So this is tough. I definitely see your point of view here, and
don't necessarily disagree with you overall.
First, I wanted to only have 4-5 categories, settled on 5, then decided to add
a 6th in the form of the Upgrade Notes, and splitting Indexing out would make
7. Making only 5 was difficult to start with - we have around 15-20 categories
today because it can feel like you're equating things that aren't equal, and
then you want to try to highlight topics by not burying them, etc. Seven isn't
bad if that's what's needed, I just want whatever is at the top to be really
well thought out.
With that in mind, I also thought that you can't do a good job of indexing
until you've figured out the schema questions, so to discourage the
"schemaless" trap, we should highlight schema design as part of the indexing
process.
Another issue is that we don't actually have that much content about actually
indexing - DIH is gone in 9, Tika might go (but probably not at this point),
which would leave only update handlers and post.jar (itself also discouraged),
and then some associated content about atomic updates, content streams,
reindexing, and the document screen in the UI.
The top-level categories need to be broad enough to provide enough room for
future growth and avoid some of the sprawl we've seen over the years in our
current structure. There's currently 11 pages under the Indexing subsection,
vs. 23 pages relating to schemas, fields, analysis, etc. It's comparatively
thin.
If it's OK with you, I'd like to leave this question open and revisit it once
you've been able to browse through the actual pages. You may or may not change
your mind, and if you haven't we can explore it some more and settle on the
right answer.
> Ref Guide Redesign Phase 2: Page Organization Overhaul
> ------------------------------------------------------
>
> Key: SOLR-14444
> URL: https://issues.apache.org/jira/browse/SOLR-14444
> Project: Solr
> Issue Type: Improvement
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Major
> Fix For: main (9.0)
>
>
> SOLR-14173 changed the look & feel of the Ref Guide, and left one glaring
> problem unresolved: our top-level categories are far too many for that sort
> of design.
> This issue will track a full reconsideration of the Ref Guide organization. I
> have a couple of thoughts and will update this issue with those when I get
> started on it; for now this is a placeholder issue for future work.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
