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

Dawid Weiss commented on SOLR-12930:
------------------------------------

bq.  I'm not sure how being in a different directory than the one they were in 
is "burying" them - there's literally one other file there right now [...]

Well, this one is really subjective. I have a feeling these dev-docs will 
accumulate instructions on more complex processes (like release manager tasks, 
etc.). I really wanted to keep the help/* scripts as simple as possible, 
focused on a particular thing or task so that you can quickly look at them when 
you need something. Contrary to dev-docs (which will probably be in a rich text 
format) I wanted these files to be simple ascii too (so that they can be 
displayed via gradle task or even cat/ vi/ you name it). 

I know this may be perceived as an inconsistency with dev-docs and I have 
nothing other than the above to defend it. Maybe with time (when people learn 
those new tools) the need for help/* will decrease and we can move them under 
dev-docs (?).

> Add developer documentation to source repo
> ------------------------------------------
>
>                 Key: SOLR-12930
>                 URL: https://issues.apache.org/jira/browse/SOLR-12930
>             Project: Solr
>          Issue Type: Improvement
>          Components: Tests
>            Reporter: Mark Miller
>            Priority: Major
>         Attachments: solr-dev-docs.zip
>
>          Time Spent: 1h 20m
>  Remaining Estimate: 0h
>




--
This message was sent by Atlassian Jira
(v8.3.4#803005)

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

Reply via email to