From 09e09e9ab9cdcb8d96fcd2fcf7f810138dec6027 Mon Sep 17 00:00:00 2001 From: Patrick Robertson Date: Fri, 7 Mar 2025 16:28:17 +0000 Subject: [PATCH] Document module renames in 'upgrading from 0.12' how to --- docs/source/how_to/new_config_format.md | 39 ++++++++++++++++--------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/docs/source/how_to/new_config_format.md b/docs/source/how_to/new_config_format.md index ba05d7d..99c2a06 100644 --- a/docs/source/how_to/new_config_format.md +++ b/docs/source/how_to/new_config_format.md @@ -22,7 +22,7 @@ your configuration file or on the command line (using --feeders) ```{code} yaml steps: - feeder: gsheet_feeder + feeder: cli_feeder ... ``` @@ -75,28 +75,39 @@ The names of the actual modules have also changed, so for any extractor modules - `wayback_archiver_enricher` → `wayback_extractor_enricher` - `vk_archiver` → `vk_extractor` -Additionally, the `youtube_archiver` has been renamed to `generic_extractor` as it is considered the default/fallback extractor. Read more about the [generic extractor](../modules/autogen/extractor/generic_extractor.md). + +#### c) Module Renaming + + +The `youtube_archiver` has been renamed to `generic_extractor` as it is considered the default/fallback extractor. Read more about the [generic extractor](../modules/autogen/extractor/generic_extractor.md). + +The `atlos` modules have been merged into one, as have the `gsheets` feeder and database. + +- `atlos_feeder` → `atlos_feeder_db_storage` +- `atlos_storage` → `atlos_feeder_db_storage` +- `atlos_db` → `atlos_feeder_db_storage` +- `gsheet_feeder` → `gsheet_feeder_db` +- `gsheet_db` → `gsheet_feeder_db` + Example: ```{code} yaml steps: + feeders: + - gsheet_feeder_db # formerly gsheet_feeder ... - archivers: - - telethon_archiver - - youtube_archiver - - vk_archiver - -# renaming 'archiver' to 'extractor', and renaming the youtube_archiver the above config will become: -steps: + extractors: # formerly 'archivers' + - telethon_extractor # formerly telethon_archiver + - generic_extractor # formerly youtube_archiver + - vk_extractor # formerly vk_archiver + databases: + - gsheet_feeder_db # formerly gsheet_db ... - extractors: - - telethon_extractor - - vk_extractor - - generic_extractor ``` -#### c) Redundant / Obsolete Modules + +#### d) Redundant / Obsolete Modules With v0.13 of Auto Archiver, the following modules have been removed and their features have been built in to the generic_extractor. You should remove them from the 'steps' section of your configuration file: