HoustonPutman commented on code in PR #610: URL: https://github.com/apache/solr/pull/610#discussion_r918093282
########## 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: Sorry for that placement, there was discussion at the time, but it is long forgotten. I'd be happy to move it to wherever it will make the most sense 🙂 ########## README_v2.md: ########## @@ -0,0 +1,307 @@ +<!-- + 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? Review Comment: I agree that we shouldn't have a full-blown tutorial here. We should have links to our actual tutorials, and enhance them if need be. If we do keep a tutorial here, let's put other stuff before it, like the docker and kubernetes sections. These are smaller and are really just advertising other documentation/sites that people should be checking out. ########## README_v2.md: ########## @@ -0,0 +1,307 @@ +<!-- + 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? + +### Starting Solr + +Start a Solr node in cluster mode (SolrCloud mode) + +``` +bin/solr -c +``` + +To start another Solr node and have it join the cluster alongside the first node, + +``` +bin/solr -c -z localhost:9983 -p 8984 +``` + +An instance of the cluster coordination service, i.e. Zookeeper, was started on port 9983 when the first node was started. To start Zookeeper separately, please refer to XXXX. + +### Creating a collection + +Like a database system holds data in tables, Solr holds data in collections. A collection can be created as follows: + +``` +curl --request POST \ +--url http://localhost:8983/api/collections \ Review Comment: [-0] If we are trying to fixup the v2 APIs before marketing them, lets unfortunately continue to use the v1 APIs until they are ready. (If we plan on keeping the tutorial section) -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
