You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2023/04/28 12:03:38 UTC

[plc4x] branch develop updated: chore(doc): Scraper small doc improvements (add maven dep, fix interval format, fix typo) (#917) [skip ci]

This is an automated email from the ASF dual-hosted git repository.

sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git


The following commit(s) were added to refs/heads/develop by this push:
     new 5cba298447 chore(doc): Scraper small doc improvements (add maven dep, fix interval format, fix typo) (#917) [skip ci]
5cba298447 is described below

commit 5cba2984478f9b93565c841348ea9909fe31d023
Author: kubo44 <po...@yahoo.com>
AuthorDate: Fri Apr 28 14:03:33 2023 +0200

    chore(doc): Scraper small doc improvements (add maven dep, fix interval format, fix typo) (#917) [skip ci]
    
    Co-authored-by: Roman Kubascik <ro...@sidion.de>
---
 src/site/asciidoc/users/tools/scraper.adoc | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/site/asciidoc/users/tools/scraper.adoc b/src/site/asciidoc/users/tools/scraper.adoc
index 9d85f9567b..db3f96c7ec 100644
--- a/src/site/asciidoc/users/tools/scraper.adoc
+++ b/src/site/asciidoc/users/tools/scraper.adoc
@@ -30,6 +30,14 @@ As we have encountered exactly the same problem for about every integration modu
 This tool automatically handles all of the tasks mentioned above.
 
 === Getting started with the `Scraper`
+The Scraper can be found in the Maven module
+```
+<dependency>
+  <groupId>org.apache.plc4x</groupId>
+  <artifactId>plc4j-scraper</artifactId>
+  <version>${current.version}</version>
+</dependency>
+```
 
 In general, you need 3 parts to work with the `Scraper`:
 
@@ -86,10 +94,10 @@ This creates a new `job` with a given name which is executed based on the inform
 
 As mentioned above, we currently only support a time-scheduled collection.
 
-This genrally just requires one parameter: The number of `milliseconds` between each collection.
+This generally requires just one parameter: The number of `milliseconds` between each collection.
 
 ----
-SCHEDULED:1000
+(SCHEDULED,1000)
 ----
 
 Above would schedule a collection every 1000ms - so once every second.
@@ -122,7 +130,7 @@ jobBuilder.build();
 
 This configures the finished job and attaches that to the overall `Scraper` configuration of the scraper configuration.
 
-As soon as we're done configuring jobs, we need to create the `Scraper` configuration by calling the `buiold` method on the `builder`:
+As soon as we're done configuring jobs, we need to create the `Scraper` configuration by calling the `build` method on the `builder`:
 
 ----
 ScraperConfigurationTriggeredImpl scraperConfig = builder.build();