Doc review #123
Doc review #123
Conversation
|
There were the following issues with this Pull Request
You may need to change the commit messages to comply with the repository contributing guidelines. 🤖 This comment was generated by commitlint[bot]. Please report issues here. Happy coding! |
charts/README.md
Outdated
|
|
||
| ```shell | ||
| $ helm install --name zenko --set ingress.enabled=true --set ingress.hosts[0]=zenko.local --set cloudserver-front.endpoint=zenko.local zenko | ||
| ``` | ||
|
|
||
| See `values.yml` for more options. | ||
| One noteworthy option is to enable integration with the [Orbit] management UI | ||
| (disabled by default) and set a custom Orbit API endpoint (for development |
There was a problem hiding this comment.
Not your fault, but the Orbit management is now enabled by default. Could we swap the wording around? So "option is to disable integration...(enabled by default)"
swarm-production/README.md
Outdated
| @@ -187,6 +188,7 @@ $ aws s3 --endpoint http://zenko ls s3://bucket1 | |||
| ``` | |||
|
|
|||
| ### Clueso Search | |||
There was a problem hiding this comment.
Also not your fault, but can we change this to simply "Metadata Search"
swarm-production/README.md
Outdated
| @@ -187,6 +188,7 @@ $ aws s3 --endpoint http://zenko ls s3://bucket1 | |||
| ``` | |||
|
|
|||
| ### Clueso Search | |||
|
|
|||
| Clueso search can be tested from within the S3-frontend container. | |||
There was a problem hiding this comment.
Same here, change Clueso to "Metadata"
swarm-production/README.md
Outdated
| You can see the Spark Master UI at port 8080 | ||
| Check out the Livy UI at port 8998 | ||
| You can see the Spark Master UI at port 8080. Check out the Livy UI at port | ||
| 8998. |
There was a problem hiding this comment.
We can remove this entire sentence as it is no longer relevant.
|
There were the following issues with this Pull Request
You may need to change the commit messages to comply with the repository contributing guidelines. 🤖 This comment was generated by commitlint[bot]. Please report issues here. Happy coding! |
for swarm-production.
Helm chart README
charts/README.md revised to conform with Salim's comments
To conform with Salim's feedback in: https://github.com/scality/Zenko/pull/123/files/781ce41687a007b3c946fac6b8b503ce40c04a51
Added changes to top README.md & ISSUE_TEMPLATE.md
I made the docs say the same things more clearly with fewer words.