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:Added documentation of Keyring Feature #2612

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

anj20
Copy link

@anj20 anj20 commented Jan 26, 2025

Purpose of PR?:

Fixes #2421

Does this PR introduce a breaking change?
No

Does this PR results in some Documentation changes?
Yes
Added relevant documentation updates to Test Keyring Features.

Checklist:

@ReimarBauer ReimarBauer requested a review from joernu76 January 27, 2025 08:27
Copy link
Member

@ReimarBauer ReimarBauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see comment

docs/development.rst Outdated Show resolved Hide resolved
@anj20 anj20 requested a review from ReimarBauer January 27, 2025 19:24
Copy link
Member

@ReimarBauer ReimarBauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the description is currently to generic, it should be for a dev looking into this document become faster than looking into the code.

please look into the auth module where it is used and use the default names of the configuration, e.g.
for mscolab it is defined in MSCOLAB_auth_user_name, with "mscolab"

e.g. when auth on the mscolab server is enabled you want to ask. The URL is then the service url.

keyring get MSCOLAB_AUTH_{URL} mscolab

provide the examples based on what we do and need.

look on e.g. our usage of get_password_from_keyring e.g. https://github.com/Open-MSS/MSS/blob/develop/mslib/msui/mscolab.py#L205

all the descriptions done here can be later also retrieved by perplexity.ai or similiar.

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.

document an example for removing a password/key from the keyring
2 participants