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)
blindnet-io · Aug 19, 2022 · e9b7c5e · e9b7c5e
1 parent f1ea42d
commit e9b7c5e
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 41 deletions.
diff --git a/docs/02-tutorial.mdx b/docs/02-tutorial.mdx
@@ -4,63 +4,53 @@ title: Tutorial
 tags: [quickstart]
 ---
 
+import WipWarning from './_partials/_wip.mdx';
+
 This tutorial doesn’t assume any existing knowledge of the blindnet devkit or even any privacy related technologies.
 
 We will simply walk you through the different components of the devkit to give you a better understanding of the overall structure and logic.
 
-:::warning
-:construction_worker: This document is still under active development.
-:::
+<WipWarning />
 
 ## 1. Configure the Privacy Computation Engine
 
 The [Privacy Computation Engine](./computation) is the core of blindnet devkit.
 It is a simple service you can interact with via a Rest API to create and track your users' [Privacy Requests](/docs/references/lexicon#privacy-request).
 
 You don't need to configure or install a Privacy Computation Engine for this tutorial.
-We simply pre-configured a dedicated custom instance for you on https://devkit-pce-staging.azurewebsites.net/v0/ to makes things eathier.
+We simply pre-configured a dedicated custom instance for you on `https://devkit-pce-staging.azurewebsites.net/v0/` to makes things eathier.
 
 You can call the Rest APÏ yourself for specific usages.
 However, you won't need to in this tutorial (and even in most real-life use cases), as other components of the devkit will transparently handle it themselves.
 
-:::note
+:::info
 For more information, checkout the associated [Swagger](https://devkit-pce-staging.azurewebsites.net/swagger/), and the [Computation](./computation/) section of this documentation.
 :::
 
 ## 2. Set-up Storage
 
-:::warning
-:construction_worker: This step is still under active development.
-:::
+> :construction_worker: redaction in progress
 
 ## 3. Initiate a Web App
 
-:::note
+> :construction_worker: redaction in progress
 
-:::
+## 4. Capture Data
 
-## 4. Encrypt Data
+> :construction_worker: redaction in progress
 
-:::warning
-:construction_worker: This step is still under active development.
-:::
+## 5. Install the Privacy Request Capture Interface
 
-## 5. Capture Data
+> :construction_worker: redaction in progress
 
-:::warning
-:construction_worker: This step is still under active development.
-:::
+## 6. Make a Privacy Request
 
-## 6. Install the Privacy Request Capture Interface
+> :construction_worker: redaction in progress
 
-:::warning
-:construction_worker: This step is still under active development.
-:::
+## 7. Install the Data Consumer Interface
 
-## 7. Make a Privacy Request
+> :construction_worker: redaction in progress
 
-## 8. Decrypt Data
+## 8. Accept a Privacy Request
 
-:::warning
-:construction_worker: This step is still under active development.
-:::
+> :construction_worker: redaction in progress
diff --git a/docs/03-computation/01-introduction.mdx b/docs/03-computation/01-introduction.mdx
@@ -6,7 +6,7 @@ tags: ["introduction"]
 
 import WipWarning from '../_partials/_wip.mdx';
 
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
+<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
 
 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).
 

diff --git a/docs/03-computation/02-configuration.mdx b/docs/03-computation/02-configuration.mdx
@@ -6,7 +6,7 @@ tags: ['guide']
 
 import WipWarning from '../_partials/_wip.mdx';
 
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
+<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
 
 You must first configure the Privacy Computation Engine in order to make the most of it.
 

diff --git a/docs/03-computation/03-usage.mdx b/docs/03-computation/03-usage.mdx
@@ -6,7 +6,7 @@ tags: ['guide']
 
 import WipWarning from '../_partials/_wip.mdx';
 
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
+<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
 
 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).
 

diff --git a/docs/03-computation/04-compiler.mdx b/docs/03-computation/04-compiler.mdx
@@ -6,7 +6,7 @@ tags: ['guide']
 
 import WipWarning from '../_partials/_wip.mdx';
 
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
+<WipWarning repo="https://github.com/blindnet-io/privacy-computation-engine" />
 
 ## Initial Set-up
 

diff --git a/docs/04-interfaces/02-install.mdx b/docs/04-interfaces/02-install.mdx
@@ -6,4 +6,4 @@ tags: ["guide"]
 
 import WipWarning from '../_partials/_wip.mdx';
 
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
+<WipWarning repo="https://github.com/blindnet-io/privacy-components-web" />
diff --git a/docs/05-storage/01-introduction.mdx b/docs/05-storage/01-introduction.mdx
@@ -4,10 +4,6 @@ sidebar_position: 1
 tags: ["introduction"]
 ---
 
-import WipWarning from '../_partials/_wip.mdx';
-
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
-
 While handling Privacy Requests, the Pricacy Computation Engines can be connected with storage services to automatically interpret and execute data deletions and modifications.
 
 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:

diff --git a/docs/06-data-capture/01-introduction.mdx b/docs/06-data-capture/01-introduction.mdx
@@ -6,4 +6,4 @@ tags: ["introduction"]
 
 import WipWarning from '../_partials/_wip.mdx';
 
-<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
+<WipWarning />
diff --git a/docs/_partials/_wip.mdx b/docs/_partials/_wip.mdx
@@ -1,4 +1,6 @@
-:::warning :construction_worker: WIP
-This section and the related features are under active development.<br/>
-Go check our [Github organization](https://github.com/blindnet-io/) and follow us on [Twitter](https://twitter.com/blindnet_io) for updates.
-:::
+import Admonition from '@theme/Admonition';
+
+<Admonition type="danger" icon="👷" title="Work In Progress">
+  <p>This section and the related features are under active development.</p>
+  <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>
+</Admonition>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ tags: ["guide"]

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

		<WipWarning repo="https://github.com/blindnet-io/data-access-component" />
		<WipWarning repo="https://github.com/blindnet-io/privacy-components-web" />
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ tags: ["introduction"]

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

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