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

Add docs for using keyring in dockerized environments #505

Merged
merged 1 commit into from
Mar 25, 2021

Conversation

sigalsax
Copy link
Contributor

The changes described in this proposal detail how to use the keyring on Linux systems (Ubuntu 18:04). I am requesting this be added to the docs because I spent a long time trying to figure this out and think others can value from this addition. The addition to the docs provides all the necessary prereqs to use keyring in a dockerized environment

@sigalsax sigalsax changed the title Add docs for using keyring in dockerized container Add docs for using keyring in dockerized environments Mar 24, 2021
@jaraco
Copy link
Owner

jaraco commented Mar 24, 2021

Thanks sigalsax for the contrib!

The test failure is likely due to this change. If you follow to a failed build, you can see these errors during the docs check:

<string>:316: (WARNING/2) Title underline too short.

Using Keyring on headless Linux systems in a Docker container
=======================================
<string>:316: (WARNING/2) Title underline too short.

Using Keyring on headless Linux systems in a Docker container
=======================================
<string>:320: (WARNING/2) Inline literal start-string without end-string.
<string>:340: (ERROR/3) Unexpected indentation.
<string>:340: (WARNING/2) Inline literal start-string without end-string.
<string>:340: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

I'd investigate lines 316, 320, and 340 to address the warnings/errors. You can see these errors also by running tox -e docs.

Let me know if you don't feel comfortable addressing these errors and I can help.

Good luck.

@sigalsax
Copy link
Contributor Author

@jaraco repushed and looks like everything passed now (:

@jaraco jaraco merged commit 48991c7 into jaraco:main Mar 25, 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.

2 participants