From 2da199102533028690ccd045a0858cb38a296750 Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 23 Jan 2023 17:35:52 -0500 Subject: [PATCH] update sponsor links & etc --- README.md | 6 ++++-- doc/catalog.md | 10 ++++++---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 98229c27..dbb194ee 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Test Status](https://github.com/neodb-social/neodb/actions/workflows/django.yml/badge.svg?branch=main) -Boofilsic/NeoDB is an open source project and free service to help users manage, share and discover collections, reviews and ratings for culture products (e.g. books, movies, music, podcasts, games and performances) in Fediverse. +Boofilsic/NeoDB is an open source project and free service to help users manage, share and discover collections, reviews and ratings for culture products (e.g. books, movies, music, podcasts, games and performances) in Fediverse. [NeoDB.social](https://neodb.social) and [NiceDB](https://nicedb.org) are free services hosted by volunteers. @@ -18,4 +18,6 @@ Please see [doc/install.md](doc/install.md) - Join our Discord community, links available on [our Fediverse profile](https://mastodon.social/@neodb) ## Sponsor -If you like this project, please consider sponsoring NiceDB on [Patreon](https://patreon.com/tertius). +If you like this project, please consider sponsoring + - NeoDB on [ko-fi](https://ko-fi.com/neodb) or [liberapay](https://liberapay.com/neodb) + - NiceDB on [Patreon](https://patreon.com/tertius). diff --git a/doc/catalog.md b/doc/catalog.md index edbec911..bf7fa6cc 100644 --- a/doc/catalog.md +++ b/doc/catalog.md @@ -3,7 +3,7 @@ Catalog Data Models ----------- -all types of catalog items inherits from `Item` which stores as multi-table django model. +all types of catalog items inherits from `Item` which stores as multi-table django model. one `Item` may have multiple `ExternalResource`s, each represents one page on an external site ```mermaid @@ -34,10 +34,10 @@ classDiagram } Item <|-- Edition Item <|-- Series - + Series *-- Work Work *-- Edition - + class Series { +String Goodreads_Series_ID } @@ -58,7 +58,7 @@ classDiagram Item <|-- TVEpisode TVShow *-- TVSeason TVSeason *-- TVEpisode - + class TVShow{ +String IMDB_ID +String TMDB_ID @@ -90,6 +90,7 @@ Add a new site -------------- - add a new item to `IdType` enum in `catalog/common/models.py` - add a new file in `catalog/sites/`, a new class inherits `AbstractSite`, with: + * `SITE_NAME` * `ID_TYPE` * `URL_PATTERNS` * `WIKI_PROPERTY_ID` (not used now) @@ -105,3 +106,4 @@ Add a new site + move captured response file to `test_data/`, except large/images files. Or if have to, use a smallest version (e.g. 1x1 pixel / 1s audio) + add `@use_local_response` decorator to test methods that should pick up these responses - run all the tests and make sure they pass + - add `&.source-label__sitename` to `common/static/sass/_Label.sass`