search

naimo84 / node-red-contrib-ical-events

Node-RED module to get events from a iCal Calender (Google e.g.), icloud or Caldav Server via kalender-events
MIT License
47 stars 11 forks source link

[QUESTION]: documentation is not up-to-date #145

Open stefan242 opened 1 year ago

stefan242 commented 1 year ago

I cannot edit https://naimo84.github.io/kalender-events/guide/upcoming.html or the other doc pages. The 'naimo84/kalender-events' repository doesn't contain the 'docs/guide/upcoming.md' path in 'main'.

"location" is missing in the list for "Filter property", when using a Trigger "Match" or "No Match".

"Cron" is described at the end instead between "Check every" and "trigger". Also you could write that any input (for example an "inject" node) does also trigger a new check.

For the "event trigger" node, there is no description that one output is fired when the event starts and the second output is fired when the events stops.

At least for CalDAV servers the Calendar field in all nodes should be left empty for the first time, so that all events from all calendars of the configured user are returned. The "calendarName" then contains the correct name for the desired (sub)-Calendar, that can be inserted in one of the Calender field to select only events from this particular calendar.

Please add more simple examples for Node-RED flows.

naimo84 commented 1 year ago

Hi @stefan242,

first of all many many thanks for the PayPal and the nice words😁

There is a separate branch for the docs ;) Because it's easier for the GHAction to watch and build the branch "docs", then the "main". I think so ;)

https://github.com/naimo84/kalender-events/tree/docs https://github.com/naimo84/kalender-events/blob/docs/docs/guide/upcoming.md

I would appreciate if you contribute via a PR. But I can also change the docs. The only problem is free time currently...

Greets, Benjamin