Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs should reflect latest version "tested against" for touchpoints with different tools/frameworks/platforms #2578

Open
stichbury opened this issue May 11, 2023 · 0 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Something that occurs to me as I complete #2435 is that we don't typically state the latest version of something we integrate with/deploy to that we tested.

I was looking to see what Airflow version our kedro-airflow plugin was tested for, and couldn't find it, for example. We don't really say this in any of our docs, but deployment is a particular area where it would help the reader to know what definitely works and to gauge how old the docs are by how big the gap is between "tested against" version and current version.

This (sort-of) follows on from my thinking that we need a way to reflect the latest signficant updates on a documentation page so readers aren't guessing from change history.

I'm not sure of the exact solution right now, but am dropping this here to think about. It may simply be asking folks to add the extra information to pages where there are touchpoints, but if there's a more elegant solution, I'm up to hear about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Status: No status
Development

No branches or pull requests

1 participant