-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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
Add homebrew devel and HEAD notes to docs. #3826
Add homebrew devel and HEAD notes to docs. #3826
Conversation
/assign @justinsb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some questions
docs/update_kops.md
Outdated
@@ -2,12 +2,19 @@ | |||
|
|||
Update the latest source code from kubernetes/kops | |||
|
|||
``` | |||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not on you, but I do not like this document much. We have had issues with a lot of people installing from source in the past. Wondering if we should refer them just include the base install instructions here that are in the README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or just add notes that we just replace the binary to update kops in the install doc, and link to that document in this doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay that makes sense. I'll rework this pending the above comments ^. We probably should just refer them to docs/development for the git pull && make
version.
docs/install.md
Outdated
@@ -8,6 +8,15 @@ From Homebrew: | |||
brew update && brew install kops | |||
``` | |||
|
|||
Development Releases and master can also be installed via Homebrew: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we just add a link for developers to the compile and homebrew instructions? I would like it to be another click for a developer to install, and not have people installing HEAD, unless they know they are now a developer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chrislovecnm That's a good idea, I'll move this to a docs/development/install.md and link?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or I can add it in docs/development/building.md as an "easier" way to build and install?
16fa56d
to
ef30f0e
Compare
@chrislovecnm Let me know if this is more what you had in mind. Thanks! |
/lgtm Thanks @mikesplain ! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: justinsb The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these OWNERS Files:
You can indicate your approval by writing |
Automatic merge from submit-queue. |
Added to brew in Homebrew/homebrew-core#20464