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

Winding down the old layouts/old codebase in favour of the Website Redesign #5403

Closed
ovflowd opened this issue May 24, 2023 · 7 comments
Closed
Labels
infrastructure Issues/PRs related to the Repository Infra meta Meta Issues for Administration of the Website Team website redesign Issue/PR part of the Node.js Website Redesign

Comments

@ovflowd
Copy link
Member

ovflowd commented May 24, 2023

With the continuous work into making the Website Redesign happen (#5131), this issue describes what will happen once we finish migrating all existing Components.

Migrating Layouts from nodejs.dev

Once we've finished migrating all necessary components and have all the logic planned, it will be time to start migrating layouts.

  • Differently from nodejs.dev, the layouts here work differently and are "invoked" by each page's Frontmatter.
  • Once we start migrating the new pages, they will potentially all use .mdx instead of plain .md.
  • Layouts on nodejs.dev are overcomplicated; on this repository, we want to simplify them and break them down into different layouts.
    • For example, Learn, Blog, and regular Pages shared the same Layout on nodejs.dev, whilst we want to make one layout for each one.
  • Initially, all the old Layouts will be placed within layouts/old/

Migrating Pages from nodejs.dev

On nodejs.dev, pages reside on src/pages and their content on src/content; on this repository, both the page and the content will stay on pages and be a .mdx file.

  • Frontmatter will be used for determining the layout and page title and possibly extra options
  • MDX will be used for pages that need extra Components or content to be wrapped somehow
  • Some pages on nodejs.dev use complex wrapping functions and GraphQL, whereas on this repository, we want to simplify this.
  • Initially all the new pages will be placed within pages/new/

Removing Old Content

Once the pages were migrated and we had satisfactory results (Components and Layouts being tweaked), we will start removing the old content:

  • All old Components
  • All old Hooks, Utilities and Scripts
  • All old styles
  • All old Layouts
  • All old pages

Final touches

The final touches include making code adjustments, documentation updates and migrating pages.

  • The _app.mdx component needs to be updated, including removing old fonts and styles
  • The pages from pages/new are going to be placed directly within the pages/ folder
  • Documentation regarding Translation, Contributing, and others need to be updated
  • Probably a few packages can be removed
@ovflowd ovflowd added website redesign Issue/PR part of the Node.js Website Redesign meta Meta Issues for Administration of the Website Team labels May 24, 2023
@ovflowd ovflowd pinned this issue May 24, 2023
@ovflowd ovflowd added the infrastructure Issues/PRs related to the Repository Infra label May 24, 2023
@ovflowd
Copy link
Member Author

ovflowd commented May 24, 2023

Also the following NPM packages will be removed once we get rid of the old stuff:

  • highlight.js
  • strftime
  • remark-gfm

@mertcanaltin
Copy link
Member

can i work on it? @ovflowd

@AugustinMauroy
Copy link
Contributor

AugustinMauroy commented Jun 1, 2023

@mertcanaltinHere's what it says in the description of the issue
"this issue describes what will happen once we finish migrating all existing Components."

@ovflowd
Copy link
Member Author

ovflowd commented Jun 1, 2023

Hey @mertcanaltin this is a meta issue, there's no actionable directly from this issue :)

(Exactly as @AugustinMauroy mentioned above!)

@mertcanaltin
Copy link
Member

I understood thank you 😭

@ovflowd ovflowd unpinned this issue Jun 12, 2023
@ovflowd
Copy link
Member Author

ovflowd commented Jun 12, 2023

@mertcanaltin I've updated some issues adding more stuff that can be worked on :)

@ovflowd ovflowd pinned this issue Jul 27, 2023
@ovflowd
Copy link
Member Author

ovflowd commented Sep 5, 2023

Closing this for now, in favor of #5131

@ovflowd ovflowd closed this as completed Sep 5, 2023
@ovflowd ovflowd unpinned this issue Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Issues/PRs related to the Repository Infra meta Meta Issues for Administration of the Website Team website redesign Issue/PR part of the Node.js Website Redesign
Projects
Archived in project
Development

No branches or pull requests

3 participants