Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Helm Chart #5350

Merged
merged 3 commits into from
Feb 21, 2019
Merged

[Docs] Helm Chart #5350

merged 3 commits into from
Feb 21, 2019

Conversation

kaitlincart
Copy link
Contributor

  • Updated the Helm chart to include ACL parameter
  • Added examples of the Helm Chart.
  • Updated the formatting for readability.

@kaitlincart kaitlincart added the type/docs Documentation needs to be created/updated/clarified label Feb 14, 2019
@kaitlincart kaitlincart requested review from tradel, adilyse and a team February 14, 2019 20:39
Copy link
Contributor

@adilyse adilyse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple things:

Elsewhere in the docs, we split long lines with hard returns. This makes it easier to comment on them during review and doesn't affect how they appear when rendered. (Github only allows a single comment on a line, so a line that is really a paragraph means that I have to put all discussion in a single giant comment if there are several things to talk about.) Adding these line breaks here would be helpful. Or at least putting a hard return after every . to break up the paragraphs as a compromise, as managing hard line wraps is annoying.

There are a few typos in a couple of the sections. I'm assuming that you didn't change most of the descriptions-- I'll probably need to take another look if that's the case.

We'll want to double check that the formatting is clear once the top level items are no longer bullet points. I think there are some good examples elsewhere in the docs.

website/source/docs/platform/k8s/helm.html.md Show resolved Hide resolved
website/source/docs/platform/k8s/helm.html.md Outdated Show resolved Hide resolved
website/source/docs/platform/k8s/helm.html.md Outdated Show resolved Hide resolved
website/source/docs/platform/k8s/helm.html.md Outdated Show resolved Hide resolved
Copy link
Contributor

@adilyse adilyse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor suggestion in the final section to avoid a comma splice, but otherwise it looks good.

Unfortunately, it looks like the wrap width setting you are using doesn't insert a hard return. We may need to resort to sentence breaks at some point, but it's not worth holding this up with for now.

website/source/docs/platform/k8s/helm.html.md Outdated Show resolved Hide resolved
Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>
@kaitlincart kaitlincart merged commit 193c0b7 into master Feb 21, 2019
@kaitlincart kaitlincart deleted the docs/helm-chart-examples branch February 21, 2019 00:27
kaitlincart added a commit that referenced this pull request Feb 21, 2019
* Updating the Helm chart to include ACL parameter and examples.

* Updates based on feedback.

* Update website/source/docs/platform/k8s/helm.html.md

Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants