docs: add new ukraine list to documentation

Phaeton · Mar 3, 2023 · 81fef76 · 81fef76
1 parent 5eddea7
commit 81fef76
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,9 @@
 # plane-alert-db
 
-
-This project consists of lists of 'interesting' aircraft, formatted as CSV files. The list is designed to work with the excellent **https://github.com/kx1t/docker-planefence** . 
+This project consists of lists of 'interesting' aircraft, formatted as CSV files. The list is designed to work with the excellent **https://github.com/kx1t/docker-planefence** .
 
 > **Warning**
-> Please only suggest/make any changes to the [plane-alert-db.csv](plane-alert-db.csv), [plane-alert-twitter-blocked.csv](plane-alert-twitter-blocked.txt), [plane-alert-pia](plane-alert-pia) and [plane_images.txt](plane_images.txt) files on GitHub - all other files (except PIA) are generated from this file, and if you do not make your changes there, they will be overwritten and lost.
+> Please only suggest/make any changes to the [plane-alert-db.csv](plane-alert-db.csv), [plane-alert-twitter-blocked.csv](plane-alert-twitter-blocked.txt), [plane-alert-pia.csv](plane-alert-pia.csv), [plane-alert-ukraine.csv](plane-alert-ukraine.csv) and [plane_images.txt](plane_images.txt) files on GitHub - all other files (except PIA) are generated from this file, and if you do not make your changes there, they will be overwritten and lost.
 
 # Current Content
 

diff --git a/READ_BEFORE_MAKING_CHANGES.md b/READ_BEFORE_MAKING_CHANGES.md
@@ -4,7 +4,8 @@ Please only suggest/make any changes to the following files:
 
 - [plane-alert-db.csv](plane-alert-db.csv): This is the main database file. All non-image changes should be done here.
 - [plane-alert-twitter-blocked.csv](plane-alert-twitter-blocked.txt): This source file contains planes that will cause your Twitter account to be banned. Please use it with care.
-- [plane-alert-pia](plane-alert-pia): This list contains PIA planes.
+- [plane-alert-pia.csv](plane-alert-pia.csv): This list contains PIA planes.
+- [plane-alert-ukraine.csv](plane-alert-ukraine.csv): This list contains Ukrainian planes.
 - [plane_images.txt](plane_images.txt): You can add plane images in this source file.
 
 All other files are generated from this file using the [.github/workflows/create_db_derivatives](.github/workflows/create_db_derivatives) GitHub action, and if you do not make your changes there, they will be overwritten and lost.
diff --git a/scripts/create_db_derivatives.py b/scripts/create_db_derivatives.py
@@ -1,7 +1,8 @@
 """This script creates (derivative) category and images CSV database files from the main
 'plane-alert-db.csv' database file. The categories are created based on the 'CMPG'
 column, while images are added using the 'plane_images.txt' reference file. It also
-creates an extended database file using the 'blacklist.txt' file.
+creates the 'plane-alert-twitter-blocked-images.csv' and 
+'plane-alert-ukraine-images.csv' database files.
 """
 
 import logging