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

Mike Drob commented on LUCENE-5822:
-----------------------------------

Markdown supports <!-- --> style comments, please include an apache license 
header.

Typo in envine: {{+Apache Lucene is a high-performance, full featured text 
search envine library}}

{{+## Online Documentation}}
For Solr, consider linking directly to the ref guide? Not a hard requirement.

{noformat}
+Apache Solr is an enterprise search platform written using Apache Lucene.  It
+can be run in standalone or distributed (SolrCloud) modes, and major features

+the `bin/solr` control scripts.  Solr can be run in either standalone or
+distributed (SolrCloud mode).
{noformat}
More duplication.

> Create a markdown formatted README file for Lucene/Solr
> -------------------------------------------------------
>
>                 Key: LUCENE-5822
>                 URL: https://issues.apache.org/jira/browse/LUCENE-5822
>             Project: Lucene - Core
>          Issue Type: Wish
>            Reporter: Shalin Shekhar Mangar
>         Attachments: LUCENE-5822.patch
>
>
> We have a minimal plain text readme file right now. Github is very popular 
> these days and we are even accepting pull requests from there. I think we 
> should add a proper markdown formatted README file which not only talks about 
> the features of Lucene/Solr but also include a short tutorial on both Lucene 
> and Solr.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to