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

Adding documentation for the new auth plugin #3846

Merged
merged 13 commits into from
Sep 26, 2024

Conversation

ErniGH
Copy link
Contributor

@ErniGH ErniGH commented Sep 18, 2024

related to: conan-io/conan#16942

@ErniGH ErniGH added this to the 2.8.0 milestone Sep 18, 2024
Copy link
Member

@AbrilRBS AbrilRBS left a comment

Choose a reason for hiding this comment

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

Looks good, minor changes proposed are mostly to make the examples more clear, and a bit fo wording

reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
ErniGH and others added 8 commits September 19, 2024 13:39
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
@czoido
Copy link
Contributor

czoido commented Sep 19, 2024

I think it would be nice to add a link here from places where we talk about servers so that it's more easily discoverable by users. If not it will be difficult that users reach this content.

Copy link
Member

@memsharded memsharded left a comment

Choose a reason for hiding this comment

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

Looking good. I think it would be great to add a subsection or something that explains the resolution order/priority:

  • First the plugins
  • If the plugins return nothing, then the credentials.json
  • If the credentials.json returns nothing, then the env-vars
  • Finally the user interactive prompt or fail if the "non_interactive" config is enabled

This might be a section in other place in the docs that talks about authorization process, but I cannot think at the moment where. If not evident, it can be done here at the moment.

reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/config_files/credentials.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
reference/extensions/authorization_plugins.rst Outdated Show resolved Hide resolved
@czoido czoido requested a review from memsharded September 26, 2024 08:34
@czoido czoido merged commit a0d94c7 into conan-io:develop2 Sep 26, 2024
2 checks passed
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.

4 participants