Improve Clarity on Custom Logging Configuration in Kedro

[DimedS]

Description

There seems to be a potential area of improvement in the Kedro project regarding how custom logging is handled, particularly for new users who opt for custom logging when initializing a project using kedro new tools=logs.

Context

After choosing to receive custom logging and getting a logging.yml file in the generated project, it's not immediately clear that additional steps are required to activate this custom logging configuration. Users might expect that modifying this logging.yml file is sufficient for the changes to take effect.

Possible Implementation

In-file Comments: It might be beneficial to include comments at the top of the generated logging.yml file. These comments could inform users that they need to set the KEDRO_LOGGING_CONFIG environment variable to the path of this file for the custom configuration to be recognized. For example:

# To enable this custom logging configuration, set KEDRO_LOGGING_CONFIG to the path of this file.
# More information available at https://docs.kedro.org/en/latest/logging/logging.html

Possible Alternatives

Automatic Variable Setting: Another approach could be to automatically set the KEDRO_LOGGING_CONFIG environment variable to point to logging.yml if the user selects the logging tool during project setup. This would streamline the process and reduce potential confusion for new users.