Skip to content

Commit 01d5c6b

Browse files
m4rk055m4rk055
authored
Merge pull request #88 from blindnet-io/improvements
Update tutorial
2 parents 6e72064 + 8c951f7 commit 01d5c6b

18 files changed

+303
-330
lines changed

‎docs/02-tutorials/01-intro/01-privacy-portal-set-up.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ description: Enable your users to create privacy requests
55
tags: [tutorial]
66
---
77

8-
User interfaces for the blindnet devkit (aka _[Privacy Components for the Web](https://github.com/blindnet-io/privacy-components-web)_) are delivered as standard [Web Components](https://www.webcomponents.org/introduction) available both on NPM and through a CDN.
8+
User interfaces for the blindnet devkit (aka _[Blindnet web modules](https://github.com/blindnet-io/privacy-components-web)_) are delivered as standard [Web Components](https://www.webcomponents.org/introduction) available both on NPM and through a CDN.
99

1010
:::info
1111

1212
See [Using Web Components](/docs/interfaces/install/using-web-components) for more information on how to integrate Web Components in your existing project.
1313

1414
:::
1515

16-
The first component we'll use is the [Privacy Portal](/docs/interfaces/privacy-portal ), an entry point for submitting and viewing [Privacy Requests](/docs/references/lexicon#privacy-request).
16+
The first component we'll use is the [Privacy Portal](/docs/interfaces/privacy-portal), an entry point for submitting and viewing [Privacy Requests](/docs/references/lexicon#privacy-request).
1717

18-
For this section of the tutorial, we will start with the simple static frontend available [here](https://github.com/blindnet-io/devkit-quickstart/blob/main/tutorials/intro/web/intro-start.html).
18+
For this section of the tutorial, we will start with the simple static frontend available [here](https://github.com/blindnet-io/devkit-quickstart/blob/main/tutorials/intro/web/0-intro-start.html).
1919

2020
## Load the Bundle
2121

@@ -58,7 +58,7 @@ At this point you should see the request interface, which you can use to build y
5858
5959
After we build our request and click submit, the Privacy Portal will fire an [event](/docs/interfaces/privacy-portal/events) containing the JSON representation of the request.
6060
61-
You can listen for and use this event in your application by adding an [event listener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener):
61+
You can catch this event in your application by adding an [event listener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener):
6262
6363
```html
6464
<body>
@@ -82,7 +82,7 @@ You can listen for and use this event in your application by adding an [event li
8282
}
8383
8484
// Add listener to the Privacy Portal element
85-
const email = document.getElementById("devkit").addEventListener("bldn-request-builder:request-created", catchRequest)
85+
document.getElementById("devkit").addEventListener("bldn-request-builder:request-created", catchRequest)
8686
</script>
8787
</body>
8888
```
@@ -91,8 +91,8 @@ You can listen for and use this event in your application by adding an [event li
9191

9292
We can now build a privacy request and capture the emitted request object.
9393

94-
The HTML file with our work so far can be found [here](https://github.com/blindnet-io/devkit-quickstart/blob/main/web/expose-request-interface-event-listener.html).
94+
The HTML file with our work so far can be found [here](https://github.com/blindnet-io/devkit-quickstart/blob/main/tutorials/intro/web/1-expose-request-interface-event-listener.html).
9595

9696
:::
9797

98-
Next, let's set up the [Privacy Computation Engine](./pce-set-up).
98+
Next, let's [create a devkit application](./dashboard).

‎docs/02-tutorials/01-intro/02-dashboard.mdx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
sidebar_position: 2
3+
title: 2. Create a devkit application
4+
description: Create a devkit application
5+
tags: [tutorial]
6+
---
7+
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
Devkit applications are managed using the **blindnet Dashboard**, found on [stage.dashboard.blindnet.io](https://stage.dashboard.blindnet.io).
12+
13+
:::info
14+
In order to automate privacy requests, you need to have an active devkit application.
15+
:::
16+
17+
## Step 1: Register
18+
19+
Head over to the [registration page](https://stage.dashboard.blindnet.io/register) and create an account.
20+
You'll get an email message to verify your email address.
21+
22+
## Step 2: Create an Application group
23+
24+
After you verify your account, first, you need to create an **application group**.
25+
26+
:::info
27+
An **Application group** is a container for your devkit applications. Applications in the same group share the same authentication key but their settings and scopes are independent.
28+
Usually, all of your applications will be in a single group.
29+
:::
30+
31+
Specify your group's **name** and **key**.
32+
33+
:::note
34+
The key is generated locally (in the browser window) but you can provide your own.
35+
Make sure to `copy` and `save` the **key** as blindnet does not store it. If you lose the **key**, a new one has to be generated.
36+
:::
37+
38+
## Step 3: Create an Application
39+
40+
Click on the `New App` button to create an **Application**.
41+
After the **Application** is created, open it from the list of applications and you'll find it's `ID`.
42+
43+
Now, you should have the Groups's `key` and Application's `ID`. We will use them in the later steps of the tutorial to authenticate the users.

‎docs/02-tutorials/01-intro/02-pce-set-up.mdx‎

Lines changed: 0 additions & 129 deletions
This file was deleted.

‎docs/02-tutorials/01-intro/03-authentication.mdx‎

Lines changed: 0 additions & 133 deletions
This file was deleted.

0 commit comments

Comments
 (0)