feat(tool): prepare_framework_v2.py More User-Friendly + Update Documentation (#2306)

* Update "prepare_framework_v2_config.yaml"

Improve example values

* [YAML Config] Fix Locale Detection

+ Improved description of the "locale" field for the YAML configuration file

* [YAML Config] Add Packager Field

* [YAML Config] Small Fix

* [YAML Config] Improve Error Handling

- "ref_id" fields in the framework and implementation groups are now checked to see if they comply with the same naming standard as "urn_root"
- Extra checks have been added before processing implementation groups for the framework and extra locales.
- Improved YAML configuration file documentation

* [YAML Config] Add Locale Check

The script now checks whether an additional locale matches the framework's main locale. The locale is ignored if it does.

* [Excel Config] Add Excel Config File Prototype

First version of the Excel configuration file for "prepare_framework_v2.py"

* [YAML Config] Small Print Fix

* [Excel Config] Update Excel Config File

* [YAML Config] Update Function Names

* Fix Script Docstring

* Update Script Comments

* [Excel Config] Update Excel Config File

* [Excel Config] Update Excel Config File

* [Excel Config] Add Excel Config File Support

The "prepare_framework_v2.py" script now supports the Excel version of the configuration file (prepare_framework_v2_config.xlsx).
All data checks and error handling have been added and fixed so that the script works exactly as when we import the YAML configuration file.

* [Excel Config] Add Sheet Protection to Excel Config File

Only cells intended to be modified can be. This will prevent users from accidentaly modifying a cell that should't be.

* [Excel Config] Update Excel Config File

It's now possible to add/remove the "#" next to the value names "implementation_groups_sheet_base_name" and "excel_file_name" in the "base" sheet thanks to a drop-down menu

* [Excel Config] Update Script

- Ignore the "_configs" sheet in the Excel config file
- Ignore specific warning when importing Excel config file
- Fix locale check
- Improve console prints

* [Excel Config] Update Script

Improved locale check

* Fix Error Message for "ref_id"

* [Excel Config] Update Script

Fixed error message for the "validate_implementation_groups" function (in Excel config file mode)

* [Excel & YAML Config] Update Script

Duplicated Ref. IDs are now detected in implementation groups. An error is raised if that's the case.

* [Excel & YAML Config] Update Script

The extra locale won't be added to the output Excel file if it corresponds to the framework's locale

* [Excel & YAML Config] Update Script

The script now checks if an extra locale is duplicated

* Update README.md

Fix script names

* [tool] Update README.md

Text formatting

* [tools] Update README.md

Added documentation for the scripts "convert_library_v2.py", "convert_library_v1.py" and "convert_v1_to_v2.py"

* [tools] Small Fix in README.md

* Fix "prepare_framework_v2.py" Docstring

* [tools] Update README.md

Added documentation for the "prepare_framework_v2.py" script

* Move Script & Config Files

Moved "prepare_framework_v2.py", "prepare_framework_v2_config.xlsx" and "prepare_framework_v2_config.yaml" out of the "misc" folder

* [tools] Update README.md

"Mappings" section updated

* [tools] Move "prepare_mapping_v1.py" in "misc"

This script is now useless

* Small Fix in README.md

"YAML" written in upper case

* [tools] Update README.md

Added notes for "prepare_framework_v2.py"

* [tools] Small Fixes in README.md

* Small Fix in Script

* Fix Line Indentation

* [tools] Small Fix in README.md & Script

* [tools] Update README.md

Fixed doc for "_content tab for a framework"

* [tools] Update README.md

Fixed "Threats" and "Reference controls" sheet descriptions. Some fields were unnecessary.

* [tools] Update README.md

Added the "About framework Updates" section. This will prevent users from forgetting to increment the version number of a framework before updating it.

Author: tarkadia

README.md

@@ -262,11 +262,11 @@ Checkout the [library](/backend/library/libraries/) and [tools](/tools/) for the
 
 A library can be a framework, a catalog of threats or reference controls, and even a custom risk matrix.
 
-Take a look at the `tools` directory and its [dedicated README](tools/README.md). The `convert_library.py` script will help you create your library from a simple Excel file. Once you have structured your items in that format, just run the script and use the resulting yaml file.
+Take a look at the `tools` directory and its [dedicated README](tools/README.md). The `convert_library_v2.py` script will help you create your library from a simple Excel file. Once you have structured your items in that format, just run the script and use the resulting YAML file.
 
 You can also find some specific converters in the tools directory (e.g. for CIS or CCM Controls).
 
-There is also a tool to facilitate the creation of mappings, called `prepare_mapping.py` that will create an Excel file based on two framework libraries in yaml. Once properly filled, this Excel file can be processed by the `convert_library.py` tool to get the resulting mapping library.
+There is also a tool to facilitate the creation of mappings, called `prepare_mapping_v2.py` that will create an Excel file based on two framework libraries in YAML. Once properly filled, this Excel file can be processed by the `convert_library_v2.py` tool to get the resulting mapping library.
 
 ## Community