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 topic guide: VCS Support #10099

Merged
merged 4 commits into from
Jul 12, 2021
Merged

Add topic guide: VCS Support #10099

merged 4 commits into from
Jul 12, 2021

Conversation

pradyunsg
Copy link
Member

Toward #9475.

@pradyunsg pradyunsg added skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related labels Jun 25, 2021
docs/html/topics/configuration.md Show resolved Hide resolved
Comment on lines +25 to +29
```{warning}
The use of `git`, `git+git`, and `git+http` schemes is discouraged.
The former two use [the Git Protocol], which lacks authentication, and HTTP is
insecure due to lack of TLS based encryption.
```
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we should just mention git+file, git+https, and git+ssh in the opening paragraph, and add a “oh btw we also recognise these other three but they are bad anyway” note here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe. Let's defer this for a follow up PR though, since one of the things I like about the way it's currently written is that all the sections have the exact same start that lists all the things.

docs/html/topics/vcs-support.md Outdated Show resolved Hide resolved
docs/html/topics/vcs-support.md Outdated Show resolved Hide resolved
@pradyunsg pradyunsg merged commit 1545996 into pypa:main Jul 12, 2021
@pradyunsg pradyunsg deleted the topic/vcs-support branch July 12, 2021 06:55
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants