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

Minor readme tweaks #46

Merged
merged 8 commits into from Feb 4, 2021
Merged

Minor readme tweaks #46

merged 8 commits into from Feb 4, 2021

Conversation

tico24
Copy link
Contributor

@tico24 tico24 commented Feb 4, 2021

Description

I hit a few issues and inconsistencies with the readme when trying to get this set up, so here are some tweaks to hopefully clarify things for future users

Checklist

Please make sure that your PR fulfills the following requirements:

  • Reviewed the guidelines for contributing to this repository
  • The commit message follows the Conventional Commits Guidelines.
  • [n/a] Tests for the changes have been
  • Docs have been added / updated

Type of Change

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • New tests
  • Build/CI related changes
  • Documentation content changes
  • Other (please describe)

Other information

The readme assumes that the value in vault is a base64-encoded string, but most importantly doesn't actually say that anywhere. Using StringData instead of data allows the user to have a non-encoded string and this will still work.
@codecov
Copy link

codecov bot commented Feb 4, 2021

Codecov Report

Merging #46 (6182f59) into main (249c342) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #46   +/-   ##
=======================================
  Coverage   42.92%   42.92%           
=======================================
  Files          13       13           
  Lines         403      403           
=======================================
  Hits          173      173           
  Misses        208      208           
  Partials       22       22           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 249c342...1a3c360. Read the comment docs.

Copy link
Member

@werne2j werne2j left a comment

Choose a reason for hiding this comment

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

Other than one small comment, looks good!

README.md Outdated Show resolved Hide resolved
Copy link
Member

@werne2j werne2j left a comment

Choose a reason for hiding this comment

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

Looks great!

@werne2j werne2j merged commit 05a4a89 into argoproj-labs:main Feb 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants