Skip to content
This repository has been archived by the owner on Jul 5, 2021. It is now read-only.

Introduce documentation for each backend implementation #24

Closed
riccardomc opened this issue Jun 3, 2019 · 5 comments
Closed

Introduce documentation for each backend implementation #24

riccardomc opened this issue Jun 3, 2019 · 5 comments

Comments

@riccardomc
Copy link
Contributor

We need a consistent way to specify instructions and parameters documentation for each type of backend. We could restructure the secrets directory to contain a sub-directory for each backend with a README.md in it For example:

pkg/secrets/
  asm/
     asm.go
     asm_test.go
     README.md
  onepassword/
     onepassword.go
     onepassword_test.go
     README.md
...

And the README.md would look like something like:

AWS Secrets Manager Backend

Format

Type: "asm"
Name: "asm-example"
Parameters:
    accessKeyID: ""
    region: ""
    secretAccessKey: ""

Parameters

Parameter Description Required Default
accessKeyID AWS Access Key ID that can talk to AWS Secrets Manager yes ""
region AWS Region yes ""
secretAccessKey AWS Secret Access Key corresponding to accessKeyID yes ""
@riccardomc
Copy link
Contributor Author

@frankscholten @zemanel what do you think?

@zemanel
Copy link

zemanel commented Jun 3, 2019

docs is good! but for such a small proj, my vote is on everything on a single README (easier to search) ?

@riccardomc
Copy link
Contributor Author

ok, I had that doubt as well... let's just use a "Supported Backends" in the main README.md then!

@frankscholten
Copy link
Collaborator

Yes. We can use a Markdown table and add a line for each backend with parameters.

@frankscholten
Copy link
Collaborator

#40

@riccardomc riccardomc added this to the 0.1.0 milestone Jun 14, 2019
amouat pushed a commit that referenced this issue May 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants