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

Improve the secrets file docs #435

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

spkane
Copy link

@spkane spkane commented Dec 30, 2020

Adding some more thorough examples since the documentation is sparse here and in the upstream library. I basically had to write a test application and read some various docs about the .env format to figure the logic out.

@ashwilliams1 ashwilliams1 marked this pull request as draft December 31, 2020 00:09
@spkane spkane marked this pull request as ready for review January 4, 2021 22:30
@spkane spkane marked this pull request as draft January 4, 2021 22:31
@spkane
Copy link
Author

spkane commented Jan 4, 2021

@ashwilliams1 Is there someone specific who can review this? I don't believe it needs any updating unless someone wants to simply ensure that it is correct.

@bradrydzewski
Copy link
Member

bradrydzewski commented Jan 4, 2021

we would probably want to document the env file format in a separate, dedicated page, and then link to that page from the quick start. The env file is used in multiple places (not just the drone exec) so having a separate reference document would be preferred. This also keeps are quick starts high level.

@spkane
Copy link
Author

spkane commented Jan 5, 2021

That makes sense. I'll leave you all to it then. I just hope that something gets merged in soon-ish, as this took some time to track down and needing to pass in something like an SSH key is a standard enough use case that this should help others avoid the difficulty of figuring this out themselves or just giving up.

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.

2 participants