8000 docs: enhance sponsorship uc documentation by berinhard · Pull Request #1928 · python/pythondotorg · GitHub
[go: up one dir, main page]
Skip to content

docs: enhance sponsorship uc documentation #1928

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: enhance sponsorship uc documentation #1928

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
29d3593
Refactor base use case class to really become an abstract base class
berinhard Nov 25, 2021
e069fb6
Add docstrings to use cases
berinhard Nov 25, 2021
8c9852d
Add django-extensions utility tool to make manage.py script more powe…
berinhard Nov 25, 2021
993631c
Add config to generate JPEG file with model schema for the database
berinhard Nov 25, 2021
1caac5a
Add png with sponsors DB schema to the docs
berinhard Nov 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add png with sponsors DB schema to the docs
  • Loading branch information
@berinhard
berinhard committed Nov 25, 2021
commit 1caac5a9deb6b51b9602d2db4f125447a26478b8
Binary file added docs/source/_images/sponsors-db.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/source/administration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,13 @@ they represent:
:contract.py: The `Contract` model which is used to generate the final contract document and other
support models;

.. image:: _images/sponsors-db.png
Copy link
Member

Choose a reason for hiding this comment

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

Not sure if the image (and the dependency that generates it) is necessary here as it is quite complex and I feel more lost with it 😓

:alt: Sponsors app's database schema

The sponsors app is mostly an administrative one. Its only part that regular uses can interact with is
the sponsorship application form, available at ``/sponsors/application/new/``. Despite that, every
administrative operation should be done via admin actions buttons in both ``Sponsorship`` and ``Contract``
models.

Events
------
Expand Down
0