[GitHub] [solr] ctargett commented on pull request #239: SOLR-15567: Document Schema Designer screen in ref guide.

[GitBox <gi...@apache.org>]

ctargett commented on pull request #239:
URL: https://github.com/apache/solr/pull/239#issuecomment-889231635


   With the changes I made in the recent big re-org, one thing I did was break up all the Admin UI pages and spread them around so they're adjacent to the docs for whatever the UI provides access to - the Cloud screens docs is with the other SolrCloud content, the Logging screen docs got merged with the docs on how to configure logging, the Document Upload screen is with the pages about indexing, etc.
   
   Basically, I wanted to stop treating the Admin UI as a special, separate thing, and instead document overall features/functions more holistically and in a less disjointed way - here's the way this thing works, here's how you interact with Solr to configure this thing, including a UI for it (when there is one). Depending on how complex the "thing" is, it might be all on a single page or on multiple pages.
   
   So following this organizational idea, I think the Schema Designer should move from being a child of `solr-admin-ui.adoc` (where it feels a little orphaned organizationally, being the only child page there) to being a child of either `solr-schema.adoc` or `fields-schema-design.adoc` - that's where all the content about Solr's schema generally and the specifics of the schema elements live now.
   
   I understand why you may have thought to put it under `solr-admin-ui.adoc`, since that page lives under Getting Started, and you stated you wanted the Schema Designer to be a getting started tool. Moving it may seem like it prevents that, but I think we could highlight within the various pages under Getting Started (like in `documents-fields-schema-design.adoc`, for one, but also others) that the tool exists. Then when people do use the docs, they have access through the left nav to the related ideas and documentation that they need. Eventually someday we/someone could write a tutorial which would walk a new user through it using sample data.
   
   What do you think?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org