I’d love to see some documentation improvements, please tag me for review.

There is this document, but I don’t love it: 
https://cwiki.apache.org/confluence/display/SOLR/HowToContribute

So…. Let me try to describe how you would contribute a documentation fix!

1) Go ahead and fork the GitHub.com/apache/solr project into your own branch.  
For me, I have GitHub.com/epugh/solr

2) Clone your repo to your local environment: git clone 
https://github.com/epugh/solr.git

3) Open up a JIRA ticket for your patch on the Solr JIRA

4) Make a branch for your fix via git checkout -B YOUR_JIRA_NUMBER

5) Make sure you can build Solr Ref Guide via ./gradlew buildLocalSite

6) This will output the docs in solr/solr-ref-guide/build/site/index.html

7) Edit the .adoc files that you need to in solr/solr-ref-guide/modules

8) Rebuild the site after your changes, check it, edit it as needed till you 
are done!

9) Commmit your changes….  Github Desktop works great.

10) Go to GitHub.com/apache/solr and you will be prompted to submit your branch 
as a Pull Request to the main project.

11) Tag Eric to review ;-)



> On Mar 4, 2022, at 4:02 PM, Dan Armbrust <daniel.armbrust.l...@gmail.com> 
> wrote:
> 
> On 3/4/22 1:33 PM, 6harat wrote:
>> Hi,
>> I am not able to hit any limit in terms of uploading a 100MB file and was 
>> able to search the relevant fields inside the doc too.
>> 
>> 
>> I hope:
>> 1. The json file that you are trying to upload has a root level key named 
>> "docs"
>> 2. You are not trying to fetch the entire document when using solr admin UI.
>> 
> 
> Thanks for this - #1 - I had a copy/paste error in my load script, and didn't 
> intend to have that /docs in the wildcard string.
> 
> That said, there may be an opportunity to improve this documentation a bit:
> https://solr.apache.org/guide/6_6/transforming-and-indexing-custom-json.html
> 
> Until now, I didn't realize that that is what f=*/docs*/* was doing in this 
> context - relating to the structure of the json itself.  In retrospect, its 
> pretty confusing to use /docs in the example there, when the rest endpoint 
> also uses /docs and solr is capturing documents itself.  Plus, the curl 
> example given has json content that doesn't contain a root level key of docs.
> 
> How do you typically handle documentation updates?  I think this section 
> would be much more clear if f=*/docs*/* was changed to something else, and if 
> the json example given actually had something that demonstrated this.
> 
> I can deal with the scaling issues on the hit in the monster document, this 
> is just proof of concept / demo ware.
> 
> Thanks,
> 
> Dan
> 
> 

_______________________
Eric Pugh | Founder & CEO | OpenSource Connections, LLC | 434.466.1467 | 
http://www.opensourceconnections.com <http://www.opensourceconnections.com/> | 
My Free/Busy <http://tinyurl.com/eric-cal>  
Co-Author: Apache Solr Enterprise Search Server, 3rd Ed 
<https://www.packtpub.com/big-data-and-business-intelligence/apache-solr-enterprise-search-server-third-edition-raw>
    
This e-mail and all contents, including attachments, is considered to be 
Company Confidential unless explicitly stated otherwise, regardless of whether 
attachments are marked as such.

Reply via email to