-
Notifications
You must be signed in to change notification settings - Fork 825
Description
This is a tracking issue of discussion in #3099
Originally posted by Xuanwo November 25, 2021
Our current website framework is mkdocs which is lacking blog support. So I propose to use docusaurus to build our website.
Docusaurus is maintained by Facebook Opensource, and is widely used (see showcase: https://docusaurus.io/showcase). It's easy to add a new module like blog
and so on. Also, it has built-in multi-version support, i18n support. And we can extend it via writing a new React module.
More, maybe we can apply for vercel open-source sponsor so that we can deploy on vercel instead of github pages. After that, we can remove the gh-pages
branch and the github pages
workflow, we can have a PR preview of our website to avoid broken changes.
Roadmap
For now, I think there should be three stages:
Current Stage: 2
Stage 1
Stage before #3210 gets merged.
At stage 1, we need to:
- Fix markdown format
- Fix social media and resource links (as @PsiACE said)
- Figure out how to use docusaurus and add them into docs.
- Catch up all changes to current docs (heavy work here)
Stage 2
#3210 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.
- People will still see the site built by MkDocs hosted at
gh-pages
- All changes to docs will not show up until we get into next stage.
At stage 2, we need to:
- Mirror the current design. feat: add home page and other plugins #3443
- website: Content reorganize #3275
- Figure out how to deploy the site
- Only build PR preview while files under
/website
changed (implemented via vercel builtin features) - docs: Generate index for category #3585
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:
- Have a front-end design (as @BohuTANG said)
- Write the first blog (maybe?)
Preview
Take https://databend.vercel.app/ for preview.