Google Git
Sign in
apache / incubator-seata-website / refs/heads/master
commita2c26570825a1b5bea66ce3cd0092b1bf7fba73d[log] [tgz]
authorfunky-eyes <funky-eyes@users.noreply.github.com>Wed Dec 27 09:24:51 2023 +0000
committerfunky-eyes <funky-eyes@users.noreply.github.com>Wed Dec 27 09:24:51 2023 +0000
tree463a9a8eabf344533d68ed8a3932a8ad8cd9d206
parent3014c3f9c60fe3cf5e7cc4302e7f8891ec3e1f15 [diff]
Automated deployment: Wed Dec 27 09:24:50 UTC 2023 759ecdc7671376e2525c1993334b6ae62321cf46
2 files changed
tree: 463a9a8eabf344533d68ed8a3932a8ad8cd9d206
  1. .github/
  2. blog/
  3. build/
  4. docs/
  5. en-us/
  6. img/
  7. md_json/
  8. saga_designer/
  9. schema/
  10. site_config/
  11. src/
  12. utils/
  13. zh-cn/
  14. .babelrc
  15. .docsite
  16. .eslintrc
  17. .gitignore
  18. .htaccess
  19. .nojekyll
  20. 404.html
  21. baidu_verify_VZ2B9aerrE.html
  22. chinaz_verify_F15FA76EB8413EC9.html
  23. CNAME
  24. docsite.config.yml
  25. gulpfile.js
  26. index.html
  27. package-lock.json
  28. package.json
  29. README.md
  30. redirect.ejs
  31. robots.txt
  32. s.yaml
  33. server
  34. site.txt
  35. sitemap.xml
  36. template.ejs
  37. webpack.config.js
README.md

Seata Official Website

CI Status

All website material of https://seata.io

Prerequisite

seata.github.io is powered by docsite.please read https://docsite.js.org If your version of docsite is less than 1.3.3, please upgrade to 1.3.3. Please also make sure your node version is 8.x, versions higher than 8.x is not supported by docsite yet.

Build instruction

  1. Run npm install docsite -g to install the dev tool.
  2. Run npm i in the root directory to install the dependencies.
  3. Run docsite start in the root directory to start a local server, you will see the website in ‘http://127.0.0.1:8080’.
  4. Run docsite build to build source code.
  5. Verify your change locally: python -m SimpleHTTPServer 8000, when your python version is 3 use :python3 -m http.server 8000 instead.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

  1. Follow the instructions to install nvm
  2. Run nvm install v8.16.0 to install node v8
  3. Run nvm use v8.16.0 to switch the working environment to node v8
  4. Run npm install docsite -g

Make sure npm and docsite are configured in the environmet configuration of os . eg: /etc/profile or .bash_profile of Macos

Then you are all set to run and build the website. Follow the build instruction above for the details.

How To Write Documents

Add a new doc

  1. Add new .md file under docs/en-us or docs/zh-cn. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
  2. Update site_config/docs.js, add a new entry to the blog in either en-us or zh-cn.
  3. Run docsite start locally to verify the blog can be displayed correctly.
  4. Send the pull request contains the .md and doc.js only.

Add a new article for developers

  1. Add new .md file under docs/en-us/developers or docs/zh-cn/developers, the file name should end up with _dev.md. Note that the suffix _dev is necessary.
  2. Update site_config/develop.js, add a new entry in either en-us or zh-cn.
  3. Run docsite start locally to verify the article can be displayed correctly.
  4. Send the pull request contains the *_dev.md and develop.js only.

Add a new blog

  1. Add new .md file under blog/en-us or blog/zh-cn. Corresponding to Chinese file and English file , and the Chinese and English file names should be consistent.
  2. Update site_config/blog.js, add a new entry to the blog in either en-us or zh-cn.
  3. Run docsite start locally to verify the blog can be displayed correctly.
  4. Send the pull request contains the .md and blog.js only.
  5. SEO config is required.

notice : Blog documents will be automatically sorted by time, without menu configuration
Set ‘hidden’ to ‘true’ for documents you don't want to display temporarily`

SEO

the type is :

---
hidden: false
title: title
keywords: keywords1,keywords2
description: some description
author: author name
date: 2018-12-29
---

Others