Google Git
Sign in
apache / eventmesh-site / 1a39f08cdf005beeba00b2143a01faf142039a9d
commit1a39f08cdf005beeba00b2143a01faf142039a9d[log] [tgz]
authorPil0tXia <41445332+Pil0tXia@users.noreply.github.com>Sun Dec 17 18:00:45 2023 +0800
committerGitHub <noreply@github.com>Sun Dec 17 18:00:45 2023 +0800
treecc87e1df01af0fc3681c3e272266a88c13404ac9
parent5f1a7e58fd6309048d22a63c5650af446aa9f640 [diff]
[ISSUE #153] Standardize component naming, Optimize Quick Start docs, Translate event-bridge doc (#154)

* Optimize Runtime doc

* Unify 'LiteMessage' to 'EventMeshMessage'

* Unify 'EventMesh Runtime'

* Unify 'EventMesh' part1

* Correct CN/EN punctuation marks and format with AutoCorrect

* Unify 'Event Store'

* Translate Event Bridge doc

* Optimize Event Store docs

* Translate Homepage sub-title correctly

* Additional pangu formating EN

* Update SDK dependency version

* Additional pangu formating CN and fix 'schema registry' references

* Unify 'EventMesh' part2

* Append: Optimize lark doc
44 files changed
tree: cc87e1df01af0fc3681c3e272266a88c13404ac9
  1. .github/
  2. blog/
  3. community/
  4. docs/
  5. events/
  6. i18n/
  7. scripts/
  8. sidebars/
  9. src/
  10. static/
  11. versioned_docs/
  12. versioned_sidebars/
  13. .asf.yaml
  14. .eslintrc.js
  15. .gitignore
  16. babel.config.js
  17. doap_EventMesh.rdf
  18. docusaurus.config.js
  19. eventmesh-multi-runtime.drawio
  20. LICENCE
  21. package-lock.json
  22. package.json
  23. README.md
  24. tsconfig.json
  25. versions.json
README.md

Apache EventMesh Website

Development

Clone and install dependencies:

git clone git@github.com:apache/eventmesh-site.git
cd eventmesh-site

npm install

Preview the website in development mode:

# Start the website with English documentations
npm run start -- --locale en

# Start the website with Chinese documentations
npm run start -- --locale zh

Build and view the website:

npm run build

npm run serve

Sync Documentation from apache/eventmesh

The npm run fetch script (scripts/fetch.ts) clones the apache/eventmesh repository and copies the documentations to docs and i18n/zh/docusaurus-plugin-content-docs. To update the documentation, please create a pull request in the apache/eventmesh repository.

npm run fetch

npm run start -- --locale en