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
Merged

Add architecture overview. #6637

merged 11 commits into from Aug 22, 2019

Conversation

brainwane
Copy link
Member

@brainwane 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
Copy link
Member Author

@brainwane 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.

@pradyunsg
Copy link
Member

@pradyunsg 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
Copy link
Member Author

@brainwane 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
Copy link
Member

@pradyunsg pradyunsg commented Aug 10, 2019

Sounds great! Thanks @brainwane! :D

@brainwane
Copy link
Member Author

@brainwane 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
Copy link
Member

@pradyunsg 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
Copy link
Member Author

@brainwane brainwane commented Aug 22, 2019

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

@pradyunsg
Copy link
Member

@pradyunsg pradyunsg commented Aug 22, 2019

Perfect! :)

@pradyunsg pradyunsg merged commit d23ecf0 into pypa:master Aug 22, 2019
22 checks passed
@pradyunsg
Copy link
Member

@pradyunsg pradyunsg commented Aug 22, 2019

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

@brainwane brainwane deleted the architecture branch Aug 22, 2019
@lock lock bot added the 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.
Labels
auto-locked type: docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants