lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jason Gerlowski (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (LUCENE-5822) Create a markdown formatted README file for Lucene/Solr
Date Thu, 08 Jun 2017 02:04:20 GMT

     [ https://issues.apache.org/jira/browse/LUCENE-5822?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Jason Gerlowski updated LUCENE-5822:
------------------------------------
    Attachment: LUCENE-5822.patch

Put together a README that we can at least use as a starting point for moving this forward.

Some notes:

- I based the outline (and the wording, in some places) off of the markdown-readme's used
by some other Apache projects.  Specifically relied on [Spark|https://github.com/apache/spark/blob/master/README.md]
and [Mesos|https://github.com/apache/mesos/blob/master/README.md] as examples.  Other layouts
might work better though.
- I made sure all details in our current {{/README.txt}} made it over to the new version of
the README
- There's now _some_ overlap between the root {{README.md}} and the {{solr/README.txt}} file.
 Specifically, both cover basic {{bin/solr}} usage.  I thought about removing it from the
root README my patch creates, but that seems like a piece of info that unfamiliar users would
expect in a root README.  Then I thought about removing it from {{solr/README.txt}}, but it
looks like that file is what gets put in the packaged Solr downloads, and those should definitely
have info on running Solr.  Maybe the duplication isn't a big deal.  Just wanted to bring
it up.

> 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.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message