Skip to content

Commit 1c4e206

Browse files
committed
chore: improve WIP warning
use the @theme/Admonition component to allow to redirect to a specific repo as MDX v1 doesn't allow this kind of behavior. see facebook/docusaurus#6072 (comment)
1 parent f1ea42d commit 1c4e206

File tree

9 files changed

+15
-17
lines changed

9 files changed

+15
-17
lines changed

docs/02-tutorial.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ title: Tutorial
44
tags: [quickstart]
55
---
66

7+
import WipWarning from './_partials/_wip.mdx';
8+
79
This tutorial doesn’t assume any existing knowledge of the blindnet devkit or even any privacy related technologies.
810

911
We will simply walk you through the different components of the devkit to give you a better understanding of the overall structure and logic.
1012

11-
:::warning
12-
:construction_worker: This document is still under active development.
13-
:::
13+
<WipWarning />
1414

1515
## 1. Configure the Privacy Computation Engine
1616

docs/03-computation/01-introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: ["introduction"]
66

77
import WipWarning from '../_partials/_wip.mdx';
88

9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
9+
<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
1010

1111
The blindnet devkit **Privacy Computation Engine** is a service that interpret your rights to hold and treat a particular Data Capture at a particular point of time and calculate a response to [Data Subjects'](/docs/references/lexicon#data-subject) [Privacy Requests](/docs/references/lexicon#privacy-request).
1212

docs/03-computation/02-configuration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: ['guide']
66

77
import WipWarning from '../_partials/_wip.mdx';
88

9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
9+
<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
1010

1111
You must first configure the Privacy Computation Engine in order to make the most of it.
1212

docs/03-computation/03-usage.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: ['guide']
66

77
import WipWarning from '../_partials/_wip.mdx';
88

9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
9+
<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
1010

1111
The Privacy Computation Engine (PCE) processes a timeline of [PRIV Events](https://github.com/blindnet-io/product-management/blob/main/refs/schemas/priv/RFC-PRIV.md#events).
1212

docs/03-computation/04-compiler.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: ['guide']
66

77
import WipWarning from '../_partials/_wip.mdx';
88

9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
9+
<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
1010

1111
## Initial Set-up
1212

docs/04-interfaces/02-install.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ tags: ["guide"]
66

77
import WipWarning from '../_partials/_wip.mdx';
88

9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
9+
<WipWarning repo="https://github.com/blindnet-io/privacy-components-web" />

docs/05-storage/01-introduction.mdx

-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebar_position: 1
44
tags: ["introduction"]
55
---
66

7-
import WipWarning from '../_partials/_wip.mdx';
8-
9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
10-
117
While handling Privacy Requests, the Pricacy Computation Engines can be connected with storage services to automatically interpret and execute data deletions and modifications.
128

139
Two components of the devkit are here to help you integrate this easily, either as a new service or as part of your pre-existing architure:

docs/06-data-capture/01-introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ tags: ["introduction"]
66

77
import WipWarning from '../_partials/_wip.mdx';
88

9-
<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
9+
<WipWarning />

docs/_partials/_wip.mdx

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
:::warning :construction_worker: WIP
2-
This section and the related features are under active development.<br/>
3-
Go check our [Github organization](https://github.com/blindnet-io/) and follow us on [Twitter](https://twitter.com/blindnet_io) for updates.
4-
:::
1+
import Admonition from '@theme/Admonition';
2+
3+
<Admonition type="danger" icon="👷" title="Work In Progress">
4+
<p>This section and the related features are under active development.</p>
5+
<p>Go check { props.repo ? <>the <a href={props.repo}>associated repository on Github</a></> : <>our <a href="https://github.com/blindnet-io/">Github organization</a></> } and follow us on <a href="https://twitter.com/blindnet_io">Twitter</a> for updates.</p>
6+
</Admonition>

0 commit comments

Comments
 (0)