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

David Smiley commented on SOLR-17563:
-------------------------------------

Personally, I don't think we need {{gradle help}}, although I appreciate the 
actual content that users can navigate to by just opening the file.

> Cleanup and merge dev-docs
> --------------------------
>
>                 Key: SOLR-17563
>                 URL: https://issues.apache.org/jira/browse/SOLR-17563
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Christos Malliaridis
>            Priority: Major
>
> In https://github.com/apache/solr/pull/2706 we have noticed that the 
> developer documentation may have sections that are outdated. Develoepr 
> documentation files are  also spread across multiple directories in our 
> project, and repetitive content likely exists.
> A way to improve this is to merge all the information found under help/ and 
> dev-docs/,
> but also lookup references to other documents, like 
> solr/licenses/README.committers.txt
> While merging, we could reorganize the information and consider to make it 
> more new-developer friendly. By updating the docs we could focus more on new 
> developers so that they have a single place they can use as a guide for 
> getting started.



--
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