Skip to content

Commit c86e7b8

Browse files
committed
fix some typos
1 parent 75689b3 commit c86e7b8

File tree

3 files changed

+22
-24
lines changed

3 files changed

+22
-24
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ Makes frontend<->backend communication reactive and event-driven.
77
[![Build Status](https://travis-ci.org/Accenture/reactive-interaction-gateway.svg?branch=master)](https://travis-ci.org/Accenture/reactive-interaction-gateway)
88
[![DockerHub](https://img.shields.io/docker/pulls/accenture/reactive-interaction-gateway)](https://hub.docker.com/r/accenture/reactive-interaction-gateway)
99

10-
Take a look at the [documentation](https://accenture.github.io/reactive-interaction-gateway/docs/intro.html) and get in touch with us on [Slack](https://rig-slackin.herokuapp.com)!
11-
1210
## About
1311

1412
The Reactive Interaction Gateway (RIG) is the glue between your client (frontend) and your backend. It makes communication between them easier by (click the links to learn more)
@@ -22,7 +20,7 @@ The Reactive Interaction Gateway (RIG) is the glue between your client (frontend
2220

2321
Built on open standards, RIG is very easy to integrate – and easy to replace – which means low-cost, low-risk adoption. Unlike other solutions, RIG does not leak into your application – no libraries or SDKs required. Along with handling client requests and publishing events from backend to the frontend, RIG provides [many built-in features](https://accenture.github.io/reactive-interaction-gateway/docs/features.html#built-in-features).
2422

25-
Learn more by taking a look into the [documentation](https://accenture.github.io/reactive-interaction-gateway/docs/intro.html) and the [FAQ](https://accenture.github.io/reactive-interaction-gateway/docs/faq.html).
23+
This is just a basic summary of what RIG can do. There is a comprehensive documentation available on our [website](https://accenture.github.io/reactive-interaction-gateway/docs/intro.html). If you have any unanswered question, check out the [FAQ](https://accenture.github.io/reactive-interaction-gateway/docs/faq.html) section to get them answered.
2624

2725
## Getting Started
2826

docs/distributed-tracing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Distributed Tracing
66

77
RIG is able to process distributed tracing data following the [W3C Trace Contexts](https://www.w3.org/TR/trace-context/).
88

9-
In certain conditions RIG expects the trace context to be in the (HTTP) Header, and in other conditions in the event payload itself. With events, we always speak of cloudevents following the [distributed tracing extension](https://github.com/cloudevents/spec/blob/v1.0/extensions/distributed-tracing.md). There is one key rule when RIG expects the trace context either in the header or in the cloudevent:
9+
In certain conditions RIG expects the trace context to be in the (HTTP) header, and in other conditions in the event payload itself. With events, we always speak of cloudevents following the [distributed tracing extension](https://github.com/cloudevents/spec/blob/v1.0/extensions/distributed-tracing.md). There is one key rule when RIG expects the trace context either in the header or in the cloudevent:
1010

1111
1. if we talk of messages, then RIG expects the trace context to be in the (HTTP) header
1212
2. if we talk of events (cloudevents), then RIG expects the trace context to be in the cloudevent

docs/features.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ If requests are being sent synchronously, RIG acts as a reverse proxy: RIG forwa
3434

3535
![client-to-backend-synchronously](./assets/features-client-to-backend-synchronously.png)
3636

37-
You may ask: Why shouldn't I directly talk to the Backend? What benefits does RIG provide?
37+
You may ask: Why shouldn't I directly talk to the backend? What benefits does RIG provide?
3838

39-
Rig provides many additional features on top like session management or JWT signature verification. You don't have to implement this over and over again at the clients and backend services.
39+
RIG provides many additional features on top like session management or JWT signature verification. You don't have to implement this over and over again at the clients and backend services.
4040

4141
### Asynchronously - Fire&Forget
4242

@@ -52,7 +52,7 @@ RIG forwards the client request to the backend synchronously via HTTP and waits
5252

5353
![client-to-backend-synchronously-asynchronous-response](./assets/features-client-to-backend-synchronously-asynchronous-response.png)
5454

55-
This scenario can be quite useful which is described in more detail in the [Architecture section](https://accenture.github.io/reactive-interaction-gateway/docs/architecture.html#providing-a-synchronous-api-for-asynchronous-back-end-services). RIG correlates the corresponding answer using the correlation ID of the original request, that will be forwarded to the backend and also being used in the response of the backend. With this ID, RIG can filter the appropriate message from the consuming topic.
55+
This scenario can be quite useful which is described in more detail in the [Architecture section](https://accenture.github.io/reactive-interaction-gateway/docs/architecture.html#providing-a-synchronous-api-for-asynchronous-back-end-services). RIG correlates the corresponding answer using the correlation ID of the oRIGinal request, that will be forwarded to the backend and also being used in the response of the backend. With this ID, RIG can filter the appropriate message from the consuming topic.
5656

5757
As you can see in the architecture diagram, the backend service responds to RIG with `202 Accepted` to tell RIG that the response will be provided asynchronously.
5858

@@ -71,19 +71,19 @@ Essentially this is a combination of the [asynchronous - fire&forget approach](#
7171
Built on open standards, RIG is very easy to integrate – and easy to replace – which means low-cost, low-risk adoption. Unlike other solutions, RIG does not leak into your application – no libraries or SDKs required. Along with handling client requests and publishing events from backend to the frontend, RIG provides many built-in features such as:
7272

7373
- Easy to use and scalable by design:
74-
- Supports tens of thousands stable connections per node even on low-end machines.
75-
- Easy to add additional nodes.
76-
- Built on the battle-proven [Erlang/OTP](http://www.erlang.org/) distribution model.
77-
- Only uses in-memory data structures - no external dependencies to configure or scale.
74+
- Supports tens of thousands stable connections per node even on low-end machines
75+
- Easy to add additional nodes
76+
- Built on the battle-proven [Erlang/OTP](http://www.erlang.org/) distribution model
77+
- Only uses in-memory data structures - no external dependencies to configure or scale
7878
- Connect using standard protocols:
7979
- Firewall friendly and future proof using Server-Sent Events (SSE)
80-
- [HTML5 standard](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events).
81-
- Regular HTTP requests, so no issues with proxy servers or firewalls.
82-
- Connection multiplexing with HTTP/2 out of the box.
83-
- SSE implementation (browser) keeps track of connection drops and restores the connection automatically.
84-
- Polyfills available for older browsers.
85-
- WebSocket connections are supported, too.
86-
- HTTP long polling for situations where SSE and WS are not supported.
80+
- [HTML5 standard](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events)
81+
- Regular HTTP requests, so no issues with proxy servers or firewalls
82+
- Connection multiplexing with HTTP/2 out of the box
83+
- SSE implementation (browser) keeps track of connection drops and restores the connection automatically
84+
- Polyfills available for older browsers
85+
- WebSocket connections are supported, too
86+
- HTTP long polling for situations where SSE and WS are not supported
8787
- Publish events from various sources:
8888
- Kafka
8989
- NATS
@@ -93,9 +93,9 @@ Built on open standards, RIG is very easy to integrate – and easy to replace
9393
- produce to Kafka topic, optionally wait for the result on another Kafka topic
9494
- produce to a NATS topic, optionally using NATS request-response to wait for the result
9595
- produce to Amazon Kinesis
96-
- Uses the CNCF [CloudEvents specification](https://cloudevents.io/).
97-
- Takes care of client connection state so you don't have to.
98-
- Flexible event subscription model based on event types.
99-
- Use existing services for authentication and authorization of users and subscriptions.
100-
- JWT signature verification for APIs as a simple authentication check.
101-
- Session blacklist with immediate session invalidation.
96+
- Uses the CNCF [CloudEvents specification](https://cloudevents.io/)
97+
- Takes care of client connection state so you don't have to
98+
- Flexible event subscription model based on event types
99+
- Use existing services for authentication and authorization of users and subscriptions
100+
- JWT signature verification for APIs as a simple authentication check
101+
- Session blacklist with immediate session invalidation

0 commit comments

Comments
 (0)