new content structure

[nweldev]

Request by @Vuk-BN for 2022-07-22: Deliver a thorough plan describing the new structure of the website while progressively moving toward the DevKit.

Define the new structure and create the associated sections.

[nweldev]

Working Draft

Warning

This working draft will be constantly updated while creating new content.

ℹ️ LEGEND

🔽 pre-existing content transfered as is
↗️ external link
♻️ simple translation / extension / update of pre-existing documents
🗜️ simple summary of pre-existing documents
🚧 should be first marked as "coming soon" as the associated part should be available around the end of Q3

Home Page (calls to action)

• quick overview of the DevKit
  • with more incentives to start using/testing the DevKit
• quick introduction to blindnet
• Community / Contribute
• Openness

Docs

• 🗜️ Overview / Introduction
  • quick summary of the High-Level Concept Model and High-Level Architecture)
• Tutorial : 📌 create a first simple tutorial for the DevKit devrel-management#66
• Computation (Privacy Computation Engine)
  • ♻️ Write Doc: How to configure Privacy Computation Engine devrel-management#51
  • ♻️ Write Doc: How Privacy Compiler Works devrel-management#52
• Interfaces
  • Privacy Request Capture Interface
  • 🚧 coming soon
• 🚧 Storage (Data Access Component & Storage connectors)
• ♻️/🚧 Capturing Date (Data Capture Components / e2ee SDKs)
• 🔽 Notions of Privacy
• 🔽 Lexicon (to be extended, see 📌 write a technical lexicon for privacy devrel-management#25

Note

The first "overview" tutorial should be extended/replaced by a "modular" quick start tutorial as follow ASAP:

• install the Privacy Computation Engine (see ref)
• 🚧 connect to your storage
  • Data Access Component, Storage Connectors, and a demo Data Storage service - see [epic] define and implement storage part for the DevKit product-management#762)
• ♻️ capture e2e encrypted data ( progressive transition from the ee2e SDK to new Data Capture Components)
• 🚧 provide privacy-oriented UX with our WebKit
• allow privacy requests from your website (using wc-priv-request, see Privacy Request Capture Interface

Deep Dive

Note

As a first step, some of these documents have been moved to the /docs section.

• White Papers
  • The Mixed Feelings of Privacy
  • 🚧 more soon
• 🗜️ Introduction to PRIV
  • more details ↗️ PRIV dedicated repository (from https://github.com/blindnet-io/product-management/tree/main/refs/schemas/priv)
• 🔽 protocols
• 🔽 High Level Concept Model
• 🔽 High-Level Architecture
• 🔽 blindnet devkit architecture
• 🔽 Data Model
• 🔽 Use Cases
• 🔽 Decision Records

APIs

automatically generated dev/API docs

• OpenApi ↗️ (stoplight)
• Privacy Computation Engine
• ♻️ Data Capture — (1) migration of the existing SDK docs (2) replace with new dev docs from repos
  • Java
  • Dotnet
  • Node.js
  • Frontend JS
• Storage
• WebKit (storybook) ↗️

Community

see #14

• Support
• team / community members / contributors
• Contributing (see Add a "Contributing" section #18)
  • get involved / where to start
  • Join Slack
  • Product Management
  • DevRel Management
  • projects/repositories
  • branch and commits
  • PR (extension of OF - DR 0002)
  • Dev set up
  • code conventions
• ♻️ Licensing
  • from DR-0001-oss-license to be updated and extended by Update licensing to include CC BY-SA for contents openness-framework#37
• ♻️ Code of Conduct

Openness ↗️

[nweldev]

see #31 (comment) for update on week 36

The following follows a meeting between @Vuk-BN, @milstan and me on September 14th, and outdated this previous comment.

The main focus of blindnet.dev now needs to be on acquisition and activation, not retention.
Completing the introductory tutorial and detailed docs for PCE configuration and PC4W is now my top priority.

[nweldev]

The new structure for the /docs is now in production.

#14 and other sections will be addressed with dedicated issues.