Minor docs overhaul: wording, grammar, formatting #709
Conversation
meichstedt
requested review from
alenkacz,
fabianbaier,
gerred,
guenter,
kensipe and
runyontr
as code owners
|
/approve |
meichstedt
changed the title
This commit is almost pure 'Haarspalterei', but it's worth it.
meichstedt
force-pushed
the
me/docs-pass-1
branch
from
cb431ce
to
85d64c4
Compare
| @@ -64,7 +64,7 @@ What are the control mechanisms? CRDs allow for RBAC control at a namespace lev | |||
|
|
|||
| ## Discoverable Repo for Applications | |||
|
|
|||
| It should be easy to convert a Helm chart into a OperatorVersion since we can just "render" the chart. Additionally we plan to build the Universe Shim to accept any DC/OS operator. Thus we should be able to pull from either of these public repos of apps (and any internally hosted app site) | |||
| It should be easy to convert a Helm chart into an OperatorVersion since we can just "render" the chart. Additionally we plan to build the Universe Shim to accept any DC/OS operator. Thus we should be able to pull from either of these public repos of apps (and any internally hosted app site) | |||
There was a problem hiding this comment.
Uhh, we REALLY should revise this whole page, it feels very ancient... to be honest I don't even fully understand this paragraph.
But not your issue :) your edit is good :)
|
|
||
| ### Notes on Minikube | ||
| ## Install KUDO into your cluster |
There was a problem hiding this comment.
I actually preferred the order as it was before, I think we really want to highlight how to install kudo into the cluster on that page, minikube to be is kind of secondary.
There was a problem hiding this comment.
I see, I pushed a different approach where I just link to the Minikube section. The initial version was pretty confusing from a structural standpoint IMO: Notes on Minikube was a sub-section of Install KUDO into your cluster:
Pre-requisites
- Install a cluster e.g. Minikube
Install KUDO into your cluster
...
Notes on Minikube
sorry but you should have installed minikube with 10G instead of 2G, duh.
I think Notes on Minikube should either be a sub-section to Pre-requisites (because its installation is mentioned there), or a section on its own (which it is now in this PR). It should definitely not be listed where it was before.
Let me know what you think.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alenkacz, jbarrick-mesosphere, meichstedt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR addresses some inconsistencies
Which issue(s) this PR fixes:
n/a
Special notes for your reviewer:
It's not a big change, it's mostly grammar :)
Does this PR introduce a user-facing change?: