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

Add "old" or "deprecated" tags to tutorials #127

Closed
4 tasks done
bilgeyucel opened this issue May 18, 2023 · 7 comments · Fixed by deepset-ai/haystack-tutorials#215
Closed
4 tasks done

Add "old" or "deprecated" tags to tutorials #127

bilgeyucel opened this issue May 18, 2023 · 7 comments · Fixed by deepset-ai/haystack-tutorials#215
Assignees

Comments

@bilgeyucel
Copy link
Collaborator

bilgeyucel commented May 18, 2023

We'll remove some components from Haystack. Tutorials with these components should have a tag to indicate this deprecation.

Tasks

@bilgeyucel bilgeyucel self-assigned this May 18, 2023
@TuanaCelik
Copy link
Member

I see a few options here and I would be interested in what @masci finds appropriate too:

  1. 'old' doesn't seem to convey the right message to me. It just makes it sound like the tutorial is simply outdated and we haven't bothered to update
  2. 'Deprecated' sounds ok.. But also maybe a better idea is to tag it with the latest version it works with? So a tutorial that has a deprecated node as of v1.17 would be tagged 'works with v1.16'? Does that make sense?
  3. If we do that, we can also have a filter option that shows tutorials of older versions wdyt?

@bilgeyucel
Copy link
Collaborator Author

works with v1.16 sounds great. My only concern is the length of the text. It will always cause tags to overflow to the second line
image

Now that I have started thinking about it, adding this tag to tutorials is a bit counterintuitive as it might sound like others are not working with v1.16. How about changing the name to "works up till v1.16"?

Another point is, which is totally UI related, the color of the tag. We have already added a tag when a tutorial is "featured", so to draw attention. The purpose of this tag, however, is contrary, to avoid drawing attention to these tutorials. Should we leave the color to Carlos or do you have any other ideas?

@TuanaCelik
Copy link
Member

'compatible up to v1.16'?
As for the length, a suggestion would be to have the full line once you go to the tutorial but on the card it can simply be a version tag with the Haystack logo next to it, and have the line come up on hover saying the full 'works with' or 'compatible up to'?

I'm sure we can find some good practices out there. Shall we do some field research?

@masci
Copy link
Contributor

masci commented Jun 12, 2023

@TuanaCelik now that you mentioned it in your comment, what about "outdated"?

Versioning looks great but it's a bigger effort for us to keep the versions constantly up to date and for the user to get the message in a direct and unambiguous manner.

@bilgeyucel
Copy link
Collaborator Author

"Outdated" can give the message in the tutorial card. We can add a longer text in the tutorial content as "compatible up to v1.16". We already add a note on top of the tutorial so it should be fine

image

In the outdated tutorials, we pin the version as we install Haystack like pip install farm-haystack[colab,inmemorygraph]==1.16.0. So it should be easy to set and maintain the versions, but I might be missing a point.

@TuanaCelik
Copy link
Member

I think we have an agreement :) I like 'outdated' on the card + this type of warning in the tutorial as @bilgeyucel mentions

@bilgeyucel
Copy link
Collaborator Author

Then, we can introduce a new haystack_version key to the frontmatter of the tutorial. If the value isn't "latest", we display the "outdated" tag. We can use this haystack_version as we test the tutorials so it's better to have a multifunctional variable rather than a boolean key.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants