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.

Sign up for GitHub

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

Jump to bottom

Document update: README.md #133

Merged
merged 4 commits into from
Mar 13, 2019
Merged

Document update: README.md #133

merged 4 commits into from
Mar 13, 2019

Conversation

Aparnarr
Copy link
Contributor

@Aparnarr Aparnarr commented Mar 11, 2019 •
edited
Loading

Updated the readme.md

  1. Changed the tag from 0.3.2 to 0.4.0 in the YAML template (pravega.yaml) in the section Deploy a sample pravega cluster.
  2. Added the badges for license, godoc, travis-ci, go-report to the README.md.

@Aparnarr
Issue 132: Badges added to readme.md
5bd27e3 
Signed-off-by: Aparna <Aparna.Rr@emc.com>
@Aparnarr
Issue 132: Badges added to readme.md
fbab1ef 
Signed-off-by: Aparna <Aparna.Rr@emc.com>
@Aparnarr
Copy link
Contributor Author

@adrianmo godoc not rendering the correct path....please check

adrianmo
adrianmo suggested changes Mar 11, 2019
View reviewed changes
Copy link
Contributor

@adrianmo adrianmo left a comment

Choose a reason for hiding this comment

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

I have added the project packages to godoc.

README.md Outdated
@@ -1,4 +1,4 @@
# Pravega Operator
# Pravega Operator [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GoDoc](https://godoc.org/github.com/pravega/pravega-operator?status.svg)](https://godoc.org/github.com/pravega/pravega-operator) [![Build Status](https://travis-ci.org/pravega/pravega-operator.svg?branch=master)](https://travis-ci.org/pravega/pravega-operator) [![Go Report](https://goreportcard.com/badge/github.com/pravega/pravega-operator)](https://goreportcard.com/report/github.com/pravega/pravega-operator)
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you move each badge to a separate line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure

@Aparnarr
Issue 132:Updated README.md
8dc3fdc 
Signed-off-by: Aparna <Aparna.Rr@emc.com>
@Aparnarr
Issue 132:Updated README.md
adec046 
Signed-off-by: Aparna <Aparna.Rr@emc.com>
@Aparnarr Aparnarr changed the title Document update: readme doc Document update: README.md Mar 12, 2019
adrianmo
adrianmo approved these changes Mar 13, 2019
View reviewed changes
Copy link
Contributor

@adrianmo adrianmo left a comment

Choose a reason for hiding this comment

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

LGTM

@adrianmo adrianmo merged commit cde7e94 into pravega:master Mar 13, 2019
adrianmo added a commit that referenced this pull request Mar 20, 2019
@adrianmo
Merge branch 'master' into issue-134-add-index-volume
3a09e4d 
* master:
  Run tests on GKE (#140)
  Document update: README.md (#133)
  Add service account role definitions [skip ci] (#136)
This was referenced Mar 20, 2019
Closed
Closed
adrianmo added a commit that referenced this pull request Mar 29, 2019
@adrianmo
Merge branch 'master' into issue-81-upgrade-feature
f375f29 
* master:
  Issue 130: Ability to specify container resources (#129)
  Issue 134,137: Fix BookKeeper errors (#135)
  Run tests on GKE (#140)
  Document update: README.md (#133)
  Add service account role definitions [skip ci] (#136)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adrianmo adrianmo adrianmo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Aparnarr @adrianmo