Kedro: Fixing Outdated Telemetry Docs Link In Warning Message

Hey Kedro users! Have you ever noticed that telemetry warning message popping up after running a Kedro command? Well, it seems like there's a little hiccup with the link it provides. Let's dive into this issue and explore how we can fix it to ensure everyone gets the right information.

The Issue: Outdated Documentation Link

The Kedro telemetry feature sends anonymous usage data to help improve the product. This is super helpful for the Kedro team, but it's important that the message displayed about telemetry points to the correct documentation. During the 1.0.0 release, the location of the Kedro telemetry documentation page was updated. Previously, it lived at https://docs.kedro.org/en/0.19.14/configuration/telemetry.html. Now, it's located at https://docs.kedro.org/en/1.0.0/about/telemetry/. However, the telemetry warning message, which appears after each command execution, still references the old link. This is a problem because the old link is no longer functional, leaving users scratching their heads when they try to learn more about telemetry.

The warning message looks something like this:

[10/16/25 10:37:59] INFO     Kedro is sending anonymous usage data with the sole   plugin.py:243
                             purpose of improving the product. No personal data or              
                             IP addresses are stored on our side. To opt out, set               
                             the `KEDRO_DISABLE_TELEMETRY` or `DO_NOT_TRACK`                     
                             environment variables, or create a `.telemetry` file               
                             in the current working directory with the contents                  
                             `consent: false`. To hide this message, explicitly                
                             grant or deny consent. Read more at                               
                             https://docs.kedro.org/en/stable/configuration/teleme             
                             try.html   

See that link at the bottom? It's pointing to the old, outdated page! This means users clicking on it won't find the information they're looking for. It's like sending someone on a wild goose chase – not the best user experience, right? The core of the problem lies in the fact that the warning message hasn't been updated to reflect the new documentation URL. This discrepancy can lead to confusion and frustration for users who want to understand how Kedro handles telemetry and how they can control it.

To make things crystal clear, telemetry is a system that automatically collects data from remote sources and transmits it to a receiving station for monitoring and analysis. In the context of Kedro, telemetry involves gathering anonymous usage data to help the Kedro team understand how the tool is being used and identify areas for improvement. This data collection is done with the goal of enhancing the product and making it more user-friendly. However, it is crucial that users are fully informed about this process and have the ability to opt out if they choose. This is where the accuracy of the documentation link in the warning message becomes paramount.

Proposed Solutions: How to Fix This?

So, what can we do to fix this outdated link? There are a couple of potential solutions on the table, and each has its own set of pros and cons. Let's break them down:

Option 1: Update the Link in the Warning Message

The most straightforward approach is to simply update the link in the warning message to point to the new documentation page. This seems like the obvious solution, right? Just swap out the old URL for the new one, and problem solved!

• Pros: This is a direct and efficient solution. It ensures that users clicking the link will be taken to the correct information about Kedro telemetry. It's also a relatively simple change to implement in the Kedro codebase.
• Cons: The downside here is that older versions of the kedro-telemetry library will still reference the old link. If someone is using an older version of Kedro, they'll still see the outdated link in the warning message. We can't retroactively change those links in older versions. This might not be a huge issue, but it's something to consider.

Option 2: Restore the Old Telemetry Page

Another option is to restore the old telemetry page to its original address. This means putting the documentation back where it used to be, so the old link in the warning message will work again.

• Pros: This would ensure that the link works for all versions of Kedro, including older ones. No one would be directed to a broken page. It's a more comprehensive solution in terms of backward compatibility.
• Cons: The main drawback is that it might create confusion about which documentation is the most up-to-date. If the documentation lives in two places, users might not know which version to trust. It could also add complexity to the documentation maintenance process, as changes would need to be mirrored in both locations.

Recommendation: Reverting to the Old Path

Considering the pros and cons of each option, the suggested solution is to revert the telemetry documentation to the old path. Here's why:

• Backward Compatibility: Older versions of the kedro-telemetry library also reference the old link, and we can’t retroactively change those links. Reverting to the old path ensures that all users, regardless of their Kedro version, will be able to access the documentation.
• User Experience: While having documentation in two places isn't ideal, it's arguably better than having a broken link in the warning message. A broken link leads to a dead end, while having an older version of the documentation available, though not perfect, still provides some information.
• Simplicity: Reverting the path is a relatively straightforward process. It avoids the complexities of trying to update links across different versions of the library and documentation.

