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

Create a way to display and manage content freshness #7295

Open
bmuenzenmeyer opened this issue Nov 29, 2024 · 1 comment
Open

Create a way to display and manage content freshness #7295

bmuenzenmeyer opened this issue Nov 29, 2024 · 1 comment
Labels
content Issues/pr concerning content learn Issues/pr concerning the learn section

Comments

@bmuenzenmeyer
Copy link
Collaborator

Broken out of #7197

Add metadata on pages to display last update (git has this info of course)

  • we noted a distinction between last reviewed (by a human) and last updated
  • eventually, create a means to flag when content gets stale, perhaps via an action that opens issues, if one exists

@AugustinMauroy had these thoughts

I'm more in favour of the version used in the example. Because a date has no value in relation to the runtime. In addition, having the version allows the contributor/collaborator to know if a document needs to be revised.
And from a functional point of view, I think we should add a bit to the MetaBar that allows you to install (redirect to the installation of the correct version).

This is interesting, but would create LTS rollover moments where we have all to review all content. I think that would quickly become the norm, twice a year.
I suppose that's better than arbitrary dates, TBH.

Given that thought experiment, maybe we build on #7294 and build something that asks the owners to review the content twice a year?

@bmuenzenmeyer bmuenzenmeyer added the learn Issues/pr concerning the learn section label Nov 29, 2024
@AugustinMauroy
Copy link
Member

AugustinMauroy commented Feb 2, 2025

I'm working on TS sub-section. And I had started mark which version how node is covered by the article. But the issue is:
it's not a unique version is a semver range. For example learn/typescript/run talk about node.js customization hooks that supported in >=v20.6.0 || >=v18.19.0.

so the last thing to validate before moving on to the code.
It's about knowing what to put in the MetaBar. There are several solutions:

  • Download to the correct version (IMO not very interesting)
  • Link to https://nodejs.org/docs/latest-v${mostRecentInSemver}.x/api/index.html
    If we set the mostRecentInSemver variable in the page context, we can have a new mdx component <LinkToApiDocs> which takes api as a props.

@github-project-automation github-project-automation bot moved this to 📋 Backlog in Node.js Website Feb 4, 2025
@ovflowd ovflowd added the content Issues/pr concerning content label Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues/pr concerning content learn Issues/pr concerning the learn section
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants