Updated instructions to fetch Kunlun. Updated spelling and general wo… #45
Conversation
SorraTheOrc
left a comment
SorraTheOrc
left a comment
There was a problem hiding this comment.
Minor comment, please make the change suggested is appropriate. Go ahead an merge as you see fit.
| mkdir kunlun-test | ||
| cd kunlun-test | ||
| go get github.com/kunlun/kun-lun | ||
| cd go/src/github.com/kun-lun/kunlun/cmd/kl |
There was a problem hiding this comment.
Doesn't this depend on where $GOHOME is? that is there is no guarantee that it will be in the current directory. Should it be cd $GOHOME...?
There was a problem hiding this comment.
I left out the $GOHOME business as it's one more setting to keep track of or set. What I was wondering was if it makes sense to create a $KUNLUN_HOME and pushd the working directory for the kunlun (kl) binary/tool. I'll share that with Thomas/team.
There was a problem hiding this comment.
The key is that the commands in the README should work every time. Without fail. I have a tool that will actually run the commands as a test, but it will only work if they are 100% accurate steps.
GOHOME has to be set as part of the GO install. The user need not manage it as part of managing Kunlun, so once it is done, it is done.
I'm not following your suggestion re KUNLUN_HOM, but I would observe that IS an additional environment variable.
There was a problem hiding this comment.
My thinking was that once the user installs Kunlun, they really have no need for go. Or GO_HOME. They need to be in the Kunlun working directory. Which is where KUNLUN_HOME came from. We don't need another environmental variable as long we make it easy to find the working directory ($HOME/go/src/github.com/kun-lun/kunlun/cmd/kl or $GO_HOME/...) both look clunky.
There was a problem hiding this comment.
I don't think it is true to say they need to be in Kunlun home. In fact, why are you changing to the directory at all? After the kl tool is installed you can run kl from anywhere. Indeed, since the tool outputs data into your current directory you should be running it from your project directory.
This is what the original documentation did. These two lines should not be added. They duplicate the instructions in an earlier section (Installing Kunlun from source).
I believe that if you follow those install steps the instructions work in their original format and all that should be left in this PR is the grammar/spelling changes.
There was a problem hiding this comment.
One more quick observation... as written this commands use the old kun-kun GitHub org.
2 participants
Added instructions to mention az cli and how to fetch kunlun tool using go. Updated spelling and general language.