Clarification of docs structure. Related to #83.

gdcc · Oct 14, 2019 · 926bc21 · 926bc21
1 parent 8d01a75
commit 926bc21
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -36,9 +36,6 @@ kubectl apply -k .
 - This is usable for demo purposes.
 - You really want to [provide a secure admin password](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/secrets.md) for anything serious.
 
-A number of utilities have been added for your convienience:
-have a look at [Little Helpers](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/little-helpers.md).
-
 #### Production usage
 You should make yourself familiar with a series of documentation articles, linked below:
 
@@ -48,6 +45,7 @@ You should make yourself familiar with a series of documentation articles, linke
 * [Configuration of Dataverse](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/config.md)
 * [Secrets usage](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/secrets.md)
 * [(Custom) Metadata Blocks](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/metadata.md)
+* [Maintenance Jobs and Little Helpers](https://github.com/IQSS/dataverse-kubernetes/blob/master/docs/little-helpers.md)
 
 Please be aware that this project currently only offers images and support
 for basic usage. Integrations are not yet part of this, but may be added as needed.

diff --git a/docs/little-helpers.md b/docs/little-helpers.md
@@ -10,6 +10,9 @@ in the docs for you. Simply deploy it during off-hours (or fork and create a Cro
 kubectl create -f k8s/dataverse/jobs/inplace-reindex.yaml
 ```
 
+### Metadata Housekeeping
+See [Metadata docs](metadata.md).
+
 ### Catching emails from Dataverse easily
 While doing a showcase, developing or other purposes, it comes in handy
 to see what emails are sent by Dataverse.

diff --git a/docs/metadata.md b/docs/metadata.md
@@ -27,4 +27,4 @@ Remember: you will need to get your custom metadata inside that job somehow, see
 
 ## Update Solr Search Index
 
-> TODO for release 4.16 containing necessary scripts.
+> TODO for release 4.17 containing necessary scripts.
diff --git a/docs/secrets.md b/docs/secrets.md
@@ -32,6 +32,7 @@ kubectl create secret generic dataverse-postgresql \
 ### Provision a password for your superadmin account
 The password for the superadmin account `dataverseAdmin` defaults to
 **admin1**. *You really should change that to something more secure.*
+
 <small>*Note:* this password is the same as IQSS/dataverse-ansible uses!</small>
 
 During bootstrap, mount a secret at `${SECRETS_DIR}/admin/password` to provision
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,4 +27,4 @@ Remember: you will need to get your custom metadata inside that job somehow, see

		## Update Solr Search Index

		> TODO for release 4.16 containing necessary scripts.
		> TODO for release 4.17 containing necessary scripts.