deployment: fixes on images and registry from review

Co-authored-by: Zacharias Zacharodimos <[email protected]>

Author: Pablo Panero

docs/deployment/image.md

@@ -11,8 +11,8 @@ docker build -t demo-inveniordm /path/to/your/instance --build-arg include_asset
 
 **Why is the `include_assets` flag needed**
 
-When running InvenioRDM in local (`invenio-cli run`) you are running the uWSGI server in your own machine. On the other hand, when running `invenio-cli containerize` you are building the docker image. Then you are runing it in your machine along the other containers. Nonetheless, the statics are built in a different fashion. However, when deploying somewhere else they are needed. 
+When running InvenioRDM in local (`invenio-cli run`), you are running the uWSGI server on your own machine where you have built the statics. On the other hand, when running `invenio-cli containerize` you are building the docker image and then running it along the other containers. There, `invenio-cli` takes care of building the statics in the mounted volume for you. However, when building the image on your own (e.g. deploying somewhere else), you need to take care of the statics yourself.
 
-This is the case when deploying in OpenShift. To solve this problem the charts define a share volume mounted on the Nginx and the Web containers. 
+This is the case when deploying in OpenShift. To solve this problem the chart defines a shared volume mounted on the Nginx and the Web containers.
 
 When a volume is mounted it overwrites the contents of the folder (i.e. it will delete the assets). Therefore, we make use of an `initContainer` to mount the volume in a temporary location and copy to the volume the assets. This way when the volume is mounted into Nginx and Web containers it already has the assets. Being the end result that `/static` files can be served directly by Nginx.

docs/deployment/registries.md

@@ -17,13 +17,13 @@ To store your image in GitHub you will need a repository. You can use your insta
 *https://github/yourusername/rdmrepo*. In addition, you will need to [create an access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). This access token must have
 `read:packages` and `write:packages` scopes.
 
-The first step is to login in GitHub's docker registry:
+The first step is to log in to GitHub's docker registry:
 
 ``` console
 $ docker login docker.pkg.github.com -u <YOU_GITHUB_USERNAME> -p <YOUR_GITHUB_TOKEN>
 ```
 
-Then find your docker image and tag it you the url of your GitHub registry:
+Then, find your docker image and tag it with the url of your GitHub registry:
 
 ```
 $ docker images
@@ -45,7 +45,7 @@ demo-inveniordm                                                 latest
 docker.pkg.github.com/yourusername/rdmrepo/rdmimage:latest      latest              9b6dd5ae6b48        17 hours ago        2.33GB
 ```
 
-The last step is to push your package to the github registry:
+The last step is to push your package to the GitHub registry:
 
 ``` console
 docker push docker.pkg.github.com/yourusername/rdmrepo/rdmimage:latest
@@ -54,7 +54,11 @@ docker push docker.pkg.github.com/yourusername/rdmrepo/rdmimage:latest
 In order to use this image, you must set the following value in your `values.yaml` file (for both `web` and `worker`):
 
 ```
-image: docker.pkg.github.com/yourusername/rdmrepo/rdmimage:latest 
+web:
+    image: docker.pkg.github.com/yourusername/rdmrepo/rdmimage:latest
+
+worker:
+    image: docker.pkg.github.com/yourusername/rdmrepo/rdmimage:latest
 ```
 
 Even if your project and/or image is public, GitHub requires you to be authenticated in order to pull your image.
@@ -71,7 +75,7 @@ $ oc secrets link default <SECRET_NAME> --for=pull \
 
 ## OpenShift
 
-First you need to login in your OpenShift cluster and its image registry:
+First you need to log in to your OpenShift cluster and its image registry:
 
 ``` console
 $ docker login -u openshift -p $(oc whoami -t) <registry_ip>:<port>
@@ -80,7 +84,7 @@ $ oc project
 Using project "inveniordm" on server "<registry_ip>:<port>".
 ```
 
-Then find your docker image and tag it you the url of your OpenShift registry:
+Then, find your docker image and tag it with the url of your OpenShift registry:
 
 ``` console
 $ docker images
@@ -91,7 +95,7 @@ $ docker tag demo-inveniordm <registry_ip>:<port>/inveniordm/demo-inveniordm:lat
 ```
 
 !!! info "Project name"
-    Note that `inveniordm` is the name of the OpenShift project we are using. It's value should be the one returned
+    Note that `inveniordm` is the name of the OpenShift project we are using. Its value should be the one returned
     by the `oc project` command. Therefore the tag is: ``<registry_ip>:<port>/<project_name>/<name_of_your_image>:<version>``
 
 Check that it was tagged correctly:
@@ -112,5 +116,9 @@ $ docker push <registry_ip>:<port>/inveniordm/demo-inveniordm:latest
 In order to use this image, you must set the following value in your `values.yaml` file (for both `web` and `worker`):
 
 ``` console
-image: <registry_ip>:<port>/inveniordm/demo-inveniordm:rdm 
+web:
+    image: <registry_ip>:<port>/inveniordm/demo-inveniordm:rdm
+
+worker:
+    image: <registry_ip>:<port>/inveniordm/demo-inveniordm:rdm
 ```