This approach prioritizes the user experience by ensuring that the link in the warning message always leads to a working page. While it may require some additional effort to maintain consistency between the old and new documentation in the long run, it provides the most immediate and reliable solution to the problem.

Impact on Users: Why This Matters

So, why is this outdated link such a big deal? Well, it all boils down to user experience and trust. When users see a warning message with a link, they expect that link to take them to relevant information. If the link is broken, it creates a sense of frustration and can erode trust in the tool.

Here's a breakdown of the impact on users:

• Confusion and Frustration: Users who click on the outdated link will be taken to a 404 error page or a page that doesn't contain the information they're looking for. This can be confusing and frustrating, especially for new users who are just getting started with Kedro.
• Lack of Information: The outdated link prevents users from accessing important information about Kedro's telemetry feature. This includes details on how telemetry works, what data is collected, and how to opt out. Without this information, users may feel uncomfortable or uncertain about using Kedro.
• Erosion of Trust: When a link in a warning message is broken, it can make the tool seem less polished and reliable. This can erode trust in the tool and the team behind it.
• Increased Support Burden: If users are unable to find the information they need through the link in the warning message, they may turn to other channels for help, such as the Kedro community forum or the support team. This can increase the support burden and divert resources away from other tasks.

By fixing the outdated link, we can improve the user experience, build trust in the tool, and reduce the support burden. It's a small change that can have a big impact.

Steps to Implement the Fix

Alright, so we've established that fixing this outdated link is important. Now, let's talk about the steps involved in actually implementing the fix. Whether we choose to update the link in the warning message or revert the telemetry documentation to the old path, there are some key steps we need to follow.

Updating the Link in the Warning Message:

1. Identify the Code: First, we need to locate the code that generates the telemetry warning message. This will likely be in the kedro-telemetry library or in the core Kedro codebase. We'll need to dig around and find the specific file and line of code where the link is defined.
2. Modify the Link: Once we've found the code, we can simply replace the old link with the new one. This is a straightforward text change.
3. Test the Change: After making the change, it's crucial to test it thoroughly. We need to run Kedro commands and make sure the warning message appears with the correct link. We should also test in different environments and with different versions of Kedro to ensure the fix works consistently.
4. Submit a Pull Request: Once we're confident that the fix is working correctly, we can submit a pull request to the Kedro repository. This will allow the Kedro team to review the change and merge it into the codebase.

Reverting the Telemetry Documentation to the Old Path:

1. Restore the Documentation: This involves moving the telemetry documentation back to its original location on the Kedro documentation site. This might involve restoring files from a previous version of the documentation or creating a redirect from the old URL to the new one.
2. Update Internal Links: If there are any internal links within the documentation that point to the old telemetry page, we'll need to update them to point to the new location.
3. Test the Change: After restoring the documentation, we need to test it thoroughly. We should visit the old URL and make sure it redirects to the correct page. We should also check the documentation for any broken links or other issues.
4. Communicate the Change: Once the documentation has been restored, it's important to communicate the change to users. This could involve updating the Kedro release notes, posting an announcement on the Kedro community forum, or sending out an email to Kedro users.

No matter which approach we take, testing is key. We need to make sure the fix works as expected and doesn't introduce any new issues.

Community Input: Let's Discuss!

This is where you come in, Kedro community! Your thoughts and opinions are super valuable. What do you think is the best approach to tackle this outdated link issue? Do you have any other ideas or suggestions? Let's chat about it!

We encourage you to share your thoughts in the comments below or on the Kedro GitHub repository. Your input will help us make the best decision for the Kedro community. Together, we can ensure that Kedro remains a user-friendly and reliable tool for data science.

Conclusion: A Small Fix, a Big Impact

In conclusion, while the issue of an outdated documentation link in the Kedro telemetry warning message might seem like a small thing, it can have a significant impact on user experience and trust. By addressing this issue promptly and effectively, we can ensure that Kedro users have access to the information they need and that they feel confident in using the tool.

Whether we choose to update the link in the warning message or revert the telemetry documentation to the old path, the key is to prioritize the user experience and make sure the fix is implemented correctly. And, of course, we want to hear from you – the Kedro community – to make sure we're making the best decision for everyone. So, let's keep the conversation going and work together to make Kedro even better!