search

cyberark / conjur-quickstart

Start securing your secrets and infrastructure by installing Conjur, using Docker and the official Conjur containers on DockerHub.
Apache License 2.0
33 stars 36 forks source link

Add instrux to readme #25

Closed izgeri closed 4 years ago

izgeri commented 4 years ago

What does this PR do?

At current, this repo has an almost blank README that doesn't give much context to what it contains or how we'd recommend that people use it.

In addition, the main flow that will funnel people to this repo comes from the website, and we'd like an easy way to communicate to the web team when changes should be made to the website content.

In this PR, we add a duplicate of the website instructions to the repo README. This will allow:

In addition, it adds the "Community" certification level badge to this repo; users who want a Trusted method of deploying Conjur OSS would be advised to try out our helm chart.

What ticket does this PR close?

n/a

Checklists

Change log

Test coverage

Documentation

izgeri commented 4 years ago

@sashaCher I've marked this as "ready for review" if you're willing to approve it. I want to merge the PR as-is (modulo any discussion around the gitleaks config) because it's currently a mirror of the web "get started" flow.

In a future PR, I'll propose updates to the current flow that we can coordinate to go live in this repo and on the web at the same time. I'd love to include your suggestion changes in that future PR. Thanks!!

sashaCher commented 4 years ago

@izgeri No problem to approve the PR. Just let's clarify the reason why .gitleaks.toml file is there. It looks not related to the PR for me.

izgeri commented 4 years ago

@sashaCher I updated the gitleaks config to specifically reference the 5 older commits that were problematic, which I think is a better approach.