Skip to content

docs: add system architecture diagrams #14241

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

Merged
merged 4 commits into from
Aug 1, 2023
Merged

Conversation

miketheman
Copy link
Member

Not 100% comprehensive, but a good starting point.

Related to #2794

To see generated HTML, run:

make dev-docs && python -m http.server -d docs/dev/_build/html/

and browse to http://localhost:8000/architecture.html

Currently broken, as Sphinx looks to these variables to set the
encoding. Removing them works fine.

Signed-off-by: Mike Fiedler <[email protected]>
Not 100% comprehensive, but a good starting point.

Signed-off-by: Mike Fiedler <[email protected]>
@miketheman miketheman requested a review from a team as a code owner July 31, 2023 16:23
@miketheman miketheman added documentation developer experience Anything that improves the experience for Warehouse devs labels Jul 31, 2023
@di
Copy link
Member

di commented Aug 1, 2023

The docs are also previewed here: https://warehouse--14241.org.readthedocs.build/architecture.html

@di
Copy link
Member

di commented Aug 1, 2023

The only thing missing here I think is that there should probably be a "Redis" component for uploads as well, because this is how we handle rate-limiting for all endpoints, including uploads.

Signed-off-by: Mike Fiedler <[email protected]>
@miketheman
Copy link
Member Author

The only thing missing here I think is that there should probably be a "Redis" component for uploads as well, because this is how we handle rate-limiting for all endpoints, including uploads.

Added!

@di
Copy link
Member

di commented Aug 1, 2023

This looks good, but before we merge this... would it make more sense for this to be added to our docs at https://docs.pypi.org/ instead? I think we'd probably want to migrate it there eventually anyways, and looks like mkdocs supports Mermaid as well: https://squidfunk.github.io/mkdocs-material/reference/diagrams/

@miketheman
Copy link
Member Author

would it make more sense for this to be added to our docs at docs.pypi.org instead?

I considered this, and didn't know the right answer. I thought about how most of the information is relevant to a warehouse developer (and others). The docs.pypi.org site seems more end-user-focused. I'm happy to put it whereever it makes most sense - but this felt more correct to me.

@di
Copy link
Member

di commented Aug 1, 2023

I think that delineation is good enough for me, for now. Thanks!

@di di merged commit 55476f3 into pypi:main Aug 1, 2023
@miketheman miketheman deleted the docs-diagram branch August 1, 2023 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience Anything that improves the experience for Warehouse devs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants