-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Conversation
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]>
The docs are also previewed here: https://warehouse--14241.org.readthedocs.build/architecture.html |
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]>
Added! |
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/ |
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. |
I think that delineation is good enough for me, for now. Thanks! |
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