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

Describe basic auth credentials in documentation #7201

Merged
merged 13 commits into from
Nov 13, 2019
Merged

Describe basic auth credentials in documentation #7201

merged 13 commits into from
Nov 13, 2019

Conversation

aniruddha2000
Copy link
Contributor

No description provided.

docs/html/user_guide.rst Outdated Show resolved Hide resolved
Copy link
Member

@chrahunt chrahunt left a comment

Choose a reason for hiding this comment

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

A few examples would be good too. At least one with some special characters that need to be percent-encoded and one using a single-part login token (like 0123456789abcdef@example.com, representing an auth token).

docs/html/user_guide.rst Outdated Show resolved Hide resolved
news/7201.doc Outdated Show resolved Hide resolved
Copy link
Member

@chrahunt chrahunt left a comment

Choose a reason for hiding this comment

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

In general I think we need to be much more verbose. The purpose is to replace all of the ad-hoc documentation that companies and enterprise repository providers are having to maintain, so it should cover each use case in a way that anyone could understand.

docs/html/user_guide.rst Outdated Show resolved Hide resolved
docs/html/user_guide.rst Outdated Show resolved Hide resolved
docs/html/user_guide.rst Outdated Show resolved Hide resolved
docs/html/user_guide.rst Outdated Show resolved Hide resolved
@pradyunsg
Copy link
Member

pradyunsg commented Nov 1, 2019

Pinging @chrahunt since I think this is awaiting his review.

@chrahunt
Copy link
Member

chrahunt commented Nov 9, 2019

Sorry I forgot about this, I have replied to the two pending comments.

docs/html/user_guide.rst Outdated Show resolved Hide resolved
docs/html/user_guide.rst Outdated Show resolved Hide resolved
Copy link
Member

@chrahunt chrahunt left a comment

Choose a reason for hiding this comment

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

Last comment, otherwise LGTM.

docs/html/user_guide.rst Outdated Show resolved Hide resolved
docs/html/user_guide.rst Outdated Show resolved Hide resolved
Copy link
Member

@chrahunt chrahunt left a comment

Choose a reason for hiding this comment

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

I fixed that last nitpick.

@chrahunt chrahunt merged commit 4c1a7cd into pypa:master Nov 13, 2019
@chrahunt
Copy link
Member

Thanks for sticking with this @aniruddha2000! I think it will help a lot of people. :)

@aniruddha2000
Copy link
Contributor Author

Thanks @chrahunt , @pradyunsg for guiding me in this issue :)

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Dec 13, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Dec 13, 2019
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants