[ 
https://issues.apache.org/jira/browse/SOLR-17468?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17886177#comment-17886177
 ] 

Cassandra Targett edited comment on SOLR-17468 at 10/1/24 1:59 PM:
-------------------------------------------------------------------

_Edit to add - I've been really out of the loop, so if this has been discussed 
please point me at it (I took a quick look, and didn't see anything but could 
have missed it)._

> Ignoring the naming terminology, does the rest of the ref guide reorg make 
> sense to you?

So I don't want to ignore the naming terminology which is why I jumped in to 
the issue. We discussed it to death 4 or so years ago and reached as much 
consensus on "user-managed" as we were going to get on any wording back when 
the last round of changes to the Ref Guide were done (3+ years ago). I worked 
on it personally. I reviewed every occurrence of "standalone" and rewrote every 
sentence so the terminology would be consistent and clear across every single 
page. Is that the effort you are doing now? Because it sort of sounds like 
moving sections around and otherwise a find/replace action, which I think would 
end up with less clarity.

Then, I think "standalone" is just plain incorrect. A "standalone cluster" 
makes little sense semantically, it's sort of like "an individual group". This 
situation requires really thinking about this (which was done already) and how 
it's described and presented to users. People who prefer not to use SolrCloud 
do so for what reasons? The Ref Guide needs to reflect how they use it (I think 
as a community we have a bias that anyone not using SolrCloud is spinning up 
solo instances for quick tests or have very small implementations and that is 
definitely not the case).

In fact, I'm a bit unclear on the motivations and goals here - Are there major 
confusions occurring the user community? Or do we just want to rename a CLI 
command? Why does that mean SolrCloud must be moved to the top of every page? 
Does that make sense for every page? (In one specific example, it's not at the 
top of the page on purpose...).

I don't see a PR linked here or in the parent issue and I haven't followed 
every message on the list in a long time so I really don't know what "the rest 
of the ref guide reorg" means in the quoted sentence.


was (Author: ctargett):
> Ignoring the naming terminology, does the rest of the ref guide reorg make 
> sense to you?

So I don't want to ignore the naming terminology which is why I jumped in to 
the issue. We discussed it to death 4 or so years ago and reached as much 
consensus on "user-managed" as we were going to get on any wording back when 
the last round of changes to the Ref Guide were done (3+ years ago). I worked 
on it personally. I reviewed every occurrence of "standalone" and rewrote every 
sentence so the terminology would be consistent and clear across every single 
page. Is that the effort you are doing now? Because it sort of sounds like 
moving sections around and otherwise a find/replace action, which I think would 
end up with less clarity.

Then, I think "standalone" is just plain incorrect. A "standalone cluster" 
makes little sense semantically, it's sort of like "an individual group". This 
situation requires really thinking about this (which was done already) and how 
it's described and presented to users. People who prefer not to use SolrCloud 
do so for what reasons? The Ref Guide needs to reflect how they use it (I think 
as a community we have a bias that anyone not using SolrCloud is spinning up 
solo instances for quick tests or have very small implementations and that is 
definitely not the case).

In fact, I'm a bit unclear on the motivations and goals here - Are there major 
confusions occurring the user community? Or do we just want to rename a CLI 
command? Why does that mean SolrCloud must be moved to the top of every page? 
Does that make sense for every page? (In one specific example, it's not at the 
top of the page on purpose...).

I don't see a PR linked here or in the parent issue and I haven't followed 
every message on the list in a long time so I really don't know what "the rest 
of the ref guide reorg" means in the quoted sentence.

> Revamp Ref Guide to feature SolrCloud.  
> ----------------------------------------
>
>                 Key: SOLR-17468
>                 URL: https://issues.apache.org/jira/browse/SOLR-17468
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>    Affects Versions: main (10.0)
>            Reporter: Eric Pugh
>            Assignee: Eric Pugh
>            Priority: Major
>
> Move SolrCloud mode to the top of each page, and update how we refer to 
> "user-managed" or "single node" as just "standalone".   Standalone is what we 
> all agreed is the default term, despite attempts to move away after much bike 
> shedding!
>  
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

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

Reply via email to