chibenwa commented on a change in pull request #718:
URL: https://github.com/apache/james-project/pull/718#discussion_r739322782
##########
File path: server/apps/distributed-app/docs/modules/ROOT/nav.adoc
##########
@@ -5,6 +5,11 @@
*** xref:architecture/specialized-instances.adoc[]
** xref:run.adoc[]
** xref:run-docker.adoc[]
+** xref:run-kubernetes.adoc[]
+*** xref:helm/checklist.adoc[Deployment Checklist]
+*** xref:helm/logsMetrics.adoc[Logs & Metrics]
+*** xref:helm/values.adoc[values.yaml]
+*** xref:helm/secrets.adoc[secrets.yaml]
Review comment:
I would propose the entire run section to be a sub-section
```
** xref:run.adoc[] (a little introduction page saying "hey you can run James
with java, docker or k8s)
*** xref:run-java.adoc[] (today run.adoc)
*** xref:run-docker.adoc[]
*** xref:run-kubernetes.adoc[]
**** xref:helm/checklist.adoc[Deployment Checklist]
**** xref:helm/logsMetrics.adoc[Logs & Metrics]
**** xref:helm/values.adoc[values.yaml]
**** xref:helm/secrets.adoc[secrets.yaml]
```
##########
File path: server/apps/distributed-app/helm-chart/james/doc/checklist.md
##########
@@ -6,40 +6,39 @@ There is some things that you must have before being able to
run James on your K
Review comment:
Get rid of these markdown files and just keep a link to the doc in the
READMEs
##########
File path:
server/apps/distributed-app/docs/modules/ROOT/pages/helm/checklist.adoc
##########
@@ -0,0 +1,43 @@
+# Checklist
Review comment:
This do not yet follow the ascii doctor format
--
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]
