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 architecture overview. #6637

Merged
merged 11 commits into from Aug 22, 2019

Conversation

@brainwane
Copy link
Member

brainwane commented Jun 23, 2019

Work in progress to add an architecture overview to pip, based on the notes @pradyunsg and I took at PyCon North America 2019, similar to Warehouse's overview.

@brainwane

This comment has been minimized.

Copy link
Member Author

brainwane commented Jun 23, 2019

Thanks to @ppiyakk2 and @dwighthubbard for questions and feedback!

I lightly edited the rough notes we took in May but am happy to have others rearrange, rewrite, etc.

@brainwane brainwane force-pushed the brainwane:architecture branch 2 times, most recently Jul 21, 2019
@brainwane brainwane force-pushed the brainwane:architecture branch Aug 1, 2019
@brainwane brainwane force-pushed the brainwane:architecture branch Aug 6, 2019
@pradyunsg

This comment has been minimized.

Copy link
Member

pradyunsg commented Aug 6, 2019

@brainwane Thank you so much for continuing to work on this! :D

We finally filed #6831 for tracking this.

I was thinking we can split this out into sub-pages that get fleshed out individually. For that, I made #6836 for adding the sub-section to add pages to. Having a sub-section allows us to have dedicated pages for both kinds of content easily:

  • deep-dive into certain parts discussing edge cases and relevant standards/trade-offs (like say the downloading and index interaction logic)
  • overview-style content (like the repo structure, or walkthrough an install).
@brainwane brainwane force-pushed the brainwane:architecture branch Aug 6, 2019
@brainwane

This comment has been minimized.

Copy link
Member Author

brainwane commented Aug 6, 2019

Thanks for the guidance and the new subsection. I rebased on that and turned what I'd written into some subpages for architecture/. I'll polish those a bit more and then mark this as ready for review and merging.

@pradyunsg

This comment has been minimized.

Copy link
Member

pradyunsg commented Aug 10, 2019

Sounds great! Thanks @brainwane! :D

@brainwane brainwane force-pushed the brainwane:architecture branch to 9b0383e Aug 13, 2019
@brainwane

This comment has been minimized.

Copy link
Member Author

brainwane commented Aug 22, 2019

I'm sorry but I do not have time to finish this. @cjerdonek is it possible for you to take over?

@pradyunsg

This comment has been minimized.

Copy link
Member

pradyunsg commented Aug 22, 2019

If no one has time, I'm happy to add a WIP note to the contents of these documents, and merge this PR as is. We can come around to improving this at a later date, and something is better than nothing.

@brainwane brainwane changed the title [WIP] Add architecture overview. Add architecture overview. Aug 22, 2019
@brainwane

This comment has been minimized.

Copy link
Member Author

brainwane commented Aug 22, 2019

I've added the WIP note to the document contents, so go ahead and ship it.

@pradyunsg

This comment has been minimized.

Copy link
Member

pradyunsg commented Aug 22, 2019

Perfect! :)

@pradyunsg pradyunsg merged commit d23ecf0 into pypa:master Aug 22, 2019
22 checks passed
22 checks passed
Linux Build #20190822.6 succeeded
Details
Linux (Package) Package succeeded
Details
Linux (Test Primary Python27) Test Primary Python27 succeeded
Details
Linux (Test Primary Python36) Test Primary Python36 succeeded
Details
Linux (Test Secondary Python35) Test Secondary Python35 succeeded
Details
Linux (Test Secondary Python37) Test Secondary Python37 succeeded
Details
Windows Build #20190822.6 succeeded
Details
Windows (Package) Package succeeded
Details
Windows (Test Primary Python27-x86) Test Primary Python27-x86 succeeded
Details
Windows (Test Primary Python37-x64) Test Primary Python37-x64 succeeded
Details
Windows (Test Secondary Python35-x86) Test Secondary Python35-x86 succeeded
Details
Windows (Test Secondary Python36-x86) Test Secondary Python36-x86 succeeded
Details
Windows (Test Secondary Python37-x86) Test Secondary Python37-x86 succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
macOS Build #20190822.6 succeeded
Details
macOS (Package) Package succeeded
Details
macOS (Test Primary Python27) Test Primary Python27 succeeded
Details
macOS (Test Primary Python36) Test Primary Python36 succeeded
Details
macOS (Test Secondary Python35) Test Secondary Python35 succeeded
Details
macOS (Test Secondary Python37) Test Secondary Python37 succeeded
Details
news-file/pr News files updated and/or change is trivial.
Details
@pradyunsg

This comment has been minimized.

Copy link
Member

pradyunsg commented Aug 22, 2019

Thanks for all of your work on this @brainwane! ^>^

@brainwane brainwane deleted the brainwane:architecture branch Aug 22, 2019
@lock lock bot added the S: auto-locked label Sep 21, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Sep 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
2 participants
You can’t perform that action at this time.