docs[docs, istallation] add minor fixes on documentation.

bitmakerla · Jan 23, 2023 · c2d58be · c2d58be
1 parent dd32b80
commit c2d58be
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/docs/estela/installation/helm-variables.md b/docs/estela/installation/helm-variables.md
@@ -71,6 +71,10 @@ you have a deep understanding of estela.
 * _<SPIDERDATA\_DB\_ENGINE>_ (Required): Document oriented database where the data produced 
   by the spiders is stored. Currently, estela supports the _mongodb_ engine.
 
+  > **NOTE:**
+  >  For dev a free [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) deploy can be used to set a database, as mentioned on [Estela Resources Guide](./resources.md).
+  >  Or a mongodb can be setup on a local cluster on a docker image.
+
 * _<SPIDERDATA\_DB\_CONNECTION>_ (Required): The connection URL to your database instance.
 
 * _<SPIDERDATA\_DB\_CERTIFICATE\_PATH>_ (Required): Path where the database certificate is
@@ -100,7 +104,7 @@ you have a deep understanding of estela.
 #### Registry
 
 * _<REGISTRY\_HOST>_ (Required): Address of the registry used to store the estela projects.
-  This value can be equal to the variable _registryHost_.
+  This value can be equal to the variable **_registryHost_**.
 
 * _<REGISTRY\_ID>_: (Optional) Fill this values if you registry has an associated ID.
 
@@ -139,6 +143,8 @@ you have a deep understanding of estela.
 
 #### Mailing
 
+  > **Note:** The mailing configuration is used to send email regarding users creation on the estela system.
+
 * _<EMAIL\_HOST>_ (Required): Host of the SMTP email server.
 
 * _<EMAIL\_PORT>_ (Required): Port of the SMTP email server.

diff --git a/installation/helm-chart/values.yaml.example b/installation/helm-chart/values.yaml.example
@@ -1,15 +1,15 @@
 #################### CHART VARIABLES ####################
 
 local: true
-hostIp: ""
-registryHost: ""
+hostIp: "" # on local dev deploy the value from `$ minikube ssh 'grep host.minikube.internal /etc/hosts | cut -f1'` can be used
+registryHost: "" # hostIp:5000
 nodeSelector: ""
 
 #################### CLOUD VARIABLES ####################
 
 ######## AWS ########
 
-AWS_ACCESS_KEY_ID: ""
+AWS_ACCESS_KEY_ID: "" # values need from a AWS account
 AWS_SECRET_ACCESS_KEY: ""
 AWS_DEFAULT_REGION: ""
 
@@ -22,7 +22,7 @@ imagePullSecrets: ""
 
 # Database
 SPIDERDATA_DB_ENGINE: mongodb
-SPIDERDATA_DB_CONNECTION: ""
+SPIDERDATA_DB_CONNECTION: "" # [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) can be used to set a database
 SPIDERDATA_DB_CERTIFICATE_PATH: config/ca-certificate.crt
 
 # Kafka
@@ -39,13 +39,13 @@ DB_USER: "" # django-api
 DB_PASSWORD: "" # estela12345
 
 # Registry
-REGISTRY_HOST: ""
+REGISTRY_HOST: "" # same value as registryHost
 REGISTRY_ID: ""
 REPOSITORY_NAME: "" # estela-projects
 BUCKET_NAME_PROJECTS: "" # estela-api-projects
 
 # Settings
-SECRET_KEY: ""
+SECRET_KEY: "" # it can generate one on https://djecrety.ir/ To avoid reading conflicts, enclose the value in quotes.
 DJANGO_SETTINGS_MODULE: "" # config.settings.local
 ENGINE: "" # kubernetes
 CREDENTIALS: "" # local