summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-05-18 14:51:17 -0400
committerFrederic Guillot <fred@kanboard.net>2015-05-18 14:51:17 -0400
commitdb95e96f92a15660dc043eb033a0f7737b59a030 (patch)
treeef1f33667af8d8a57b018e5414873b53ccf27414 /docs
parentdde63e12fd13fb55bab79603b417401dde69902d (diff)
Add ical documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/ical.markdown49
-rw-r--r--docs/sharing-projects.markdown10
2 files changed, 56 insertions, 3 deletions
diff --git a/docs/ical.markdown b/docs/ical.markdown
new file mode 100644
index 00000000..cba2e020
--- /dev/null
+++ b/docs/ical.markdown
@@ -0,0 +1,49 @@
+Syncing your calendars
+======================
+
+Kanboard supports iCal feeds for projects and users.
+This feature allow you to import Kanboard tasks in almost any calendar program (by example Microsoft Outlook, Apple Calendar and Google Calendar).
+
+Calendar subscriptions are **read-only** access, you cannot create tasks from an external calendar software.
+The Calendar feed export follow the iCal standard.
+
+Project calendars
+-----------------
+
+- Each project have its own calendar.
+- The subscription link is unique per project, the link is activated when you enable the public access of your project: **Project settings > Public access**.
+- This calendar show only tasks for the selected project.
+
+User calendars
+--------------
+
+- Each user have its own calendar.
+- The subscription link is unique per user, the link is activated when you enable the public access of your user: **User profile > Public access**.
+- This calendar show tasks assigned to the user for all projects.
+
+Adding your Kanboard calendar to Apple Calendar
+-----------------------------------------------
+
+- Open Calendar
+- Select **File > New Calendar Subscription**
+- Copy and paste the iCal feed url from Kanboard
+
+![Add iCal subscription](http://kanboard.net/screenshots/documentation/apple-calendar-add-subscription.png)
+
+- You can choose to synchronize the calendar with iCloud to be available across all your devices
+- Don't forget to select the refresh frequency
+
+![Edit iCal subscription](http://kanboard.net/screenshots/documentation/apple-calendar-edit-subscription.png)
+
+Adding your Kanboard calendar to Google Calendar
+------------------------------------------------
+
+- Click the down-arrow next to **Other calendars**.
+- Select **Add by URL** from the menu.
+- Copy and paste the iCal feed url from Kanboard
+
+![Google Calendar](http://kanboard.net/screenshots/documentation/google-calendar-add-subscription.png)
+
+Your Kanboard calendar can also be available from your Android device if you enable the synchronization.
+
+Note: According to the Google Support, external calendars are not refreshed very often, [read the documentation](https://support.google.com/calendar/answer/37100?hl=en&ref_topic=1672445).
diff --git a/docs/sharing-projects.markdown b/docs/sharing-projects.markdown
index 8671bfd5..3e72071b 100644
--- a/docs/sharing-projects.markdown
+++ b/docs/sharing-projects.markdown
@@ -21,11 +21,15 @@ Select your project, then click on "Public access" and finally click on the butt
![Enable public access](http://kanboard.net/screenshots/documentation/project-enable-sharing.png)
-After that, you got the public link and the RSS feed.
-The activity feed is available only when the public access is activated.
+When the public access is enabled, a couple of links are generated:
+
+- Public board view
+- RSS feed subscription link
+- iCalendar subscription link
![Disable public access](http://kanboard.net/screenshots/documentation/project-disable-sharing.png)
You can also disable the public access whenever you want.
+
Each time, you enable or disable the public access a new random token is generated.
-The old link will not work anymore.
+The previous links will not work anymore.