janhoy commented on a change in pull request #572:
URL: https://github.com/apache/solr/pull/572#discussion_r794084057
##########
File path: solr/solr-ref-guide/src/installing-solr.adoc
##########
@@ -101,6 +101,8 @@ See the
<<monitoring-with-prometheus-and-grafana.adoc#,documentation>> for more
docker/::
This contains a Dockerfile to build a Docker image from the binary
distribution, that is compatible with the official image.
This directory also contains the scripts needed when using Solr inside the
Docker image, under the `scripts/` directory.
+The `README.md` in this directory describes how custom Solr Docker images can
be built using this binary distribution.
+Refer to the <<solr-in-docker.adoc#,Running Solr in Docker>> page for
information on using a Solr docker image.
Review comment:
```suggestion
Refer to the <<solr-in-docker.adoc#,Running Solr in Docker>> page for
information on using a Solr Docker image.
```
We use caps Docker in most places, so we should be consistent.
##########
File path: solr/README.md
##########
@@ -158,6 +158,7 @@ prometheus-exporter/
docker/
Contains a docker file to build a Docker image using the source binary
distribution.
docker/scripts contains scripts that the docker image uses to manage Solr.
Review comment:
```suggestion
`docker/scripts` contains scripts that the Docker image uses to manage
Solr.
```
##########
File path: solr/docker/README.md
##########
@@ -0,0 +1,49 @@
+<!--
+ 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.
+-->
+
+Solr Docker
+----
+
+This Solr docker module creates both a local Docker image from the source as
well as the official Solr Dockerfile.
+This allows for local images to be completely compatible with the official
Solr images available on DockerHub.
+
+In order to build/test/tag your Docker images using local Solr source code,
please refer to `./gradlew helpDocker`
Review comment:
```suggestion
In order to build/test/tag your Docker images using local Solr source code,
please refer to `./gradlew helpDocker` in a git checkout or a source-release
download.
```
As I understand, this README is copied into the binary distro.
Can it be confusing for a user untar'ing the release that the README talks
about building from source and gradlew? I suppose most users know that by
"source" we mean the git checkout or the source tgz download, but should we
call it out in some way?
##########
File path: solr/docker/templates/Dockerfile.body.template
##########
@@ -26,10 +26,11 @@
#-#
#-#
-# add symlink to /opt/solr, remove what we don't want
+# add symlink to /opt/solr, remove what we don't want.
+# Remove the Dockerfile because it might not represent the dockerfile that was
used to generate the image.
RUN set -ex; \
(cd /opt; ln -s solr-*/ solr); \
- rm -Rf /opt/solr/docs;
+ rm -Rf /opt/solr/docs /opt/solr/docker/Dockerfile;
Review comment:
This will leave behind a docker/ folder with a README.md. Could just as
well remove the folder?
##########
File path: solr/README.md
##########
@@ -158,6 +158,7 @@ prometheus-exporter/
docker/
Contains a docker file to build a Docker image using the source binary
distribution.
Review comment:
```suggestion
Contains a Dockerfile to build a Docker image using the source or binary
distribution.
```
--
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]
