Hi all,
I want to raise up the question where to store the previous created
https://github.com/apache/incubator-streampipes-extensions/pull/9
I checked out already
https://github.com/apache/incubator-streampipes-website.git but now my
question where to place the future Geo-component how-to chapters, setup
Intellij project and git workflow for contribution.
Greetings
Florian
II have built the documentation alreay
--
Disy Informationssysteme GmbH
Florian Micklich
Lösungsentwickler
+49 721 16006 477, [email protected]
Firmensitz: Ludwig-Erhard-Allee 6, 76131 Karlsruhe
Registergericht: Amtsgericht Mannheim, HRB 107964
Geschäftsführer: Claus Hofmann
Bitte beachten Sie folgende Informationen für Kunden, Lieferanten und Bewerber
- Datenschutz: www.disy.net/datenschutz
- Informationspflichten: www.disy.net/informationspflichten
Am 18.02.20 um 09:57 schrieb Patrick Wiener:
Hi,
@Florian: cheers for your contrib and really cool processors :)
I would not recommend putting this in a single component description. IMHO the
documentation of a processor should be
as accurate as necessary, not as accurate as possible such that a user can
quickly decide for what kinds of analyses
they can leverage this certain processor.
Other than that, I quite like the idea of Philipp, putting your work and
lessons learned regarding geo data etc. in a little blog post.
This def gonna help others in the community even more, as compared to putting
it in a single processor doc.
Patrick
Am 17.02.2020 um 12:11 schrieb Philipp Zehnder <[email protected]>:
Hi Dominik,
yes I agree the documentation of functionality for individual processors should
be included in the documentation.md file.
But Florian provided a description how to work with geo data and gave a great
introduction (with images) on how to use the different components, from
connecting a source to applying the algorithms.
And I am not sure if we should put this to the documentation of a single
component. So what do you think?
Philipp
On 16. Feb 2020, at 23:04, Dominik Riemer <[email protected]> wrote:
Hi,
@Florian: very cool, thanks a lot for your PR!
@Philipp, regarding your question on where to keep the documentation of pipeline elements, a
good way is to populate the documentation.md of the pipeline element in the asset folder. When
doing this, the documentation is available in the code repo, but also visible in the pipeline
editor (if you select "show documentation" in the customize dialog) and I've also
written a small maven plugin which extracts the documentation from the code and generates the
appropriate HTML markup for the online documentation
(https://streampipes.apache.org/docs/docs/pipeline-elements/
<https://streampipes.apache.org/docs/docs/pipeline-elements/>).
And I've just realized that the documentation is not working on the web page -
I think this got broken during the transition of the homepage.
Dominik
-----Original Message-----
From: Philipp Zehnder <[email protected] <mailto:[email protected]>>
Sent: Sunday, February 16, 2020 10:09 PM
To: [email protected] <mailto:[email protected]>
Subject: Re: Setup dev project in Intelij
Hi Florian,
sorry for the late reply.
Very cool, I tested your processors and they worked as expected and I will
merge them directly.
Just one minor comment. Please try to avoid logging raw events to the console.
This makes it harder to find errors and exceptions in the logs when the service
runs in a docker container.
For domain properties (semantic types) of the latitude and longitude values in
wgs84 you can use Geo.lat / Geo.lng [0].
If you add this to the requiredPropertyWithUnaryMapping the properties are then
already pre-selected.
Regarding your question in the other mail about the env file in the module
streampipes-processors-geo-jvm:
Each module should contain an env file for development to reduce the
configuration effort for other developers. But I saw you already committed it
in your pull request.
Your step by step guide in this email is very good, this would also be helpful
for other developers.
My suggestion would be to add it to our developer documentation [1]: How to run
processors in the project incubator-streampipes-extensions in IntelliJ What do
you think?
Regarding your second pull request: The documentation you provided [2] is
awesome.
My question to the other members of the community would be, where would we best
keep this documentation?
* Wiki
* Documentation
* directly in the project
* somewhere else
Maybe you could also write a short blogpost containing your descriptions? This
might be a good getting started for new users.
Thanks again for your contribution, I really look forward to all the geo
processors.
Cheers,
Philipp
[0]
https://github.com/apache/incubator-streampipes/blob/dev/streampipes-vocabulary/src/main/java/org/apache/streampipes/vocabulary/Geo.java
<https://github.com/apache/incubator-streampipes/blob/dev/streampipes-vocabulary/src/main/java/org/apache/streampipes/vocabulary/Geo.java>
<https://github.com/apache/incubator-streampipes/blob/dev/streampipes-vocabulary/src/main/java/org/apache/streampipes/vocabulary/Geo.java
<https://github.com/apache/incubator-streampipes/blob/dev/streampipes-vocabulary/src/main/java/org/apache/streampipes/vocabulary/Geo.java>>
[1] https://streampipes.apache.org/docs/docs/dev-guide-introduction/
<https://streampipes.apache.org/docs/docs/dev-guide-introduction/>
<https://streampipes.apache.org/docs/docs/dev-guide-introduction/
<https://streampipes.apache.org/docs/docs/dev-guide-introduction/>>
[2] https://github.com/giviflo/incubator-streampipes-extensions/tree/feature/geo_jts_doc
<https://github.com/giviflo/incubator-streampipes-extensions/tree/feature/geo_jts_doc>
<https://github.com/giviflo/incubator-streampipes-extensions/tree/feature/geo_jts_doc
<https://github.com/giviflo/incubator-streampipes-extensions/tree/feature/geo_jts_doc>>
On 2020/02/11 20:39:24, Florian Micklich <[email protected]> wrote:
Hi Philipp,>
the incompatible pom settings didn't give me any rest this evening and
I found probably the reason why.>
In the first attempt I just used "open" in Intellij to load the the
"/incubator-streampipes-extensions/streampipes-processors-geo-jvm"
project path.>
Tonight I used "import project" option in Intellij and followed the
instruction steps:>
++ Select maven project where the pom file exists -->
++ /incubator-streampipes-extensions/streampipes-processors-geo-jvm to
++ impo>
++ import project from external model --> maven>
++ import project setup --> left all default settings as it is>
++ select profile --> java8-doclint-disable in my case (don't know
++ what this means)>
++ select maven project to import -->
++ org.apache.streampipes:streampipes-processors-geo-jvm:065.1-SNAPSHO
++ T>
++ SELECT SDK --> 1.8 (in my case sdkman/candidates/java/8.0.232-zulu>
++ left project name and file location at it is>
++ .idea folder already exists. Overwrite --> yes>
==> sources will be loaded and almost all sources are available.>
Only following source couldn't be found:>
<parent>>
<artifactId>streampipes-extensions</artifactId>>
<groupId>org.apache.streampipes</groupId>>
<version>0.65.1-SNAPSHOT</version>>
</parent>>
I copied my local env file into the develop folder. Run the ./sp start
command in the installer folder and everything is running quite
charming without any problems.>
So I would say I close the push request and start a new one after
adding my existing work. So everything is nice and clean.>
Should I also add my local env file to the commit or what is
recommended?>
Greetings>
Florian>
Disy Informationssysteme GmbH>
Florian Micklich>
Lösungsentwickler>
+49 721 16006 477, [email protected]>
Firmensitz: Ludwig-Erhard-Allee 6, 76131 Karlsruhe>
Registergericht: Amtsgericht Mannheim, HRB 107964>
Geschäftsführer: Claus Hofmann>
Bitte beachten Sie folgende Informationen für Kunden, Lieferanten und
Bewerber>
- Datenschutz: www.disy.net/datenschutz>
- Informationspflichten: www.disy.net/informationspflichten>
