You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by GitBox <gi...@apache.org> on 2022/02/08 13:43:42 UTC
[GitHub] [solr] epugh opened a new pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
epugh opened a new pull request #610:
URL: https://github.com/apache/solr/pull/610
https://issues.apache.org/jira/browse/SOLR-15242
# Description
Consolidate README.md with solr/README.md
# Solution
Trying not to duplicate things, trying to not get in TOO much depth, but give enoguh so that folks who go to github.com/apache/solr have a nice experience!
# Tests
Please describe the tests you've developed or run to confirm this patch implements the feature or solves the problem.
# Checklist
Please review the following and check all that apply:
- [X ] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [ X] I have created a Jira issue and added the issue ID to my pull request title.
- [ X] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [X ] I have developed this patch against the `main` branch.
- [ ] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
- [ ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
epugh commented on pull request #610:
URL: https://github.com/apache/solr/pull/610#issuecomment-1035479626
Just added some getting started based on what @chatman did in https://github.com/apache/lucene-solr/pull/2594/, thoughts @janhoy ???
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] janhoy commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
janhoy commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r801694024
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
Review comment:
We are now changing Docker image to use eclipse-temurin, so perhaps we should point people to https://adoptium.net/ here too?
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
+for information on contributing.
+
+## Discussion and Support
+
+- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
+- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
+- IRC: `#solr` and `#solr-dev` on freenode.net
+- [Slack](https://solr.apache.org/community.html#slack)
+
+# Export control
Review comment:
Do other Apache projects have this? Where does this requirement come from?
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
+for information on contributing.
+
+## Discussion and Support
+
+- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
+- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
+- IRC: `#solr` and `#solr-dev` on freenode.net
Review comment:
I think we have officially moved from freenode to https://libera.chat/, but check with @chatman who worked with the cutover and the slack bridge??
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
Review comment:
Perhaps highlight the `./gradlew dev` task instead, as it it creates a build on a stable path and is made for quick developer cycles. Then we won't need to change the README for every release either, replacing the `solr-9.0.0-SNAPSHOT` string :)
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
Review comment:
```suggestion
Solr uses [Gradle](https://gradle.org/) as the build
```
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
Review comment:
Later, the result of https://issues.apache.org/jira/browse/SOLR-15682 will be linked here...
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
Review comment:
Perhaps add a link to `dev-docs/docker.adoc` - eeh, no, wait that does not exist, I meant `help/docker.txt` -- eh, sorry, wrong again, it should be `solr/docker/gradle-help.txt` (why on earth do we have dev-docs spread out this much?) so we don't need to say so much about building Docker locally in the main README.
Hmm, looking a few lines down, I now see that `./gradlew helpDocker` actually points to that txt file, but that is not consistent either, would expect all help files to exist in help/.. Well, well.
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
Review comment:
General about building from source and gradle - perhaps we should make some really good and thorough guides about that topic in `dev-docs`, and just have a few really basic examples here in the main readme, like `./gradlew dev` and `cd solr/packaging/dev/ && bin/solr -e techproducts`...
But i see that the main focus here is merging the two READMEs, so feel free to postpone dev-docs work to later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r803982342
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
+for information on contributing.
+
+## Discussion and Support
+
+- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
+- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
+- IRC: `#solr` and `#solr-dev` on freenode.net
Review comment:
https://webchat.freenode.net/?channels=#solr doesn't work so assuming that indicates freenode shut down.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r804006217
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
Review comment:
Done!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r804002546
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
+for information on contributing.
+
+## Discussion and Support
+
+- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
+- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
+- IRC: `#solr` and `#solr-dev` on freenode.net
Review comment:
SOLR-15432 is the ticket!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] janhoy commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
janhoy commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r804045780
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
Review comment:
That can be done in followup issues. I think we plan for a separate dev-guide, and not mash everything into ref-guide.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] janhoy commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
janhoy commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r803575377
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
+for information on contributing.
+
+## Discussion and Support
+
+- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
+- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
+- IRC: `#solr` and `#solr-dev` on freenode.net
+- [Slack](https://solr.apache.org/community.html#slack)
+
+# Export control
Review comment:
Ok, we should keep it then...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r804003319
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
Review comment:
I agree with the sentiment! We should rationalize more the `dev-docs` and the stuff in ref guide related to development. Or just put `dev-docs` etc in Ref Guide!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
epugh commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r804009457
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
Review comment:
I'm going to take this as "it's okay" for now then on this comment? Quite agree on your frustration!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] madrob commented on a change in pull request #610: SOLR-15242: Consolidate README.md with solr/README.md
Posted by GitBox <gi...@apache.org>.
madrob commented on a change in pull request #610:
URL: https://github.com/apache/solr/pull/610#discussion_r801853363
##########
File path: README_v2.md
##########
@@ -0,0 +1,176 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Welcome to the Apache Solr project!
+-----------------------------------
+
+Solr is the popular, blazing fast open source enterprise search platform
+written in Java and using [Apache Lucene](https://lucene.apache.org/).
+
+For a complete description of the Solr project, team composition, source
+code repositories, and other details, please see the Solr web site at
+https://solr.apache.org/
+
+## Online Documentation
+
+This README file only contains basic instructions. For comprehensive documentation,
+visit the [Solr Reference Guide](https://solr.apache.org/guide/).
+
+## Getting Started
+FIXME maybe put the tutorial that Noble or Ishan wrote??? Then at the end put the examples?
+
+### Solr Examples
+
+Solr includes a few examples to help you get started. To run a specific example, enter:
+
+```
+ bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
+ FIXME the labels in the README do NOT match what is in the bin/solr start -help, and are better!
+ cloud: SolrCloud example
+ techproducts: Comprehensive example illustrating many of Solr's core capabilities
+ schemaless: Schema-less example (schema is inferred from data during indexing)
+ films: Example of starting with _default configset and adding explicit fields dynamically
+```
+
+For instance, if you want to run the SolrCloud example, enter:
+
+```
+ bin/solr -e cloud
+```
+
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
+## Building Solr from Source
+FIXME --> is this where we get JDK from?? What about OpenJDK?
+Download the Java 11 JDK (Java Development Kit) or later from https://jdk.java.net/
+You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin)
+folder included on your command path. To test this, issue a "java -version" command
+from your shell (command prompt) and verify that the Java version is 11 or later.
+
+Download the Apache Solr distribution, from http://solr.apache.org/. FIXME link??
+Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
+Alternately, you can obtain a copy of the latest Apache Solr source code
+directly from the Git repository:
+
+<https://solr.apache.org/community.html#version-control>
+
+As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
+system. Navigate to the root of your source tree folder and issue the `./gradlew tasks`
+command to see the available options for building, testing, and packaging Solr.
+
+`./gradlew assemble` will create a Solr executable.
+cd to `./solr/packaging/build/solr-9.0.0-SNAPSHOT` and run the `bin/solr` script
+to start Solr.
+
+NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
+start using the correct version of Gradle for Solr.
+
+NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+number of plain-text files in <source folder root>/help.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
+
+Note as well that the gradle build does not create or copy binaries throughout the
+source repository so you need to switch to the packaging output folder `./solr/packaging/build`;
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
+
+If you want to build the documentation, type `./gradlew -p solr documentation`.
+
+`./gradlew check` will assemble Solr and run all validation tasks unit tests.
+
+Lastly, there is developer oriented documentation in `./dev-docs/README.adoc` that
+you may find useful in working with Solr.
+
+
+### Gradle build and IDE support
+
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
+- *Eclipse* - Not tested.
+- *Netbeans* - Not tested.
+
+## Contributing
+
+Please review the [Contributing to Solr Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute)
+for information on contributing.
+
+## Discussion and Support
+
+- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
+- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
+- IRC: `#solr` and `#solr-dev` on freenode.net
+- [Slack](https://solr.apache.org/community.html#slack)
+
+# Export control
Review comment:
https://infra.apache.org/crypto.html#inform
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org