Documenting make local
#2587
Open
Documenting make local
#2587
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arthurcgc
requested changes
Oct 25, 2022
There was a problem hiding this comment.
Even for just make local there are steps missing for a fully fledged tsuru installation...
Thinking about it now, it's my fault for not specifying it well enough what the issue was.
What I personally think would be a fully fledged addition is:
- Document the prerequisites to run
make local(you did that) - Run
make local(explain whatmake localactually did: it boots up a kubernetes cluster ready for tsuru) - This is the most important part of the documentation in my eyes and it's the part that I think I wasn't clear in my issue : document the steps needed to add the recently created cluster to tsuru. These steps are partially documented here, they are a little bit outdated though and could use some cleanup
I apologize for the incompleteness of my Issue specification @pratik1424, you think you could add these changes?
|
|
||
| Prequisites | ||
| --------------------- | ||
| * minikube and kubectl. if you don't have it yet, you can install it `here <https://minikube.sigs.k8s.io/docs/start/>`_, with minikube and `kubectl <https://kubernetes.io/docs/tasks/tools/>`_ properly installed, you are good to go. |
There was a problem hiding this comment.
I don't think kubectl is required although it could be recommended in case of any troubleshooting needs...
There was a problem hiding this comment.
I get it now, I will work on it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have documented the steps required for installing Tsuru using
make localin linux.I have tried to account for small obstacles and workarounds encountered while running the makefile.
It partially fixes #2575, as macOS users may face some different errors while documenting, hope it helps!