Updates Docs (wording, typos, formatting) #1753
Conversation
otherwise you'd get something like: ``` error: the server doesn't have a resource type "default-values" ```
and resitutates some line breaking
the author clearly intended this to break onto two lines, but markdown does not respect linebreaks in this context without an addtional line between
|
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 | |||
| ``` | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Maybe let's file a separate issue about this?
| @@ -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 | |||
| ``` | |||
There was a problem hiding this comment.
Maybe let's file a separate issue about this?
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.