Thank you for the help, Cassandra! >> By adding to documentation, do you mean the Solr Ref Guide? Or other internal documentation for developers?
I think Solr Ref Guide could be a good place for that. I am not sure where to put exactly. I filed SOLR-11275 about AutoAddReplica as a pilot. It would be especially interesting as a whole rewrite is going to happen under SOLR-10397, so it will be a chance to document changes of internals through time. Let's continue the discussion on SOLR-11275. Thank you, Mano On Fri, Aug 18, 2017 at 9:57 PM, David Smiley <[email protected]> wrote: > This is really cool; thanks for sharing! I didn't know we could create > these things in readable text. +1 to including such things in Solr's ref > guide. > > > On Fri, Aug 18, 2017 at 4:41 AM Mano Kovacs <[email protected]> > wrote: > >> Hi, >> >> As I was preparing a presentation about Solr internals, I tried to >> demonstrate some of the internal processes with sequence diagrams. I was >> using PlantUML for the purpose as it is opensource, pluggable to >> everything, and the markup language is readable, therefore, easy to version >> it. >> >> I was wondering if the diagrams would be useful part of the documentation >> for those who want to understand internals better. Since the diagrams are >> actual text files, it would be possible to store them within the repository >> and maintain them among the changes of the internals. It could be also used >> for planning new changes, to describe and validate how Solr is going to >> behave after a patch. >> >> What do you think about adding these diagrams into the documentation >> somewhere? >> >> Here are some examples: >> >> Recovery >> Code: https://github.com/manokovacs/solr-internals/ >> blob/master/recovery.puml >> Diag: https://github.com/manokovacs/solr-internals/ >> blob/master/recovery.png >> >> AutoAddReplica >> Code: https://github.com/manokovacs/solr-internals/ >> blob/master/autoaddreplica.puml >> Diag: https://github.com/manokovacs/solr-internals/ >> blob/master/autoaddreplica.png >> >> Thanks, >> Mano >> >> -- > Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker > LinkedIn: http://linkedin.com/in/davidwsmiley | Book: http://www. > solrenterprisesearchserver.com >
