Doc: update development instructions #84
Merged
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
|
Will rebase this on #82 as soon as it gets merged |
dpordomingo
approved these changes
Dec 12, 2017
README.md
Outdated
| @@ -37,9 +45,9 @@ To run it locally you can run: | |||
| ```sh | |||
| make serve | |||
| ``` | |||
| (Do it every time you modify something in the sources to re-generate the `server/asset/asset.go` file, the dashboard api, and to serve the updated dashboard itself) | |||
| It will take care of re-generateing the assets file, building dashboard api, and to serving the updated dashboard itself. | |||
There was a problem hiding this comment.
This command is useful if you want to locally launch the dashboard
This command is not appropriate to develop in the dashboard because it is needed to stop and re-run it again everytime you modify whatever.
README.md
Outdated
| docker run -p 8080:80 --link bblfsh bblfsh/dashboard -bblfsh-addr bblfsh:9432 | ||
| ``` | ||
|
|
||
| Please read the [getting started](https://doc.bblf.sh/user/getting-started.html) guide, to learn more about how to use and deploy a bblfsh server. | ||
| Please read the [getting started](https://doc.bblf.sh/user/getting-started.html) guide, to learn more about how to use and deploy a bblfsh server, install drivers, etc. | ||
|
|
||
| If don't want to run **dashboard** using our *Docker* image you can download a binary from [releases](https://github.com/bblfsh/dashboard/releases) page. |
There was a problem hiding this comment.
If you do so, you will also need a bblfsh/bblfsdh running
There was a problem hiding this comment.
Sorry, I'm a bit confused - do you mean that a notice about bblfshd needs to be added to the last sentence, about binary releases?
|
@bzz you added some useful info with this PR. Could you rebase over |
bzz
force-pushed
the
patch-1
branch
2 times, most recently
from
510687d to
5b5c8a5
Compare
Signed-off-by: Alexander Bezzubov <[email protected]>
|
@dpordomingo sorry for delay. Done. |
|
@dpordomingo friendly ping |
dpordomingo
approved these changes
Apr 3, 2018
|
Merged, thanks for pinging |
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.
Minor drive-by update of the README to avoid confusing first-time users/developers giving it a try.
It also documents minimum requirements.