š Open source, privacy-first web analytics ā a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
project annotations
Blue Mouse40e4d6b5e6b9
diff --git a/docs/sitesettings/annotations.md b/docs/sitesettings/annotations.mdnew file mode 100644index 000000000..cb9565d66--- /dev/null+++ b/docs/sitesettings/annotations.md@@ -0,0 +1,58 @@+---+title: Annotations+slug: /annotations+---++import useBaseUrl from '@docusaurus/useBaseUrl';++Annotations allow you to mark specific dates on your analytics charts with notes. This is useful for tracking how real-world eventsālike a new marketing campaign, a product launch, or a server outageācorrelate with changes in your traffic or performance data.++### Creating an annotation++You can create an annotation directly from any time-series chart on your dashboard.++1. Navigate to your project's dashboard.+2. **Right-click** on the specific date point on the chart where you want to add a note.+3. Select **Add annotation** from the context menu.++<img alt="Chart context menu with Add Annotation option" src={useBaseUrl('img/sitesettings/annotation-create-modal.png')} />++A modal will appear where you can enter the details:++- **Date**: The date for the annotation (pre-filled based on where you clicked).+- **Note**: A short description of the event (max 120 characters).++Click **Save** to create the annotation.++> **Note:** Please avoid including sensitive personal information in annotations, as they may be visible to other team members with access to the project.++### Managing annotations++You can view, edit, and delete all annotations for a project from the settings page.++1. Go to your project settings.+2. Navigate to the **Annotations** tab.++Here you will see a list of all annotations created for this project, sorted by date.++<img alt="Annotations settings list" src={useBaseUrl('img/sitesettings/annotations-list.png')} />++#### Editing an annotation++To edit an existing annotation:++1. Find the annotation in the list.+2. Click the **Edit** (pencil) icon.+3. Update the date or text in the modal and click **Save**.++#### Deleting an annotation++To remove an annotation:++1. Find the annotation in the list.+2. Click the **Delete** (trash bin) icon.+3. Confirm the action in the dialog that appears.++### Permissions++Only project owners and administrators (managers) can create, edit, or delete annotations. View-only members will be able to see the annotations on the charts but cannot modify them.diff --git a/static/img/sitesettings/annotation-create-modal.png b/static/img/sitesettings/annotation-create-modal.pngnew file mode 100644index 000000000..30b5962feBinary files /dev/null and b/static/img/sitesettings/annotation-create-modal.png differdiff --git a/static/img/sitesettings/annotations-list.png b/static/img/sitesettings/annotations-list.pngnew file mode 100644index 000000000..7cf3f7d13Binary files /dev/null and b/static/img/sitesettings/annotations-list.png differ