Skip to content
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

fix(README): Change instructions for installing badger in README.md #1495

Merged
merged 5 commits into from
Sep 7, 2020

Conversation

vmrajas
Copy link
Contributor

@vmrajas vmrajas commented Sep 1, 2020

It was found out that the current go get instruction to install badger was not working properly.
This PR changes the installation instruction.

Related Discuss issue: https://discuss.dgraph.io/t/how-to-use-cli-badger-tool/9729


This change is Reviewable

@CLAassistant
Copy link

CLAassistant commented Sep 1, 2020

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@jarifibrahim jarifibrahim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the same change in the docs/ directory as well so that it reflects on https://dgraph.io/docs/badger/get-started/#installing page.

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @ashish-goswami, @jarifibrahim, @manishrjain, and @vmrajas)


README.md, line 69 at r1 (raw file):

## Getting Started

### Installing v2.0.0

Why do we want users to install this specific version? The latest release is v2.2007.1 and go get would fetch it by default.

Copy link
Contributor Author

@vmrajas vmrajas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 3 files reviewed, 1 unresolved discussion (waiting on @ashish-goswami, @jarifibrahim, and @manishrjain)


README.md, line 69 at r1 (raw file):

Previously, jarifibrahim (Ibrahim Jarif) wrote…

Why do we want users to install this specific version? The latest release is v2.2007.1 and go get would fetch it by default.

Done.

Copy link
Contributor

@jarifibrahim jarifibrahim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. I've got one comment.
I see that the image on https://dgraph.io/docs/badger is missing. @vmrajas if you can fix it in this PR, that would be great.

docs/content/get-started/index.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@vmrajas vmrajas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 4 files reviewed, 2 unresolved discussions (waiting on @ashish-goswami, @jarifibrahim, and @manishrjain)


docs/content/get-started/index.md, line 8 at r2 (raw file):

Previously, jarifibrahim (Ibrahim Jarif) wrote…
To start using Badger, install Go 1.12 or above. Badger v2 needs go modules. Run the following command to retrieve the library.

Done.

@vmrajas vmrajas merged commit 5eb48e4 into master Sep 7, 2020
@vmrajas vmrajas deleted the rajas/fix_readme branch September 7, 2020 12:24
jarifibrahim pushed a commit that referenced this pull request Oct 2, 2020
…1495)

* Fix Readme Installation instructions

* Fix linking

* Address comments

* Move README.md content to Badger docs

* Suggested changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants