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

Don't update old blogs, and possibly warn readers #3493

Open
2 tasks
Tracked by #4082 ...
chalin opened this issue Nov 4, 2023 · 2 comments
Open
2 tasks
Tracked by #4082 ...

Don't update old blogs, and possibly warn readers #3493

chalin opened this issue Nov 4, 2023 · 2 comments
Assignees
Labels
blog e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs p2-medium
Milestone

Comments

@chalin
Copy link
Contributor

chalin commented Nov 4, 2023

I think that we need to define an update policy for blogs. It is understood that blog entries, in contrast to doc pages, are fixed in time -- they rot. For example, Kubernetes doesn't allow updates for blogs older than 12 months. In fact, I implemented the addition of the following banner-warning support (PR#31594) (screenshot from K8s):

image

We could implement something similar here -- WDYT? I'd keep it simple and only permit the update of blog post in the current year.

Of course, when pages move or are deleted from the website, we can fix any blog posts to ensure that links are still valid (or add a link-checker ignore rule).

Context, this was prompted by the merge of the following PR, which updates a blog entry over a year old:

Tasks

  • Add warning banner
  • Don't check external links?
@chalin chalin added e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs p2-medium blog labels Nov 4, 2023
@chalin chalin added this to the 24Q1 milestone Dec 6, 2023
@svrnm
Copy link
Member

svrnm commented Dec 15, 2023

https://github.com/kubernetes/website/blob/d0cf73f310eedb198203a6109fd8accfac60e954/layouts/blog/baseof.html

This is how Kubernetes is doing it. If I understand it correctly we would need to take the baseof for blog posts out of docsy and modify it, I would rather prefer not doing that.

I wonder if this is a feature we can upstream to docsy?

@chalin
Copy link
Contributor Author

chalin commented Jan 11, 2024

Thanks for creating the issue over on the Docsy repo. I'll see if we can get this setup more quickly here first though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blog e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs p2-medium
Projects
Status: No status
Development

No branches or pull requests

2 participants