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

Display warning of outdated content on technical blog posts #34

Open
0x2b3bfa0 opened this issue Jun 27, 2022 · 2 comments
Open

Display warning of outdated content on technical blog posts #34

0x2b3bfa0 opened this issue Jun 27, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Jun 27, 2022

All the material we write will be outdated sooner rather than later, and — at least as per @casperdcl and @0x2b3bfa0 — blog posts aren't something we should maintain to the same extent as documentation.

It would be nice to display a warning of outdated content on technical blog posts when a given amount of days/months passes. Additionally, it would be nice to override/configure this through the post frontmatter.

best-before: 2022-08-01

Note
Playful example, not suggesting best-before as the best name; also not sure if it's better to use relative (in 6 months) or “absolute” (2022-12-27) time.

Examples

Can't find any off the top of my head, but I have seen a few in the last fortnight. See https://docs.github.com/es for a similar notice on outdated translations.

Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

We frequently publish updates to our documentation. Translation of this page may be in progress. For the most current information, please visit the English documentation. If there is a problem with the translations on this page, please inform us.

@casperdcl
Copy link
Contributor

/CC @iterative/docs

@casperdcl casperdcl added the enhancement New feature or request label Jun 27, 2022
@jorgeorpinel
Copy link

jorgeorpinel commented Jun 28, 2022

I feel like it's hard to determine whether something is outdated based on a pre-defined length of time. Some features are stable and will apply almost the same years later. Some things from release posts for example, in contrast, may be outdated a few months later. But you don't know until it happens.

Blog posts already have a date in any case so readers can decide whether it may be outdated or not.

p.s. we can always add these warnings manually to specific posts if needed.

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