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

docs: improve Secret Management section #7936

Closed
anakin87 opened this issue Jun 26, 2024 · 6 comments
Closed

docs: improve Secret Management section #7936

anakin87 opened this issue Jun 26, 2024 · 6 comments
Assignees
Labels
type:documentation Improvements on the docs

Comments

@anakin87
Copy link
Member

I have noticed on some online examples that some users struggle to understand how our Secret Management works.
#1 #2

I think that our docs should begin with one of two simple practical usage examples (useful for ordinary users), before going deep into explaining the implementation.

@anakin87 anakin87 added the type:documentation Improvements on the docs label Jun 26, 2024
@srini047
Copy link

@anakin87 I would like to take up this issue.
A pipeline similar to this: https://github.com/LLM-Projects/haystack-book/blob/main/chapter-4/haystack_monitoring_prompt_injection.ipynb.

@anakin87
Copy link
Member Author

@srini047 it is unrelated, sorry.

I simply mean showing an example like this:

works, but not serializable
generator = OpenAIGenerator(api_key=Secret.from_token("<your-api-key>"))

serializable, preferred way

# export an env var called OPENAI_API_KEY containing the API key
generator = OpenAIGenerator() #using the default env var for the component

serializable, with a custom env var

# export an env var called YOUR_ENV_VAR containing the API key
generator = OpenAIGenerator(api_key=Secret.from_env("YOUR_ENV_VAR"))

@srini047
Copy link

I actually thought an example as a pipeline. I can implement this and looks much simpler.

@srini047
Copy link

srini047 commented Jul 2, 2024

@anakin87 Suggested the changes through dash.readme.com.
Looking forward to take it from there.

@anakin87
Copy link
Member Author

anakin87 commented Jul 3, 2024

@dfokina please have a look when you can.

@dfokina
Copy link
Contributor

dfokina commented Jul 3, 2024

Thank you @srini047 ! I just tweaked the text a little bit, and just published the suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

3 participants