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 documentation on how to disable keyring #8019

Closed
wants to merge 2 commits into from

Conversation

pradyunsg
Copy link
Member

Based off #7200

Closes #7200
Fixes #6773

@pradyunsg pradyunsg added the type: docs Documentation related label Apr 11, 2020
@pradyunsg
Copy link
Member Author

@chrahunt @pfmoore @uranusjr Could one of you take a look at this?

@uranusjr
Copy link
Member

Does keyring have existing documentation on how to disable it? If so, I would structure the section as

  • If you have problems authenticating, try disabling keyring.
  • Suggest keyring --disable.
  • Refer to keyring’s documentation if this is not available.
  • If everything else fails, try uninstalling keyring altogether (with caveats).

I think this would be more helpful to the general audience, while not shouldering too much responsibility to explain things. keyring maintainers are in a better position to troubleshoot anything more complicated than keyring --disable.

@pfmoore
Copy link
Member

pfmoore commented Apr 12, 2020

I'm not particularly comfortable suggesting that the user uninstall keyring - as the PR says, this could break other code. And I don't think we should do the job of documenting keyring1. I'd suggest similar to @uranusjr

  1. If you have problems, you can disable keyring with --disable if you have a sufficiently recent version of keyring.
  2. If you have an old version, consider upgrading to get the --disable option.
  3. If you still have issues, contact the keyring project or consult their documentation. We can add the project's PyPI URL here (there's no real project homepage other than a github page, and no specific docs page, so IMO the PyPI page is the best link).

1 The keyring docs don't seem particularly good in this area - the --disable option isn't even mentioned in the docs as far as I can see.

@pradyunsg
Copy link
Member Author

Sounds reasonable to me!

@pradyunsg pradyunsg closed this Apr 19, 2020
@pradyunsg pradyunsg deleted the pr/7200 branch April 19, 2020 18:20
@lock lock bot added the auto-locked Outdated issues that have been locked by automation label May 20, 2020
@lock lock bot locked as resolved and limited conversation to collaborators May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to disable keyring for users who might want to
4 participants