Skip to content

Commit e5f9f8a

Browse files
committed
fix urls and prepare to renam the repo
1 parent 7fc9d7d commit e5f9f8a

File tree

9 files changed

+27
-27
lines changed

9 files changed

+27
-27
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Knot.x Fragments
22
This repository contains all modules that are the core of the Knot.x Fragments processing.
33

4-
[**Fragments**](https://github.com/Knotx/knotx-fragments-handler/tree/master/api#knotx-fragment-api)
4+
[**Fragments**](https://github.com/Knotx/knotx-fragments/tree/master/api#knotx-fragment-api)
55
are the result of breaking the request into smaller, independent parts by the
6-
[Fragments Supplier](https://github.com/Knotx/knotx-fragments-handler/tree/master/supplier)
6+
[Fragments Supplier](https://github.com/Knotx/knotx-fragments/tree/master/supplier)
77

8-
![Node with exits](https://github.com/Knotx/knotx-fragments-handler/raw/master/assets/images/case.png)
8+
![Node with exits](https://github.com/Knotx/knotx-fragments/raw/master/assets/images/case.png)
99

1010
## How does it work
1111

@@ -15,38 +15,38 @@ Each **Action** transforms the Fragment's content and/or updates its payload.
1515

1616
Fragment's path in the Task graph is defined by Action's output, called **Transition**.
1717

18-
<img src="https://github.com/Knotx/knotx-fragments-handler/raw/master/assets/images/graph_processing.png" width="700">
18+
<img src="https://github.com/Knotx/knotx-fragments/raw/master/assets/images/graph_processing.png" width="700">
1919

20-
You may read more about it in the [Handler API docs](https://github.com/Knotx/knotx-fragments-handler/tree/master/handler/api).
20+
You may read more about it in the [Handler API docs](https://github.com/Knotx/knotx-fragments/tree/master/handler/api).
2121

2222
---
2323

2424
**Action** is a simple function (business logic) with possible restrictions imposed. E.g. function execution
2525
can be limited to a certain amount of time. If it will not end in that time, Action times out.
2626
In that case, Action's output is **error Transition** and some **fallback Action** may be applied.
2727

28-
<img src="https://github.com/Knotx/knotx-fragments-handler/raw/master/assets/images/graph_processing_failure.png" width="500">
28+
<img src="https://github.com/Knotx/knotx-fragments/raw/master/assets/images/graph_processing_failure.png" width="500">
2929

3030
Additionally, **Actions** may be composed into a **Composed Structure** that will be executed in parallel when they
3131
are independent.
3232

3333
You may read more about actions restrictions and implementations of Actions delivered with this
34-
module in the [Handler Core docs](https://github.com/Knotx/knotx-fragments-handler/tree/master/handler/core)
34+
module in the [Handler Core docs](https://github.com/Knotx/knotx-fragments/tree/master/handler/core)
3535

3636
---
3737

3838
### Fragments Engine
3939
The diagram below depicts Fragments Engine logic (map-reduce).
4040

41-
![Node with exits](https://github.com/Knotx/knotx-fragments-handler/raw/master/assets/images/all_in_one_processing.png)
41+
![Node with exits](https://github.com/Knotx/knotx-fragments/raw/master/assets/images/all_in_one_processing.png)
4242

43-
Read more about it [here](https://github.com/Knotx/knotx-fragments-handler/tree/master/handler/engine).
43+
Read more about it [here](https://github.com/Knotx/knotx-fragments/tree/master/handler/engine).
4444

4545
---
4646

4747
### Fragments assembler
4848
Finally, after all the Fragments were processed, they are combined into a single response by the
49-
[Fragments Assembler](https://github.com/Knotx/knotx-fragments-handler/tree/master/assembler) handler.
49+
[Fragments Assembler](https://github.com/Knotx/knotx-fragments/tree/master/assembler) handler.
5050

5151
## License
5252
**Knot.x Fragments** is licensed under the [Apache License, Version 2.0 (the "License")](https://www.apache.org/licenses/LICENSE-2.0.txt)

assembler/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Knot.x Fragments Assembler
22
This module contains [Handler](https://vertx.io/docs/apidocs/io/vertx/core/Handler.html)
3-
that joins all [`Fragments`](https://github.com/Knotx/knotx-fragments-handler/tree/master/api) and
3+
that joins all [`Fragments`](https://github.com/Knotx/knotx-fragments/tree/master/api) and
44
saves the result into the [`ClientResponse`](https://github.com/Knotx/knotx-server-http/blob/master/api/docs/asciidoc/dataobjects.adoc#clientresponse) body.
55

66
## How does it work?

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
version=2.0.0-SNAPSHOT
2-
publication.scm=scm:git:git://github.com/Knotx/knotx-fragments-handler.git
2+
publication.scm=scm:git:git://github.com/Knotx/knotx-fragments.git

handler/api/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Fragments Handler API
22

33
## Action
4-
**Action** is a simple function that operates on a [Fragment](https://github.com/Knotx/knotx-fragments-handler/tree/master/api#knotx-fragment-api)
5-
(which is part of a [`FragmentContext`](https://github.com/Knotx/knotx-fragments-handler/blob/master/api/docs/asciidoc/dataobjects.adoc#FragmentContext)).
6-
The result of applying Action logic is the [`FragmentResult`](https://github.com/Knotx/knotx-fragments-handler/blob/master/api/docs/asciidoc/dataobjects.adoc#FragmentResult)
4+
**Action** is a simple function that operates on a [Fragment](https://github.com/Knotx/knotx-fragments/tree/master/api#knotx-fragment-api)
5+
(which is part of a [`FragmentContext`](https://github.com/Knotx/knotx-fragments/blob/master/handler/api/docs/asciidoc/dataobjects.adoc#FragmentContext)).
6+
The result of applying Action logic is the [`FragmentResult`](https://github.com/Knotx/knotx-fragments/blob/master/handler/api/docs/asciidoc/dataobjects.adoc#FragmentResult)
77
which contains the new Fragment and a Transition (which determines an edge in the processing graph).
88

99
In other words, you should understand applying an Action as performing the function:
@@ -15,4 +15,4 @@ In other words, you should understand applying an Action as performing the funct
1515
## Knot
1616
**Knot** is a scalable **Action** that is available on the [Vert.x Event Bus](https://vertx.io/docs/vertx-core/java/#event_bus).
1717

18-
Read more about the API Data Objects in the [Data Object docs](https://github.com/Knotx/knotx-fragments-handler/blob/master/api/docs/asciidoc/dataobjects.adoc).
18+
Read more about the API Data Objects in the [Data Object docs](https://github.com/Knotx/knotx-fragments/blob/master/handler/api/docs/asciidoc/dataobjects.adoc).

handler/core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ actions {
6767
}
6868
```
6969

70-
Read more about configuring fragment graph in the [Data Object docs](https://github.com/Knotx/knotx-fragments-handler/blob/master/core/docs/asciidoc/dataobjects.adoc).
70+
Read more about configuring fragment graph in the [Data Object docs](https://github.com/Knotx/knotx-fragments/blob/master/handler/core/docs/asciidoc/dataobjects.adoc).
7171

7272
## Actions
7373

handler/engine/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Fragments Engine
22
This module is a heart of the *Fragment Processing*. It actually does the work of independent
33
[**Fragments**](https://github.com/Knotx/knotx-fragments/tree/master/api) processing,
4-
by routing each *Fragment* throught the graph and applying [**Actions**](https://github.com/Knotx/knotx-fragments-handler/tree/master/api#action)
4+
by routing each *Fragment* throught the graph and applying [**Actions**](https://github.com/Knotx/knotx-fragments/tree/master/handler/api#action)
55
during that processing.
66

77
## Graph Engine
@@ -10,7 +10,7 @@ A **Task** specifies the nodes through which Fragments will be routed by the Gra
1010
Each Node may define possible *outgoing edges* - **Transitions**.
1111

1212
Additionally, a **Node** can do one of the following:
13-
- define an [**Action**](https://github.com/Knotx/knotx-fragments-handler/tree/master/api#action)
13+
- define an [**Action**](https://github.com/Knotx/knotx-fragments/tree/master/handler/api#action)
1414
that will be applied to *Fragment* (we call it **Action Node**),
1515
- consist of other **Nodes** (we call it **Composite Node**).
1616

@@ -58,23 +58,23 @@ The images below illustrates the above rules.
5858

5959
* *Node A* and *Node B* ends correctly:
6060

61-
![Node with exits](../assets/images/a_next_b.png)
61+
![Node with exits](assets/images/a_next_b.png)
6262

6363
* *Node A* raises an exception, *Node B* ends correctly
6464

65-
![Node with exits](../assets/images/a_error_c.png)
65+
![Node with exits](assets/images/a_error_c.png)
6666

6767
`FAILURE` states:
6868

6969
* *Node A* ends correctly and *Node B* raises exception:
7070

71-
![Node with exits](../assets/images/a_next_b_error.png)
71+
![Node with exits](assets/images/a_next_b_error.png)
7272

7373
* *Node A* and *Node C* raises exceptions:
7474

75-
![Node with exits](../assets/images/a_error_c_error.png)
75+
![Node with exits](assets/images/a_error_c_error.png)
7676

7777
A node can also declare its own exits (transitions) but then we need to configure them in a graph.
7878
Otherwise, if the custom transition is set but is not declared, then the `FAILURE` status is returned:
7979

80-
![Node with exits](../assets/images/a_custom.png)
80+
![Node with exits](assets/images/a_custom.png)

settings.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pluginManagement {
2222
}
2323
}
2424

25-
rootProject.name = "knotx-fragments-handler"
25+
rootProject.name = "knotx-fragments"
2626

2727
// API
2828
include("knotx-fragments-api")

supplier/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fragments Supplier
22
Suppliers are [**Handlers**](https://github.com/Knotx/knotx-server-http/tree/master/api#routing-handlers)
3-
that break the request into smaller pieces, called [**Fragments**](https://github.com/Knotx/knotx-fragments-handler/tree/master/api#knotx-fragment-api),
3+
that break the request into smaller pieces, called [**Fragments**](https://github.com/Knotx/knotx-fragments/tree/master/handler/api#knotx-fragment-api),
44
during the [HTTP Server request processing](https://github.com/Knotx/knotx-server-http#how-does-it-work).
55

66
You may read more about any of the implementations inside the module's `README.md` docs.

supplier/html-splitter/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Knot.x Splitter Handler
22
This module contains [Handler](https://vertx.io/docs/apidocs/io/vertx/core/Handler.html)
3-
implementation that splits a Template into [`Fragments`](https://github.com/Knotx/knotx-fragments-handler/tree/master/api).
3+
implementation that splits a Template into [`Fragments`](https://github.com/Knotx/knotx-fragments/tree/master/api).
44

55
Template is a document that will be later processed by Knot.x instance. Current implementation (`HtmlFragmentSplitter`)
66
supports splitting HTML markup, but Template could be any document like PDF file, Office file or even an image.

0 commit comments

Comments
 (0)