datafuselabs / databend

𝗗𝗮𝘁𝗮, 𝗔𝗻𝗮𝗹𝘆𝘁𝗶𝗰𝘀 & 𝗔𝗜. Modern alternative to Snowflake. Cost-effective and simple for massive-scale analytics. https://databend.com
https://docs.databend.com
Other
7.31k stars 704 forks source link

website: Migrate site to docusaurus #3210

Closed Xuanwo closed 2 years ago

Xuanwo commented 2 years ago

I hereby agree to the terms of the CLA available at: https://databend.rs/policies/cla/

Summary

This PR is a part of https://github.com/datafuselabs/databend/issues/3209

Please review this PR here: https://databend.vercel.app/

Migrate plan

For now, I think there should be three stages:

image

Stage 1

Stage before this PR gets merged.

At stage 1, we need to:

Stage 2

This PR getting merged means we already changed the databend website framework. However, until we change the databend.rs DNS to vercel, this change will not take effect.

At stage 2, we need to:

Stage 3

The final stage. After DNS is changed, the site will be online and replace the current site.

At stage 3, we need to:

Changelog

databend-bot commented 2 years ago

Thanks for the contribution! I have applied any labels matching special text in your PR Changelog.

Please review the labels and make any necessary changes.

Xuanwo commented 2 years ago

In order to make this PR works correctly, I need the repo maintainer to config the vercel correctly.

BohuTANG commented 2 years ago

Thank you @Xuanwo . It might make sense to wait with this PR until we have a front-end design, I've temporarily converted it to draft first. We still need some work to convert the markdown format from material to docusaurus.

mergify[bot] commented 2 years ago

This pull request has merge conflicts that must be resolved before it can be merged. @Xuanwo please rebase it 🙏

Xuanwo commented 2 years ago

Hi, I'm thinking about the migration plan.

Is this plan looks good to you? @BohuTANG @PsiACE

I prefer to make stage 1 as short as possible so that we don't need to speed too much time on syncing docs change.

PsiACE commented 2 years ago

At stage 2, People will still see the site built by MkDocs hosted at gh-pages

It looks like mkdocs will miss the documentation update.

Xuanwo commented 2 years ago

It looks like mkdocs will miss the documentation update.

Yep.

It's a trade-off. And it depends on how long we will stay at stage 2.

Either we sync changes between two website frameworks manually, or we just stop updates for MkDocs for the whole stage 2.

PsiACE commented 2 years ago

Either we sync changes between two website frameworks manually, or we just stop updates for MkDocs for the whole stage 2.

We can stop updates for MkDocs. However, to reduce the wait, I recommend only figuring out how to organize content in stage 2 . The front-end design can be deferred to stage 4. Stage 2 will have only necessary and minor front-end modifications.

Xuanwo commented 2 years ago

However, to reduce the wait, I recommend only figuring out how to organize content in stage 2 . The front-end design can be deferred to stage 4. Stage 2 will have only necessary and minor front-end modifications.

Makes sense, updated the migration plan.

I move the plan from comment to PR description.

Xuanwo commented 2 years ago

@PsiACE rfcs and development belong to different folders, so it's a bit tricky to make rfcs also expand under development. How about re-organizing the content in stage 2? Maybe we can put rfcs under development?

Except this issue, all comments (in stage 1) are resolved.

I will catch up all docs changes if this PR is ready to go.

PsiACE commented 2 years ago

Maybe we can put rfcs under development?

We can do this first.

How about re-organizing the content in stage 2?

Of course, we need to reconsider how to arrange it at stage 2.

Xuanwo commented 2 years ago

We can do this first.

Done.

Xuanwo commented 2 years ago

This PR is synced with the latest commit at https://github.com/datafuselabs/databend/commit/9382849edf79f13e641c6f934dd2f61da2ff6d15 and finished all job defined in stage 1.

PTAL @PsiACE

mergify[bot] commented 2 years ago

This pull request has merge conflicts that must be resolved before it can be merged. @Xuanwo please rebase it 🙏

codecov-commenter commented 2 years ago

Codecov Report

Merging #3210 (9c3944c) into main (9382849) will not change coverage. The diff coverage is n/a.

:exclamation: Current head 9c3944c differs from pull request most recent head 8e9297a. Consider uploading reports for the commit 8e9297a to get more accurate results Impacted file tree graph

@@          Coverage Diff          @@
##            main   #3210   +/-   ##
=====================================
  Coverage     66%     66%           
=====================================
  Files        683     683           
  Lines      36387   36387           
=====================================
  Hits       24170   24170           
  Misses     12217   12217           
Impacted Files Coverage Δ
common/management/src/cluster/cluster_mgr.rs 78% <0%> (-1%) :arrow_down:
query/src/clusters/cluster.rs 54% <0%> (+<1%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 1b33ed9...8e9297a. Read the comment docs.

databend-bot commented 2 years ago

Wait for another reviewer approval

mergify[bot] commented 2 years ago

This pull request has merge conflicts that must be resolved before it can be merged. @Xuanwo please rebase it 🙏

databend-bot commented 2 years ago

Wait for another reviewer approval

mergify[bot] commented 2 years ago

This pull request has merge conflicts that must be resolved before it can be merged. @Xuanwo please rebase it 🙏

databend-bot commented 2 years ago

Wait for another reviewer approval

Xuanwo commented 2 years ago

@BohuTANG PTAL

BohuTANG commented 2 years ago

Myabe we should remove blog menu until we have blogs

databend-bot commented 2 years ago

Wait for another reviewer approval