apache / incubator-eventmesh-site Goto Github PK

View Code? Open in Web Editor NEW

21.0 16.0 39.0 103.88 MB

Apache EventMesh Website

Home Page: https://eventmesh.apache.org

License: Apache License 2.0

JavaScript 28.05% CSS 13.42% TypeScript 58.53%

incubator-eventmesh-site's Introduction

Apache EventMesh Website

Development

Clone and install dependencies:

git clone [email protected]: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

incubator-eventmesh-site's People

Contributors

Stargazers

Watchers

incubator-eventmesh-site's Issues

[Enhancement] Remove 'incubator' words from mailing list addresses

Page: https://eventmesh.apache.org/zh/community/contact/

[email protected] should be [email protected]

[Bug] Fix latest version and language for version archives

relevant pr: #108

1.9.0 is released however 1.8.0 is displayed by default
English documents are displayed in Chinese site (in current and latest version)

[Bug] Line endings of shell scripts are still CRLF and need conversion

Event Runtime 快速开始需要修改start.sh/stop.sh 为unix格式，否则在mac下报错无法直接执行

[Doc] Create the Connect sidebar for connector documents

[Doc] Add http connector doc

[Bug] queryWebHookConfigById endpoint causes NPE and returns empty response

Found in PR apache/eventmesh#4273

When inserting the config, the path contains manufacturerName, and the same logic applies when querying. Therefore, if we follow the request example in the documentation, it will result in an NPE (NullPointerException).

There are two possible solutions, with no impact on users. One way is to retrieve manufacturerName from callbackPath when making a query on our end. However, this would require specifying in the documentation that manufacturerName must be included in users' callbackPath, which doesn't seem like a common practice.

A simpler solution is to include manufacturerName in the request. Since there are likely no users for our webhook at the moment, I will go with the latter option.

[Doc] Add rabbitmq-connector documents

Add RabbitMQ-Connector documents

[Bug] Historical version docs doesn't have chinese version

The historical version is only available in English, without Chinese.

[Doc] Standardize component naming, Optimize Quick Start docs, Translate event-bridge doc

Optimize Runtime doc and Event Store docs
Unify 'LiteMessage' to 'EventMeshMessage'
Unify 'eventmesh-store' to 'Event Store'
Unify 'EventMesh Runtime' usage
Unify 'EventMesh' usage
Translate Event Bridge doc
Edit Homepage sub-title

[Enhancement] Remind the difference between 10105 and 10106 ports

[Feature] Transcribe Serverless Workflow Demo Runbook

