nodejs.dev icon indicating copy to clipboard operation
nodejs.dev copied to clipboard

Build In LTS / Current docs to Gatsby Bundle

Open amiller-gh opened this issue 6 years ago • 4 comments

Summary

Historical documentation will be fetched async as requested: ref https://github.com/nodejs/nodejs.dev/issues/255. This ticket must be done after historical docs land.

Current and LTS docs should be pulled in through node_modules via the (yet-to-be-published) @nodejs/i18n translated module and bundled with the Gatsby app to make best use of SSR and translation.

If the user selects the LTS docs (shown by default when "docs" is clicked in the nav) Gatsby should render the bundled documentation instead of making the AJAX request for historical documentation.

Outstanding Questions

  1. Will we provide translations for historical documentation? If yes, we need to make historical translated docs available on the server and/or the node_module.

amiller-gh avatar May 31 '19 12:05 amiller-gh

@nodejs/i18n I'd like to follow up with this issue. Can someone please update me about the status on the i18n-package? Do we have blockers?

LaRuaNa avatar Mar 21 '20 14:03 LaRuaNa

@LaRuaNa please take a look at https://github.com/nodejs/i18n/pull/250 -- feedback wanted!

zeke avatar Mar 24 '20 17:03 zeke

@benhalverson do you know if the i18n module is functional/maintained. Should we rely on it? Or should we proceed with the YAML approach we were talking about?

ovflowd avatar Jul 27 '22 15:07 ovflowd

Hey @zeke @JohnTitor is there any chance the nodejs/i18n package could also provide the data in JSON besides just Markdown? (https://github.com/nodejs/i18n/issues/689)

ovflowd avatar Aug 02 '22 16:08 ovflowd

Closing as this was done, but sadly we're not going to proceed with the i18n package here for now.

ovflowd avatar Sep 04 '22 10:09 ovflowd