You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by wi...@apache.org on 2020/04/15 07:31:55 UTC
[incubator-streampipes-website] branch dev updated: fixed typos and
broken links
This is an automated email from the ASF dual-hosted git repository.
wiener pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 4942ab8 fixed typos and broken links
4942ab8 is described below
commit 4942ab839a0a8cf7f3aa61f68fe0f9f010114cf1
Author: Patrick Wiener <wi...@fzi.de>
AuthorDate: Wed Apr 15 09:31:43 2020 +0200
fixed typos and broken links
---
README.md | 8 +++-----
documentation/docs/dev-guide-environment.md | 4 ++--
documentation/docs/dev-guide-event-model.md | 6 +++---
documentation/docs/dev-guide-tutorial-processors.md | 2 +-
.../version-0.55.2-pre-asf/dev-guide-tutorial-sources.md | 4 ++--
.../version-0.61.0-pre-asf/dev-guide-event-model.md | 6 +++---
.../version-0.61.0-pre-asf/dev-guide-tutorial-processors.md | 2 +-
.../version-0.61.0-pre-asf/dev-guide-tutorial-sources.md | 4 ++--
.../version-0.63.0-pre-asf/dev-guide-tutorial-processors.md | 2 +-
.../version-0.63.0-pre-asf/dev-guide-tutorial-sources.md | 4 ++--
.../version-0.64.0-pre-asf/dev-guide-tutorial-processors.md | 2 +-
.../version-0.64.0-pre-asf/dev-guide-tutorial-sources.md | 4 ++--
.../version-0.65.0-pre-asf/dev-guide-tutorial-processors.md | 2 +-
13 files changed, 24 insertions(+), 26 deletions(-)
diff --git a/README.md b/README.md
index e0b75d1..47429e9 100644
--- a/README.md
+++ b/README.md
@@ -15,19 +15,17 @@ Node.js and npm are required to build both sites.
* Run ``npm install`` from the root directory of this repository.
* Run ``npm run start-website`` to start the website locally for debugging purposes. The content will be served on port 9000.
-* Run ``npm run build-website`` to build the website. This will create a folder ``build`` that contains the generated static HTML and asset files.
+* Run ``npm run build-website`` to build the website. This will create a folder ``build`` that contains the generated static HTML and asset files.
## Build Documentation
* Run ``npm install`` from the ``documentation/website`` directory.
* Run ``npm run start`` to start the documentation for debugging purposes. The content will be served on ``http://localhost:3000/docs``
-* Run ``npm run build`` to build the documentation This weill create a folder ``build/streampipes-docs`` that includes all required static files.
-* Run ``npm run ds-version NEW_VERSION`` to release a new docs version.
+* Run ``npm run build`` to build the documentation This will create a folder ``build/streampipes-docs`` that includes all required static files.
+* Run ``npm run ds-version NEW_VERSION`` to release a new docs version.
## Deploy
* First, build the website as explained above.
* Then, build the documentation as explained above.
* Copy the content from the generated documentation (content from ``streampipes-docs``) to the ``build`` folder into a subdirectory named ``docs``.
-
-
diff --git a/documentation/docs/dev-guide-environment.md b/documentation/docs/dev-guide-environment.md
index cdf8105..5f2c9d6 100644
--- a/documentation/docs/dev-guide-environment.md
+++ b/documentation/docs/dev-guide-environment.md
@@ -23,7 +23,7 @@ Instead of starting from scratch, we recommend using our provided maven archetyp
### Maven archetypes
-Create the Maven archetype as described in the [Getting Started](dev-guide-archetype) guide.
+Create the Maven archetype as described in the [Getting Started](/docs/dev-guide-archetype) guide.
### Starting from scratch
@@ -109,4 +109,4 @@ The following three dependencies might be optional depending on the pipeline ele
* `streampipes-wrapper-standalone` should be used in case you plan to connect a new data processor or data sink that does not use an external processing engine. Events are directly processed in a single-host fashion.
-Finally, this dependency will provide abstract classes to define data sources and streams.
\ No newline at end of file
+Finally, this dependency will provide abstract classes to define data sources and streams.
diff --git a/documentation/docs/dev-guide-event-model.md b/documentation/docs/dev-guide-event-model.md
index cc4ade6..1134bdd 100644
--- a/documentation/docs/dev-guide-event-model.md
+++ b/documentation/docs/dev-guide-event-model.md
@@ -14,7 +14,7 @@ This guide assumes that you are already familiar with the basic setup of [data p
### Property Selectors
-In most cases, fields that are subject to be transformed by pipeline elements are provided by the assigned ``MappingProperty`` (see the guide on [static properties](dev-guide-static-properties.md).
+In most cases, fields that are subject to be transformed by pipeline elements are provided by the assigned ``MappingProperty`` (see the guide on [static properties](dev-guide-static-properties.md)).
Mapping properties return a ``PropertySelector`` that identifies a field based on (i) the **streamIndex** and (ii) the runtime name of the field.
Let's assume we have an event with the following structure:
@@ -136,6 +136,6 @@ Primitive fields can easily be added to an event by providing the runtime name a
// remove the field "temperature" from the event
event.removeFieldBySelector(temperatureSelector);
- // add a new field
+ // add a new field
event.addField("fahrenheit", 48);
-```
\ No newline at end of file
+```
diff --git a/documentation/docs/dev-guide-tutorial-processors.md b/documentation/docs/dev-guide-tutorial-processors.md
index b9161bc..e346368 100644
--- a/documentation/docs/dev-guide-tutorial-processors.md
+++ b/documentation/docs/dev-guide-tutorial-processors.md
@@ -253,7 +253,7 @@ This simple Pojo class will later serve to store user-defined parameters in a si
Now we go back to the controller class and extract these values from the invocation object.
-The ``ProessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
+The ``ProcessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows:
diff --git a/documentation/website/versioned_docs/version-0.55.2-pre-asf/dev-guide-tutorial-sources.md b/documentation/website/versioned_docs/version-0.55.2-pre-asf/dev-guide-tutorial-sources.md
index 3e4fe60..69d068a 100644
--- a/documentation/website/versioned_docs/version-0.55.2-pre-asf/dev-guide-tutorial-sources.md
+++ b/documentation/website/versioned_docs/version-0.55.2-pre-asf/dev-guide-tutorial-sources.md
@@ -77,7 +77,7 @@ public class VehiclePositionStream extends AbstractAlreadyExistingStream {
This class extends the class `AbstractAlreadyExistingStream`. This class indicates that we only want to describe an already existing stream (e.g., a stream that already sends data to an existing Kafka broker).
In contrast, if you'd plan to define a stream that produces data (e.g., simulates vehicle positions directly from this module), you could extend the class `AbstractAdapterIncludedStream`.
-No we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
+Now we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
```java
return DataStreamBuilder.create("vehicle-position", "Vehicle Position", "An event stream " +
"that produces current vehicle positions")
@@ -216,4 +216,4 @@ To install the just created element, open the StreamPipes UI and follow the manu
Congratulations! You've just created your first pipeline element for StreamPipes.
There are many more things to explore and data sources can be defined in much more detail.
-Follow our [SDK guide](dev-guide-source-sdk.md) to see what's possible!
\ No newline at end of file
+Follow our [SDK guide](dev-guide-source-sdk.md) to see what's possible!
diff --git a/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-event-model.md b/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-event-model.md
index dc5913f..7a20f0c 100644
--- a/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-event-model.md
+++ b/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-event-model.md
@@ -15,7 +15,7 @@ This guide assumes that you are already familiar with the basic setup of [data p
### Property Selectors
-In most cases, fields that are subject to be transformed by pipeline elements are provided by the assigned ``MappingProperty`` (see the guide on [static properties](dev-guide-static-properties.md).
+In most cases, fields that are subject to be transformed by pipeline elements are provided by the assigned ``MappingProperty`` (see the guide on [static properties](dev-guide-static-properties.md)).
Mapping properties return a ``PropertySelector`` that identifies a field based on (i) the **streamIndex** and (ii) the runtime name of the field.
Let's assume we have an event with the following structure:
@@ -137,6 +137,6 @@ Primitive fields can easily be added to an event by providing the runtime name a
// remove the field "temperature" from the event
event.removeFieldBySelector(temperatureSelector);
- // add a new field
+ // add a new field
event.addField("fahrenheit", 48);
-```
\ No newline at end of file
+```
diff --git a/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-processors.md b/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-processors.md
index 6ebb64b..b821c5a 100644
--- a/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-processors.md
+++ b/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-processors.md
@@ -257,7 +257,7 @@ This simple Pojo class will later serve to store user-defined parameters in a si
Now we go back to the controller class and extract these values from the invocation object.
-The ``ProessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
+The ``ProcessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows:
diff --git a/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-sources.md b/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-sources.md
index eb4ba15..cb011ea 100644
--- a/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-sources.md
+++ b/documentation/website/versioned_docs/version-0.61.0-pre-asf/dev-guide-tutorial-sources.md
@@ -95,7 +95,7 @@ public class MySourceStream extends AbstractAdapterIncludedStream {
This class extends the class ``AbstractAdapterIncludedStream``, which indicates that this source continuously produces data (configured in the ``executeStream()`` method.
In contrast, the class `AbstractAlreadyExistingStream` indicates that we only want to describe an already existing stream (e.g., a stream that already sends data to an existing Kafka broker).
-No we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
+Now we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
```java
return DataStreamBuilder.create("org.streampipes.tutorial.vehicle.position", "Vehicle Position", "An event stream " +
"that produces current vehicle positions")
@@ -280,4 +280,4 @@ To install the just created element, open the StreamPipes UI and follow the manu
Congratulations! You've just created your first pipeline element for StreamPipes.
There are many more things to explore and data sources can be defined in much more detail.
-Follow our [SDK guide](dev-guide-source-sdk) to see what's possible!
\ No newline at end of file
+Follow our [SDK guide](dev-guide-source-sdk) to see what's possible!
diff --git a/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-processors.md b/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-processors.md
index 52e7002..85ca51e 100644
--- a/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-processors.md
+++ b/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-processors.md
@@ -254,7 +254,7 @@ This simple Pojo class will later serve to store user-defined parameters in a si
Now we go back to the controller class and extract these values from the invocation object.
-The ``ProessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
+The ``ProcessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows:
diff --git a/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-sources.md b/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-sources.md
index 574ceb5..041a992 100644
--- a/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-sources.md
+++ b/documentation/website/versioned_docs/version-0.63.0-pre-asf/dev-guide-tutorial-sources.md
@@ -95,7 +95,7 @@ public class MySourceStream extends AbstractAdapterIncludedStream {
This class extends the class ``AbstractAdapterIncludedStream``, which indicates that this source continuously produces data (configured in the ``executeStream()`` method.
In contrast, the class `AbstractAlreadyExistingStream` indicates that we only want to describe an already existing stream (e.g., a stream that already sends data to an existing Kafka broker).
-No we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
+Now we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
```java
return DataStreamBuilder.create("org.streampipes.tutorial.vehicle.position", "Vehicle Position", "An event stream " +
"that produces current vehicle positions")
@@ -280,4 +280,4 @@ To install the just created element, open the StreamPipes UI and follow the manu
Congratulations! You've just created your first pipeline element for StreamPipes.
There are many more things to explore and data sources can be defined in much more detail.
-Follow our [SDK guide](dev-guide-source-sdk) to see what's possible!
\ No newline at end of file
+Follow our [SDK guide](dev-guide-source-sdk) to see what's possible!
diff --git a/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-processors.md b/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-processors.md
index 9349845..f1da468 100644
--- a/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-processors.md
+++ b/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-processors.md
@@ -265,7 +265,7 @@ This simple Pojo class will later serve to store user-defined parameters in a si
Now we go back to the controller class and extract these values from the invocation object.
-The ``ProessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
+The ``ProcessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows:
diff --git a/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-sources.md b/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-sources.md
index 795de8e..71f6b83 100644
--- a/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-sources.md
+++ b/documentation/website/versioned_docs/version-0.64.0-pre-asf/dev-guide-tutorial-sources.md
@@ -95,7 +95,7 @@ public class MySourceStream extends AbstractAdapterIncludedStream {
This class extends the class ``AbstractAdapterIncludedStream``, which indicates that this source continuously produces data (configured in the ``executeStream()`` method.
In contrast, the class `AbstractAlreadyExistingStream` indicates that we only want to describe an already existing stream (e.g., a stream that already sends data to an existing Kafka broker).
-No we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
+Now we will add the definition of the data stream. Add the following code inside of the `declareModel` method:
```java
return DataStreamBuilder.create("org.streampipes.tutorial.vehicle.position", "Vehicle Position", "An event stream " +
"that produces current vehicle positions")
@@ -280,4 +280,4 @@ To install the just created element, open the StreamPipes UI and follow the manu
Congratulations! You've just created your first pipeline element for StreamPipes.
There are many more things to explore and data sources can be defined in much more detail.
-Follow our [SDK guide](dev-guide-source-sdk) to see what's possible!
\ No newline at end of file
+Follow our [SDK guide](dev-guide-source-sdk) to see what's possible!
diff --git a/documentation/website/versioned_docs/version-0.65.0-pre-asf/dev-guide-tutorial-processors.md b/documentation/website/versioned_docs/version-0.65.0-pre-asf/dev-guide-tutorial-processors.md
index 007e119..baadd02 100644
--- a/documentation/website/versioned_docs/version-0.65.0-pre-asf/dev-guide-tutorial-processors.md
+++ b/documentation/website/versioned_docs/version-0.65.0-pre-asf/dev-guide-tutorial-processors.md
@@ -254,7 +254,7 @@ This simple Pojo class will later serve to store user-defined parameters in a si
Now we go back to the controller class and extract these values from the invocation object.
-The ``ProessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
+The ``ProcessingElementParameterExtractor`` provides convenience methods to extract the relevant information from the `DataProcessorInvocation` object.
Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows: