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

v5 site upgrade #37880

Closed
23 of 38 tasks
PeachScript opened this issue Oct 7, 2022 · 1 comment
Closed
23 of 38 tasks

v5 site upgrade #37880

PeachScript opened this issue Oct 7, 2022 · 1 comment

Comments

@PeachScript
Copy link
Member

PeachScript commented Oct 7, 2022

ref: #34087

Preparation for Contribute

  • Base branch: v5-site-upgrade
  • Doc framework: dumi 2.0 (v5 target), Bisheng (v4 used)
  • dumi 2.0 theme system: [RFC] dumi 2.0 theme system umijs/dumi#1180
  • Tasks targets:
    1. Migrate Bisheng to dumi 2.0
    2. Rewrite theme according to v5 site design
  • ‼️ Tasks explanations:
    1. from links to the legacy code, to links to the target file that should to be programmed
    2. Design sub task means that the Code sub task can be start after design ready

Contribution steps

  1. Clone repo and checkout a self branch from the base branch
  2. npm i
  3. npm start & open http://localhost:8000
  4. Coding & testing
  5. Push & create a pull request to the base branch

Tasks for next preview (P0)

Layout

  • Migrate ConfigProvider, Dynamic Theme & etc. to GlobalLayout @MadCcc
  • Migrate Layout to DocLayout @PeachScript
  • Migrate Header @MadCcc
    • header
    • Design
    • Code (from -> to)
      • Navbar
      • Search bar
      • GitHub link
      • RTL button
      • Language switch
      • ...
  • Migrate Sidebar @MadCcc
    • Sidebar
    • Design
    • Code (from -> to)
      • Sticky
      • Menu Group & Menu Item
      • Collapsible (only for design doc)
      • ...
  • Migrate Footer @MadCcc

Custom pages

Tasks for release (P1)

Layout

  • Migrate Content
    • content
    • Design
    • Code (from -> to)
      • Title & edit link
      • TOC
      • Contributors list
      • Prev & next page
      • ...

Custom Components

  • Migrate Previewer
  • Create DemoWrapper (from -> to) @zqran
    • demo-wrapper
    • Expand source code for all previewer
    • Display debug demo
  • Create IconSearch (from -> to) @TrickyPi
    • icon-search
  • [PENDING] Components that depend on the new markdown data structure ready:
    • New data structure to describe markdown content for ResourceCard, APITable & etc. @zombieJ @MadCcc
    • Create ResouceCard
      • resource-card
      • Design
      • Code
    • Create #38180
      • api-table
      • Design
      • Code

Custom pages

Compile-time plugin

  • rehypeAntd plugin:
  • dumi plugin:
    • Register tab ui to display design/code to a single page (depends on dumi tab solution ready) @PeachScript
@PeachScript PeachScript changed the title [RFC] v5 site upgrade [WIP] v5 site upgrade Oct 7, 2022
@PeachScript PeachScript changed the title [WIP] v5 site upgrade v5 site upgrade Oct 8, 2022
@afc163 afc163 added the 5.x label Oct 8, 2022
@TrickyPi
Copy link
Contributor

TrickyPi commented Oct 11, 2022

Contribution steps

  1. Clone repo and checkout a self branch from the base branch
  2. npm i
  3. npm run start:dumi & open http://localhost:8000
  4. Coding & testing
  5. Push & create a pull request to the base branch

第三步的npm run start:dumi应该改成npm run start了吧

This was referenced Nov 21, 2022
@zombieJ zombieJ closed this as completed Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants