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

Collab Summit Brainstorming / Docs / Learn #7197

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

Collab Summit Brainstorming / Docs / Learn #7197

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

Comments

@bmuenzenmeyer
Copy link
Collaborator

bmuenzenmeyer commented Nov 8, 2024

triage / assess / breakout after the session


  • metadata on pages to tag last update
    • distinction between last reviewed and last updated
  • flag when content gets stale
  • need more team accountability
    • not a lot of folks want to write
    • we dont even get changelogs and release notes
  • make sure the code is runnable
  • frontmatter on learn pages tying to core apis
  • CODEOWNERS improvements associated to teams related to the APIs highlighted in the learn content
  • translation ?? we have trouble maintaining en today
  • we need information architecture work on the learn section | Learning Path for Node.js #7198
    • this is more like a graph than a linear path
    • can we point to courses or books or videos? pandoras box / conflict of interest
    • node.js ambassadors / dev rel content
    • can we find technical writers to help
    • we should explore paying for this via open collective
@AugustinMauroy AugustinMauroy added the learn Issues/pr concerning the learn section label Nov 8, 2024
@AugustinMauroy
Copy link
Member

AugustinMauroy commented Nov 9, 2024

CODEOWNERS improvements associated to teams related to the APIs highlighted in the learn content

IMO

metadata on pages to tag last update

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).

frontmatter on learn pages tying to core apis

I'd be more in favour of having an MDX component that puts the displayName and stability index linked to the version (idea above of having it in the frontmatter) and that also allows links on the page.

translation ?? we have trouble maintaining en today

I think we just have to note on the issue that talks about this that for the moment it's not a good idea because the content isn't ‘refined’ enough yet.

this is more like a graph than a linear path

The ‘learning’ path must be a graph because node.js can be used for all sorts of things (CLI, http, automation, etc.). This means that you can't have a linear flow, you can't start with CLI then HTPP, nothing links them, they have to be run in parallel.

@bmuenzenmeyer bmuenzenmeyer self-assigned this Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
learn Issues/pr concerning the learn section
Projects
None yet
Development

No branches or pull requests

2 participants