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

Updates Docs (wording, typos, formatting) #1753

Merged
merged 22 commits into from Feb 21, 2019

Conversation

Projects
None yet
4 participants
@dimitropoulos
Copy link
Contributor

dimitropoulos commented Feb 20, 2019

I did a thorough once-over on all of the documentation I could find and made a few minor changes I saw along the way. I made the changes in atomic commits so that (A) the rationale for the individual change is always clear and (B) individual changes can easily be rejected.

dimitropoulos added some commits Feb 19, 2019

typo: adds resource to kubectl get command
otherwise you'd get something like:
```
error: the server doesn't have a resource type "default-values"
```
updates markdown formatting
the author clearly intended this to break onto two lines, but markdown does not respect linebreaks in this context without an addtional line between

@dimitropoulos dimitropoulos requested a review from dholbach Feb 20, 2019

@2opremio

This comment has been minimized.

Copy link
Collaborator

2opremio commented Feb 20, 2019

This is awesome, thanks!

@@ -188,13 +176,24 @@ Using an SSH key allows you to maintain control of the repository. You
can revoke permission for `flux` to access the repository at any time
by removing the deploy key.

```sh
```

This comment has been minimized.

Copy link
@hiddeco

hiddeco Feb 20, 2019

Member

I think we may need to rethink about including this output in the docs (or automate it?) as it is likely to change over time.

This comment has been minimized.

Copy link
@dimitropoulos

dimitropoulos Feb 20, 2019

Author Contributor

I was thinking the same thing. In the past I have used https://github.com/danger/danger which basically would allow us to write code that enforces that when the help text changes that the documentation will/should also change. That's the best option I know of (and, there are ways in which it isn't great) that meets the minimum requirement of curbing some of that stuff getting out of date.

Another option would be to just have a quarterly health-and-wellness checkup list that would include updating documentation of this sort. Just an idea.

This comment has been minimized.

Copy link
@dholbach

dholbach Feb 21, 2019

Contributor

Maybe let's file a separate issue about this?

@dholbach
Copy link
Contributor

dholbach left a comment

Great work @dimitropoulos! Thanks for the docs review!

@@ -188,13 +176,24 @@ Using an SSH key allows you to maintain control of the repository. You
can revoke permission for `flux` to access the repository at any time
by removing the deploy key.

```sh
```

This comment has been minimized.

Copy link
@dholbach

dholbach Feb 21, 2019

Contributor

Maybe let's file a separate issue about this?

@dholbach dholbach added the docs label Feb 21, 2019

@dimitropoulos dimitropoulos merged commit c2dfbf5 into weaveworks:master Feb 21, 2019

1 check passed

ci/circleci: build Your tests passed on CircleCI!
Details

@dimitropoulos dimitropoulos deleted the dimitropoulos:updates-docs branch Feb 21, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.