📌 Write a first basic tutorial

[nweldev]

What?

Write a complete but simple tutorial explaining step-by-step how to set up and use the SDK in a basic but realistic web app.

Why?

Help third-party developers better understand how the SDK can actually improve the development process "in real life".

How?

Based on:

• blog posts by @milstan (TODO: add links)
• current documentation
• current "get started"

By the end of this task, the tutorial should be:

• available on blindnet.io (whatever what kind of dev portal we have at the time) with call-to-actions to make it visible and encourage its usage
• referenced in our repositories READMEs.

[milstan]

Links: Blindsend v1.0. For your blind spots. Data Minimization 101 Data is Illness. Minimization is the Cure.

[nweldev]

follows https://github.com/blindnet-io/devrel-planning/issues/1#issuecomment-1079268458 after the related epic has been closed

@milstan's HighLevelConceptualisation document should be taken into account while building this tutorial (knowing that not all of the scope will be immediately or ever covered).

[nweldev]

I believe this issue is a way lower priority now that we're focusing on devkit v2, and the actual context and goal will change a lot once we'll start having this v2. So I believe I'll close it instead of just continuing to postpone it (ping @milstan and @filipblnt for confirmation).

[milstan]

My understanding is that @filipblnt is awaiting for this as a start of the work on devkit.

I let the two of you coordinate on this.

[nweldev]

That was my first approach indeed, considering v2 would only be an extension of current tools (the tutorial would have served as a starting point for building a web SDK around the current javascript frontend SDK).

Now, based on the discussion we had and the documents we wrote, I feel this isn't the case anymore. I believe I should instead closely follow what engineering will produce for v2, promote it, and contribute as much as possible (to the code base, but also by making additional tools, docs, explainers, tutorials, etc.).

Especially as we agreed today that the current SDKs (and the related doc) aren't that important for dev engagement anymore. And here, I realise I need to have more input about @filipblnt's plans for the future of the "devkit v1".

@filipblnt tell me how you feel about that

[filipblnt]

I still think that a tutorial would be useful, since the current SDK will be part of the devkit. But instead of just having a tutorial by looking at the current SDK only as it is now, I think it would be useful to look at the HLC/HLA and write that SDK tutorial in the context of HLC/HLA.

[nweldev]

Out of date. A more global update of the documentation is necessary. Other issues and epic will be created for that.

[Vuk-BN]

@noelmace just want to make sure we're on top of writing a first basic tutorial for our SDKs.

I imagine this issue needs to be a part of this, no?

I also imagine this tutorial being connected to the content we will put under 'Usage' here, as well.

In case I am mistake, let's discuss it tomorrow asap.

[nweldev]

This is not the issue you are looking for 😉
This one was about the previous SDKs, not the DevKit.
blindnet-io/product-management#721 (comment)

[milstan]

@noelmace My understanding (maybe wrong) of what @Vuk-BN needs is:

• a "quick-start" type of tutorial (as of now while the system is being built) to be able to show it to potential clients and partners and aswer the question "how hard is this to integrate"

Ineed this issue was planned for SDK, not done, and then my understanding is:

• this issue changed scope by Filip's comment But instead of just having a tutorial by looking at the current SDK only as it is now, I think it would be useful to look at the HLC/HLA and write that SDK tutorial in the context of HLC/HLA. and mine too in May 2022, and thus remaind opened.
• to the best of my knoweldge there is no dedicated issue for such a tutorial in the context of devkit.

So if you are closing this issue, can you please make a new one, with aim to write this first basic tutorial in the context of devkit, and ideally responding to this need Vuk seems to be having, as described above.

[nweldev]

This issue is indeed linked to several outdated issues, discussions and choices.

I created this new issue to track the creation of a first devkit tutorial: #66