Skip to content

Commit

Permalink
updated links
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderkirtzel committed Dec 5, 2024
1 parent 1fdb912 commit c743087
Show file tree
Hide file tree
Showing 32 changed files with 107 additions and 108 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ whole data collection.
### Pre-requisites

Familiarize yourself with the
[walkerOS event model](https://www.elbwalker.com/docs/walkeros/event-model) and,
[walkerOS event model](https://www.elbwalker.com/docs/getting_started/event-model) and,
learn
[how walkerOS operates](https://www.elbwalker.com/docs/#how-walkeros-operates)
explore a complete
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ functioning in tandem with walkerOS sources.
processing.

> Explore
> [Node Destinations](https://www.elbwalker.com/docs/destinations/node/)
> [Node Destinations](https://www.elbwalker.com/docs/destinations/)
- **Web Destinations**: Tailored for client-side implementations, these
destinations excel in real-time tracking and user interaction analytics within
web applications.

> Discover
> [Web Destinations](https://www.elbwalker.com/docs/destinations/web/)
> [Web Destinations](https://www.elbwalker.com/docs/destinations/)
walkerOS Destinations ensures that your data journey, from collection to
activation is seamless, reliable, and efficient.
2 changes: 1 addition & 1 deletion packages/destinations/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Node destinations streamline your data workflow, enabling efficient and secure
data movement from your server to desired tools.

> Discover more about Node Destinations in the
> [Node Destinations documentation](https://www.elbwalker.com/docs/destinations/node/)
> [Node Destinations documentation](https://www.elbwalker.com/docs/destinations/)
2 changes: 1 addition & 1 deletion packages/destinations/node/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ for details.
## More Information

For more detailed information and examples, please refer to the
[documentation](https://www.elbwalker.com/docs/destinations/node/aws).
[documentation](https://www.elbwalker.com/docs/destinations/aws).
2 changes: 1 addition & 1 deletion packages/destinations/node/etag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/node/etag).
[documentation](https://www.elbwalker.com/docs/destinations/etag).

TBD
2 changes: 1 addition & 1 deletion packages/destinations/node/meta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/node/meta).
[documentation](https://www.elbwalker.com/docs/destinations/meta).

## 🤓 Usage

Expand Down
2 changes: 1 addition & 1 deletion packages/destinations/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Web destinations ensure your front-end data is efficiently utilized for
insightful analytics and targeted marketing efforts.

> Learn more about Web Destinations in the
> [Web Destinations documentation](https://www.elbwalker.com/docs/destinations/web/)
> [Web Destinations documentation](https://www.elbwalker.com/docs/destinations/)
4 changes: 2 additions & 2 deletions packages/destinations/web/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/api).
[documentation](https://www.elbwalker.com/docs/destinations/api).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailled
[API configuration](https://www.elbwalker.com/docs/destinations/web/api#configuration).
[API configuration](https://www.elbwalker.com/docs/destinations/api#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/etag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/etag).
[documentation](https://www.elbwalker.com/docs/destinations/etag).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailed
[etag configuration](https://www.elbwalker.com/docs/destinations/web/etag#configuration).
[etag configuration](https://www.elbwalker.com/docs/destinations/etag#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/google-ads/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/google-ads).
[documentation](https://www.elbwalker.com/docs/destinations/google-ads).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailled
[Google Ads configuration](https://www.elbwalker.com/docs/destinations/web/google-ads#configuration).
[Google Ads configuration](https://www.elbwalker.com/docs/destinations/google-ads#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/google-ga4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/google-ga4).
[documentation](https://www.elbwalker.com/docs/destinations/google-ga4).

## 🤓 Usage

Expand All @@ -16,7 +16,7 @@ Destinations can be used via node or directly in the browser.

Learn more about [destinations](https://www.elbwalker.com/docs/destinations/) in
general and read the detailled
[Google GA4 configuration](https://www.elbwalker.com/docs/destinations/web/ga4#configuration).
[Google GA4 configuration](https://www.elbwalker.com/docs/destinations/ga4#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/google-gtm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/google-gtm).
[documentation](https://www.elbwalker.com/docs/destinations/google-gtm).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailled
[Google Tag Manager configuration](https://www.elbwalker.com/docs/destinations/web/google-gtm#configuration).
[Google Tag Manager configuration](https://www.elbwalker.com/docs/destinations/google-gtm#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/meta-pixel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/meta-pixel).
[documentation](https://www.elbwalker.com/docs/destinations/meta-pixel).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailed
[Meta Pixel configuration](https://www.elbwalker.com/docs/destinations/web/meta-pixel#configuration).
[Meta Pixel configuration](https://www.elbwalker.com/docs/destinations/meta-pixel#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/piwikpro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/piwikpro).
[documentation](https://www.elbwalker.com/docs/destinations/piwikpro).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailled
[Piwik PRO configuration](https://www.elbwalker.com/docs/destinations/web/piwikpro#configuration).
[Piwik PRO configuration](https://www.elbwalker.com/docs/destinations/piwikpro#configuration).

```js
const config = {
Expand Down
4 changes: 2 additions & 2 deletions packages/destinations/web/plausible/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Made to be used with
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
[documentation](https://www.elbwalker.com/docs/destinations/web/plausible).
[documentation](https://www.elbwalker.com/docs/destinations/plausible).

## 🤓 Usage

Expand All @@ -17,7 +17,7 @@ Destinations can be used via node or directly in the browser.
Learn more about the
[destinations](https://www.elbwalker.com/docs/destinations/) in general and read
the detailled
[Plausible Analytics configuration](https://www.elbwalker.com/docs/destinations/web/plausible#configuration).
[Plausible Analytics configuration](https://www.elbwalker.com/docs/destinations/plausible#configuration).

```js
const config = {
Expand Down
10 changes: 5 additions & 5 deletions packages/sources/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ infrastructure, facilitating:
- **Event Validation**: Validates and ensures data quality and integrity.
- **Data Processing**: Processes and enriches events before they are sent to
destinations.
- **Consent Management**: Manages and respects user consent, which is crucial for privacy
compliance.
- **Consent Management**: Manages and respects user consent, which is crucial
for privacy compliance.

> Learn more in the
> [Node Source documentation](https://www.elbwalker.com/docs/sources/node/)
A **previous step** is understanding the
[walkerOS event model](https://www.elbwalker.com/docs/walkeros/event-model/).
[walkerOS event model](https://www.elbwalker.com/docs/getting_started/event-model/).

The **next step** is integrating these processed events with
[Node Destinations](https://www.elbwalker.com/docs/destinations/node/) for
actionable insights.
[Node Destinations](https://www.elbwalker.com/docs/destinations/) for actionable
insights.
4 changes: 2 additions & 2 deletions packages/sources/walkerjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ ensuring:
> [walker.js documentation](https://www.elbwalker.com/docs/sources/walkerjs/)
A **previous step** is understanding the
[walkerOS event model](https://www.elbwalker.com/docs/walkeros/event-model/) and
[walkerOS event model](https://www.elbwalker.com/docs/getting_started/event-model/) and
the [tagging](https://www.elbwalker.com/docs/sources/walkerjs/tagging/) of a
webpage.

The **next step** in the data journey is to forward these events to
[Web Destinations](https://www.elbwalker.com/docs/destinations/web/) for further
[Web Destinations](https://www.elbwalker.com/docs/destinations/) for further
processing and analysis.
5 changes: 2 additions & 3 deletions website/blog/2022-12-15-release-v1.6/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Dealing with timeouts or non-understandable entanglements is no longer

necessary. Walker.js handles the race conditions and is able to also load
external resources in the best possible way. Read more about
[consent management](/docs/guides/consent_management) in the docs.
[consent management](/docs/consent_management/overview) in the docs.

### Support for single-page-applications and dynamic content

Expand All @@ -60,8 +60,7 @@ second parameter is handling this now.
elb('walker init', document.getElementById('dynamic_content'));
```

Find out more about new
[commands](/docs/sources/walkerjs/commands#initialization) in the docs
Find out more about new [commands](/docs/sources/walkerjs/commands) in the docs

### Reduced file size and tests for code quality

Expand Down
15 changes: 7 additions & 8 deletions website/docs/consent_management/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ import Link from '@docusaurus/Link';

## consent

Typically, a
[Consent Management Platform (CMP)](#consent-management-platforms-cmps) handles
the consent. This is an asynchronous process. The CMP has to be loaded, a user
has to make a choice, and/or the state has to be updated.
Typically, a Consent Management Platform (CMP) handles the consent. This is an
asynchronous process. The CMP has to be loaded, a user has to make a choice,
and/or the state has to be updated.

To set/update the consent state, the CMP should actively push the
`consent command` with a group or an individual tool's permission state
Expand All @@ -34,10 +33,10 @@ destinations as well as new ones.

With each event, the consent states get checked. Every event will be added to an
ordered queue if consent isn't granted yet and the
[destination's queue](/docs/destinations/#configuration) isn't disabled. The
queue resets with each `walker run` command. And will be (re-)processed with
each `walker consent` update. The key must match the key used in each
`destination.config.consent`.
[destination's queue](/docs/destinations/configuration#overview-of-all-properties)
isn't disabled. The queue resets with each `walker run` command. And will be
(re-)processed with each `walker consent` update. The key must match the key
used in each `destination.config.consent`.

:::note

Expand Down
10 changes: 7 additions & 3 deletions website/docs/consent_management/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ respected.

## Features

- Manage consent with the [walker consent](#command) command
- Start the walker only [on available consent](#on-consent)
- Require [consent for destination](#destinations) individually
- Manage consent with the [walker consent](/docs/consent_management/commands)
command
- Start the walker only
[on available consent](/docs/consent_management/commands#on-consent)
- Require
[consent for destination](/docs/consent_management/commands#destinations)
individually
- Detect [sessions based on consent](/docs/utils/session#consent) state

:::warning
Expand Down
19 changes: 10 additions & 9 deletions website/docs/destinations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,17 @@ new tools.
## How it works

Destinations are added to a source
(see&nbsp;<Link to="/docs/sources/walkerjs/commands#destinations">walker.js</Link>
or&nbsp;<Link to="/docs/sources/node/commands#destinations">node</Link>). Before
(see&nbsp;<Link to="/docs/sources/walkerjs/commands#destination">walker.js</Link>
or&nbsp;<Link to="/docs/sources/node/commands#destination">node</Link>). Before
receiving events from the source, the proper consent states are checked each
time automatically. Destinations receive events through the [`push`](#push)
interface. Each destination can have its own configuration, which is set up in
the [`config`](#configuration) object. This configuration includes general
settings for the destination and individual event settings. The optional
[`init`](#init) function in a destination gets called before actually pushing
events. This function must return `true` upon successful initialization for the
events to be processed.
time automatically. Destinations receive events through the
[`push`](/docs/destinations/configuration#push) interface. Each destination can
have its own configuration, which is set up in the
[`config`](/docs/destinations/configuration#example) object. This configuration
includes general settings for the destination and individual event settings. The
optional [`init`](/docs/destinations/configuration#init) function in a
destination gets called before actually pushing events. This function must
return `true` upon successful initialization for the events to be processed.

```mermaid
---
Expand Down
4 changes: 2 additions & 2 deletions website/docs/getting_started/quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ to send it.
## Prerequisities

Before you start, read about
the&nbsp;<Link to="/docs/walkeros/event-model">event model</Link>
the&nbsp;<Link to="/docs/getting_started/event-model">event model</Link>
and&nbsp;<Link to="/docs/user_stitching">user stichting</Link>, especially if
you want to work with walkerOS raw data.

Expand All @@ -52,7 +52,7 @@ most common next steps after the intial setup:
- Implement&nbsp;<Link to="/docs/consent_management/overview/">consent
mangement</Link>
- Enhance your data collection and use your
first&nbsp;<Link to="/docs/utils/overview/">util</Link>
first&nbsp;<Link to="/docs/utils/">util</Link>

:::info

Expand Down
Loading

0 comments on commit c743087

Please sign in to comment.