According to the existing document (https://docs.qq.com/doc/DRFBPcmNyZHlOQ2Nq), transcribe them into Markdown and translate into English.

Another document, available at https://docs.qq.com/doc/DRGx5U25jWnZXQXpT, seems to have no immediate value for transcription.

[Doc] Add kafka connector doc

[Doc] Adjust the categories sequence of sidebar and optimize SDK docs

Adjust the 'Quick Start' category to the top of sidebar. (#132 (comment))
Translate and optimize SDK docs.

Fix Webhook connection not closing after processing

This is a synchronised modification of apache/eventmesh#4336.

In the screenshots of the webhook documentation, the tasks are also failing.

Fix "填写webhook信息" image duplicate references.

[Doc] Provide updated Runtime/Docker deployment and compilation docs

Related PR: apache/eventmesh#4675

[Doc] messed up document of lark connector

https://eventmesh.apache.org/docs/design-document/connect/lark-connector

Remove eventmesh-site Incubating key words

Remove eventmesh-site Incubating key words.e.g

Add new Committer

I'd like to add myself to the committer list.

Fix markdown formatting errors and duplicate content

[Enhancement] HTTP & GRPC docs should be split from TCP protocol doc

The http and grpc documents are included inside the tcp document, and the http and grpc documents should be split from the tcp document.

https://eventmesh.apache.org/zh/docs/design-document/event-handling-and-integration/runtime-protocol

[Enhancement] Refine and supplement the steps to enable CI for forked Repos

One more necessary step needed to enable CI for newly created repos.

[Bug] Broken link in EventMesh-Store & EventMesh-Store using Docker

The link in the docs that is supposed to re-direct me to EventMesh-Runtime in EventMesh-Store doesn't work.

The same applies for the link in EventMesh-Store using Docker.

Error:

Add release notes

[Bug] queryWebHookConfigByManufacturer endpoint causes NPE and unable to response

This is a synchronised modification of this PR: apache/eventmesh#4291

[Doc] Add Spring connector doc

[Bug] Docs's EventMesh Java SDK in Maven can not be find.

[Enhancement] Incubator logo footer should be updated

EventMesh is no longer in incubator. The footer should be updated:

Related file: src\components\Incubation.tsx. We need a front-end contributor to take this issue.

An example:

[Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect

(Related issue apache/eventmesh#4680. CC @VishalMCF.)

https://github.com/apache/eventmesh-site/blob/master/docs/instruction/03-runtime.md

Current EventMesh Connector is different from the initial EventMesh Connector, and it is a standalone service now. The initial EventMesh Connector was later changed to EventMesh Storage, but the relevant instructions in the documentation were not changed, resulting in users not knowing how to use Storage and Connector, and even attempting to use Storage or Connector in the wrong way.
For example:

The content of the file is the mapping from the plugin instance name to the plugin instance, see eventmesh-connector-rocketmq plugin module for details.

implementation project(":eventmesh-connectors:eventmesh-connector-rocketmq")

#connector plugin
eventMesh.connector.plugin.type=rocketmq

// Example: Load the RocketMQ plugin
implementation project(":eventmesh-connectors:eventmesh-connector-rocketmq")

Now eventmesh-connector-rocketmq as Connector, it does not run as a plugin, here they should be eventmesh-storage-rocketmq.

Additionally, all of the image paths in this document are incorrect. They should be /static/images/... instead of /images/... (Similar issue: #142 ).

[Enhancement] Keep 1.7.0 en and zh documents as they were

#135 The documents before 1.7.0 seem to be inaccurate, and some relative references to images are outdated.

[Fix] SPI doc connector example has become a storage-plugin

Please see #170 (comment).

RocketMQProducerImpl and org.apache.eventmesh.api.producer.Producer are now files in eventmesh-storage-rocketmq.

[Enhancement] Fix typos in Knative connector docs

view pages not exist in master branch

[Enhancement] Keep old version documents as they were

~~The Installation and deployment and SDK category should be in front of the Design documents category.~~ (completed in #152)
Older versions of the documentation should remain as they were in the Git repository at the time of each release.

[Doc] Add file connector doc

[Enhancement] Add updateWebHookConfig endpoint and optimize markdown doc

This is a subtask of GLCC Subject apache/eventmesh#4040.

Add Title

Add newlines for correct line feeds

Improving the import and usage methods of Checkstyle.

Currently, after importing the checkStyle.xml file, IntelliJ IDEA displays an error message in the bottom right corner stating "No header file found," which prevents new contributors from using the CheckStyle plugin.

To address this issue, I propose updating the contribution guidelines. This update should include step-by-step instructions on how to import the checkStyle.xml file in the plugin settings and how to enable the scanning in the Gradle options tab. This will ensure that new contributors can utilize the CheckStyle plugin seamlessly.

Fix merge errors caused by parallel development

#120 and #125 are two branches developed in parallel. Therefore, when merging, special handling is required. It's not sufficient to simply merge master into #125. Instead, a new branch should be created from master and the existing #125 branch should be merged into this new branch.

[Doc] Add ChatGPT connector doc

[Doc] Supplement HTTPS/(m)TLSv1.3 document for HTTP Admin Server

This issue is a document supplementation of Feat apache/eventmesh#4847.

Adjust the tab order in the sidebar of the release notes

eventmesh-operator needs documentation added.

Add new Committer mxsm

[Enhancement] Update Team members

Add v1.10.0 release doc

[Doc] Sync connetor documents from source modules

The documents of source/sink connectors can be synced to website for easier access of users.

Remind contributors to enable Actions in forked repo to ease the reviewers approving workflows

Currently, after EventMesh graduated from Incubator, all contributors who do not have write access to the repository need Maintainer approval for the CI to run after submitting a pull request. This has increased the workload for reviewers during the review process.

To address this issue, I propose adding an optional configuration to the contribution guidelines. This will kindly remind contributors to enable GitHub Actions in their forked repositories, allowing them to self-correct various errors and allowing reviewers to directly view the CI results on the right-hand side of commit message.