[
https://issues.apache.org/jira/browse/SOLR-15242?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17488838#comment-17488838
]
Eric Pugh commented on SOLR-15242:
----------------------------------
On my flight I took a look at the two README's, and tried to summarize what
each has:
README.md
* Apache Solr
** Online Documentation
** Building with Gradle
** Running Solr <-- Merge with Getting Started
*** Running Solr in Docker <-- Keep
*** Running Solr on Kubernetes <-- Keep
*** Gradle build and IDE support <-- should be moved up to build.
** Contributing
** Discussion and Support
solr/README.md
* Welcome <-- More inspirational then the top level welcome.
* Getting started <--- This is nicer than the top level "Running Solr"
* Solr Examples <--- Missing films example.
* Indexing Documents
* Files included in an Apache Solr binary distribution <--- Feels like we can
eliminate this.
* Instructions for Building Apache Solr from Source
* Export control <--- Do we need this in the README?
I then made a README_v2.md, which I'll push up that was the first attempt at
combining them. It has a bunch of "FIXME" to remind me where to check text!
> Consolidate README.md with solr/README.md
> -----------------------------------------
>
> Key: SOLR-15242
> URL: https://issues.apache.org/jira/browse/SOLR-15242
> Project: Solr
> Issue Type: Sub-task
> Reporter: Jan Høydahl
> Assignee: Eric Pugh
> Priority: Major
>
> We have now [https://github.com/apache/solr/blob/main/README.md] and
> [https://github.com/apache/solr/blob/main/solr/README.md] that both try to
> introduce Solr.
> While we will keep the solr/ folder for some time for easier patch backport
> to 8.x, we can consolidate the README's. Perhaps re-write a smashing good one
> from scratch.
> Remember that some users view our github page as the project's homepage, so
> it should give a really good first introduction, without going too deep or
> becoming too long.
> See also SOLR-15241 about mentioning Docker
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
