Update building documentation for macOS #4850
Conversation
BUILDING.md
Outdated
|
|
||
| The source code for Kubernetes is in `vendor/` and the location from which that is copied | ||
| is in `./go.mod`. Go to the referenced repo/tag and you'll find all the patches applied | ||
| is in [go.mod](go.mod). Go to the referenced repo/tag and you'll find all the patches applied |
There was a problem hiding this comment.
Since the vendor/ directory has been removed, I don't think this is accurate anymore. What should we say instead?
| ```bash | ||
| SKIP_VALIDATE=true make | ||
| ``` | ||
|
|
||
| If you make any changes to go.mod and want to update the vendored modules, you should run the following before running `make`: | ||
| In case you make any changes to [go.mod](go.mod), you should run `go mod tidy` before running `make`. |
There was a problem hiding this comment.
We can run make deps here.
There was a problem hiding this comment.
Sure, I can make that change. But make deps internally does go mod vendor, and I was under the impression that we are stirring away from vendor/ directory. So, should I remove go mod vendor from the Makefile or add vendor/ to the .gitignore?
There was a problem hiding this comment.
Let's get @luthermonson to weigh-in here.
There was a problem hiding this comment.
We should remove the make deps from the Makefile entirely, we do not want to go mod vendor anymore, and then the command is just a wrapper for go mod tidy
There was a problem hiding this comment.
I agree with @dereknola, however updating the Makefile or .gitignore might be outside of this PR scope, and the documentation is still correct if we omit to use that make target.
Either way, I'm open to do what the team sees proper.
BUILDING.md
Outdated
| ## Build k3s from source | ||
|
|
||
| Before getting started, bear in mind that this repository includes all of | ||
| Kubernetes history, so consider shallow clone it (`--depth 1`) to speed up the |
There was a problem hiding this comment.
| Kubernetes history, so consider shallow clone it (`--depth 1`) to speed up the | |
| Kubernetes history, so consider shallow cloning with (`--depth 1`) to speed up the |
BUILDING.md
Outdated
| on GNU utils (i.e., `sed`), | ||
| [which slightly differ on macOS](https://unix.stackexchange.com/a/79357). So, if | ||
| you need to build k3s on a macOS environment, it is suggested to use the virtual | ||
| machine defined on this repository [Vagrantfile](Vagrantfile) to perform the |
There was a problem hiding this comment.
| machine defined on this repository [Vagrantfile](Vagrantfile) to perform the | |
| machine defined on this repository's [Vagrantfile](Vagrantfile) to perform the |
|
Is there any reason why we're manually handling line breaks and not letting Markdown perform the line wrapping for us? |
My IDE does it for me, it is to maintain the MD documents with a 80 characters long margin. I can re-join them if we prefer the other way. PS: No manual labor I promise. |
Yeah, let's let the browser handle that otherwise, for consistency's sake, we all then need that ide setting. |
jossemargt-3pillar
force-pushed
the
documenation/update-building-docs
branch
from
d17c112
to
dfd5a6c
Compare
Problem: The k3s build scripts rely on GNU utils, like sed, so when these scripts are run on a macOS environment they don't work as expected. Solution: Update the documentation to point out this scenario and suggest the reader to spin up the Linux virtual machine defined on the Vagrantfile within this project. Signed-off-by: Jonnatan Jossemar Cordero <jonnatan.cordero@suse.com>
Signed-off-by: Jonnatan Jossemar Cordero <jonnatan.cordero@suse.com>
jossemargt-3pillar
force-pushed
the
documenation/update-building-docs
branch
from
dfd5a6c
to
a22f580
Compare
Update building documentation for macOS Problem: The k3s build scripts rely on GNU utils, like sed, so when these scripts are run on a macOS environment they don't work as expected. Solution: Update the documentation to point out this scenario and suggest the reader to spin up the Linux virtual machine defined on the Vagrantfile within this project. Signed-off-by: Jonnatan Jossemar Cordero <jonnatan.cordero@suse.com> Signed-off-by: Roberto Bonafiglia <roberto.bonafiglia@gmail.com>
Signed-off-by: Jonnatan Jossemar Cordero jonnatan.cordero@suse.com
Proposed Changes
The k3s build scripts rely on GNU utils, like sed, so when these scripts are run on a macOS environment they don't work as expected.
Update the documentation to point out this scenario and suggest the reader to spin up the Linux virtual machine defined on the Vagrantfile within this project.
Types of Changes
Documentation
Verification
Linked Issues
User-Facing Change
Further Comments