Skip to content

Commit

Permalink
Delete obsolete excerpt separators
Browse files Browse the repository at this point in the history
  • Loading branch information
th0th committed Jan 26, 2025
1 parent 907f65a commit 3e771bf
Show file tree
Hide file tree
Showing 14 changed files with 1 addition and 29 deletions.
2 changes: 0 additions & 2 deletions frontend/src/docs/01_getting-started/01_foreword/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: Foreword

Welcome to the docs for **PoeticMetric**, a free as in freedom, open source, privacy-first, regulation-compliant, and blazingly fast alternative to Google Analytics!

<!-- end -->

PoeticMetric is **privacy-first**, **transparent**, **efficient** and **sustainable**. If you would like to read more about PoeticMetric's vision, you can check out its manifesto: [Building a Better Web: PoeticMetric's Vision](/manifesto).

This documentation is here to help you make the best use of PoeticMetric. If you think there is something missing, you can always reach out to us via [e-mail](mailto:[email protected]?subject=I%20can't%20find%20something%20on%20docs).
2 changes: 0 additions & 2 deletions frontend/src/docs/02_websites/01_introduction/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ title: Introduction

**PoeticMetric** allows you to track the performance of your website. It requires a javascript snippet to be added to the pages that will be tracked. This injected javascript snippets sends the required information to PoeticMetric's REST API when a visitor visits your website, and the collected data is processed and aggregated to generate the reports.

<!-- end -->

You can track unlimited number of websites, however, the number of page views (or events) you can use changes according to your subscription plan. See [pricing](/pricing) for details.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: Adding the script to your website

To start tracking your website's traffic, you need to update the HTML code of your website and add the PoeticMetric tracking script code to the header section. Put the script between the `<head>` and `</head>` tags.

<!-- end -->

<Alert variant="primary">
If you are not the person managing the website's code, and there is someone else who deals with it, you can share the link to this page.
</Alert>
Expand Down
2 changes: 0 additions & 2 deletions frontend/src/docs/02_websites/03_site-settings/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ title: Site settings
* [Safe query parameters](#safe-query-parameters)
* [Public reports](#public-reports)

<!-- end -->

![site settings](./site-settings.png "Site settings")

## Domain
Expand Down
2 changes: 0 additions & 2 deletions frontend/src/docs/02_websites/04_query-parameters/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: "Query parameters"

**Query parameters** (also known as "query string" or "URL parameters") are the part of the **URL** (uniform resource locator) that comes after the question mark **(?)**.

<!-- end -->

Query parameters consist of a key and a value, separated by an equal sign (=). And if there are multiple parameters, each is separated by an ampersand (&).

![query parameters in the address bar](./address-bar.jpg "Query parameters in the address bar")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: "Page view durations"

How much time a visitor spends on a page is one of the critical engagement metrics of website analytics. However, it is tricky to measure in an accurate and privacy-friendly manner.

<!-- end -->

## Google Analytics (and most of the other tools)

**Google Analytics** measures time spent on the page like this: Visitor lands on your website at a particular time. When this visitor navigates to another page on your site, Google Analytics considers all the time between these two events as the "time on page". ** This approach requires tracking the visitor by a unique identifier, IP address, or a cookie.** In addition to that, the evaluation by this method is inaccurate and inadequate, too. Consider these cases:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ title: "Excluding yourself from analytics"

By default, once you add PoeticMetric script on your website, PoeticMetric tracks every visitor. But you might want to exclude yourself and your team from affecting the statistics.

<!-- end -->

./
You might be familiar with this process and look for a way to ignore some IP addresses on the PoeticMetric interface. However, since we don't collect, encrypt or process IP addresses as a privacy feature, IP address filtering is not available on PoeticMetric. Instead, you will need to set a `localStorage` flag to let the tracker script know, and it will exclude you and stop event collection.

## tl;dr, to exclude yourself:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: "Google Search Console integration"

Google Search Console provides some Google related statistics about your website, like what people, who see your website in the search results, use as the search term, and how many of them actually click your site on the results.

<!-- end -->

HTTP (The Hypertext Transfer Protocol) has a specific way of handling the passing of the referrer information on [RFC 9110 - HTTP Semantics](https://httpwg.org/specs/rfc9110.html#field.referer). According to this specification, when a link is clicked, URL of the page which has the link is passed via the [`Referer`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer) header to the new page. However, since this behavior is [considered to cause undesirable consequences for user security and privacy](https://developer.mozilla.org/en-US/docs/Web/Security/Referer_header:_privacy_and_security_concerns), many sites including Google started handling referrers differently. That's why PoeticMetric can't see which search term your visitor used on Google, and need to use Google Search Console integration to obtain this data from Google.

![google search terms report details](./google-search-terms-report-details.png "Google search terms report details")
Expand Down
2 changes: 0 additions & 2 deletions frontend/src/docs/03_team/01_introduction/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: Introduction

**PoeticMetric** offers multiple team member accounts for the same organization account to ease collaboration with your colleagues.

<!-- end -->

## Inviting new members

You can invite your team by going to the [Team](/team) page, and clicking the **Invite new team member** button on top right. When you complete the form, an e-mail with a link will be sent to your teammate.
Expand Down
2 changes: 0 additions & 2 deletions frontend/src/docs/03_team/02_permissions/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ title: Permissions

The first team member, who signed up is set as the **organization owner**. Organization owner is indicated with a small lightning icon on their avatar in the team members list.

<!-- end -->

<img alt="owner" src="./owner.png" style="max-width: 400px" />

The organization owner is the only team member who can
Expand Down
2 changes: 0 additions & 2 deletions frontend/src/docs/03_team/03_avatars/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: Avatars

There are profile pictures displayed next to team members' name in various places. PoeticMetric uses [Gravatar](https://gravatar.com) for fetching people's avatars.

<!-- end -->

[Gravatar](https://gravatar.com) (**G**lobally **R**ecognized **Avatar**) is a free service provided by [Automattic](https://automattic.com) (the company behind the [WordPress](https://wordpress.org)).

So, if you want to use a custom profile picture on PoeticMetric, you can go to [Gravatar](https://gravatar.com), and set an avatar with the e-mail address you use on PoeticMetric there. Your profile picture on PoeticMetric will automatically be updated.
3 changes: 0 additions & 3 deletions frontend/src/docs/04_open-source/01_introduction/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ title: Introduction

Welcome to the "Open source" category in PoeticMetric Analytics documentation. In this section, we will explore the technical architecture and principles that make PoeticMetric Analytics a robust and transparent web analytics tool.

<!-- end -->

At PoeticMetric, we believe in the power of open source software and its ability to foster collaboration, security, and privacy. We are committed to providing a free as in freedom solution that empowers website owners to analyze their data while maintaining control over their information.

PoeticMetric Analytics is a fully free and open source software and all the PoeticMetric's source code is published on https://github.com/th0th/poeticmetric with the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html).


Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: Technical architecture

In this article, we will explore the technical software architecture that drives PoeticMetric Analytics, highlighting the core principles of transparency and openness that are at the heart of our platform. Built upon open source technologies, PoeticMetric Analytics is designed to provide website owners with a comprehensive and privacy-first web analytics solution. By understanding the underlying technical architecture, you gain insights into how your data is collected, processed, and stored, ensuring full transparency and control over your analytics experience. Let's dive into the details of PoeticMetric's software architecture and discover how open source empowers you to make informed decisions about your data.

<!-- end -->

## An overview of PoeticMetric's topology

![PoeticMetric's architecture](./topology.png)
Expand Down
2 changes: 0 additions & 2 deletions frontend/src/docs/04_open-source/03_self-hosting/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: Self-hosting

You can get your own PoeticMetric Analytics self-hosted website analytics instance up and running in minutes following this guide. It doesn't require any software development expertise, if you are a little tech-savvy you can do it. PoeticMetric is designed to be self-hosted with Docker, and ready-to-use Docker images are published publicly.

<!-- end -->

If you are curious, there is another documentation article that explains about the parts of PoeticMetric and how these parts communicate with each other. You can check the technical architecture documentation [here](/docs/open-source/technical-architecture).

## Requirements
Expand Down

0 comments on commit 3e771bf

Please sign in to comment.