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 a feature to warn readers that a blog post may be outdated. #1773

Open
svrnm opened this issue Dec 15, 2023 · 5 comments
Open

Add a feature to warn readers that a blog post may be outdated. #1773

svrnm opened this issue Dec 15, 2023 · 5 comments
Labels
enhancement New feature or request
Milestone

Comments

@svrnm
Copy link
Contributor

svrnm commented Dec 15, 2023

We (OpenTelemetry Docs Team) want to implement a policy for blogs, that that blog posts, in contrast do doc pages, are fixed in time -- they rot (quoting @chalin here via open-telemetry/opentelemetry.io#3493). Kubernetes has implemented such a feature in their blog already, see https://kubernetes.io/blog/2020/06/30/sig-windows-spotlight-2020/ for example (there is a box at the top stating This article is more than one year old. Older articles may contain outdated content. Check that the information in the page has not become incorrect since its publication.)

Before copying the docsy blog base template into our site layout (and with that lose potential future changes without manually updating), I was wondering if this is a feature that might be worthwile to be added to docsy?

Here's how it looks for kubernetes/website: https://github.com/kubernetes/website/blob/d0cf73f310eedb198203a6109fd8accfac60e954/layouts/blog/baseof.html#L34

@fekete-robert
Copy link
Collaborator

I think adding a generic hook (like the head-end/body-end) would be great, not only for blogs. That could be used not only for the mentioned warnings, but event banners, important news, and other similar stuff as well.

@chalin chalin added this to the 24Q1 milestone Jan 11, 2024
@chalin chalin added the enhancement New feature or request label Jan 11, 2024
@chalin chalin modified the milestones: 24Q1, 24Q2 Jan 11, 2024
@chalin chalin modified the milestones: 24Q2, 24Q1 Feb 1, 2024
@fekete-robert
Copy link
Collaborator

Hi @svrnm , can you check #1868 to see if that's something that would solve your issue?

@svrnm
Copy link
Contributor Author

svrnm commented Feb 20, 2024

Hi @svrnm , can you check #1868 to see if that's something that would solve your issue?

Partially, this helps to have the message box, so this helps.

What is missing for this particular request is the logic for "this is deprecated". But this may be something that can be created locally on our website

@fekete-robert
Copy link
Collaborator

Well, the hook itself is a partial, so you can add any logic, covering specific usecases (like deprecation/outdated content) in a generic way would be difficult.

But if you use the same parameters on your site as the Kubernetes page does, than you can use the partial you've linked and they should work.

@svrnm
Copy link
Contributor Author

svrnm commented Feb 21, 2024

Well, the hook itself is a partial, so you can add any logic, covering specific usecases (like deprecation/outdated content) in a generic way would be difficult.

But if you use the same parameters on your site as the Kubernetes page does, than you can use the partial you've linked and they should work.

Sure, at the end it's up to the docsy maintainers what they want to integrate, and your PR is a good starting point, so thank you once again 👍

@chalin chalin modified the milestones: 24Q1, 24Q2 Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants