Skip to content

Add calendar notification documentation #1306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add calendar notification documentation #1306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61cfbca
Add calendar notification documentation
magarnier Dec 7, 2023
e54c77d
Correct screenshot and CI
magarnier Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added languages/en/images/screenshots/tracker/administration/calendar-notif.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 14 additions & 1 deletion languages/en/user-guide/trackers/administration/configuration/notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,17 @@ This rely on Contributor/assignee semantic of the tracker.

In addition to the subject of the email, all the assignees are listed in the mail
body with ``=ASSIGNED_TO=<username>``. These markers are not visible but could be
used to create filters in your email client.
used to create filters in your email client.

Calendar Event
``````````````

You can choose to activate calendar event for your notifications.
If your tracker is configured with a timeframe semantic, a calendar event will be sent
Copy link
Member

@vaceletm vaceletm Dec 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a couple of edge case that we listed in the story (about the supported timeframe configuration, how datetime works, update of events) that should be listed.


.. figure:: ../../../../images/screenshots/tracker/administration/calendar-notif.png
Copy link
Member

@vaceletm vaceletm Dec 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image is not required here, however a link toward the user section (in order to see how it looks) would be welcomed.

:align: center
:alt: Calendar notification
:name: Calendar notification

Backlog: Calendar notification
12 changes: 12 additions & 0 deletions languages/en/user-guide/trackers/usage/notification.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,15 @@ access the artifact form on Tuleap.
:name: Notification by email

Notification by email

Calendar Notifications
----------------------

Caldendar notifications can be linked to artifacts, activation of this option must be done in `Tracker > Adminstration > Notification` settings
Copy link
Member

@vaceletm vaceletm Dec 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a link toward the configuration part to help users who are looking how to configure the feature


.. figure:: ../../../images/screenshots/tracker/administration/calendar-notif.png
:align: center
:alt: Tracker calendar notification
:name: Tracker calendar notification

Tracker: Calendar notification