• Rough draft
  • Structure for Sandbox documentation

    WIP 0.2 → to be ready by Oct 2, 2023 in a peer-reviewed draft state

    initiated by @Nico Lueck on Sep 21, 2023

    ID

    Deliverable

    Level

    Item

    Owner

    Status

    Not StartedWIPIn ReviewDraft done

    Notes

    ID

    Deliverable

    Level

    Item

    Owner

    Status

    Not StartedWIPIn ReviewDraft done

    Notes

    1

    GitBook

    1

    Enter the Sandbox

    @Nico Lueck @Meelis Zujev (Deactivated)

    WIP

     

    2

    GitBook

    1

    Access Demos

     

     

     

    2.1

    GitBook

    2

    USCT Use Case

    @Nico Lueck @Meelis Zujev (Deactivated)

    WIP

    High Level Use Case Introduction

    1. Goal: answering value prop of demo for visitors

    2. What is use case?

      1. Not in scope / way forward

    3. How to enter it…

    2.2

    GitBook

    2

    Construction Permit Use Case

    @Nico Lueck @Meelis Zujev (Deactivated)

    WIP

    High Level Use Case Introduction

    1. Goal: answering value prop of demo for visitors

    2. What is use case?

      1. Not in scope / way forward

    3. How to enter it…

    2.3

    GitBook

    2

    Do it yourself

    @Oleksii Danyliuk

    WIP

    • explain motivation, sync/review with @Nico Lueck

    2.3.1

    Gitbook

    3

    Support for Setting up Your Test Environment

    @Nico Lueck

    WIP

     

    3

    GitBook

    1

    Explore Stack

     

     

    Assumption: More interesting to show diff. layers of stack, tech insights first, business context (use case) second, also cross reference to other use-case related resources

    3.1

    GitBook

    2

    Architecture

    @jarkkohyoty

    Draft done

     

    3.2

    GitBook

    2

    Use Case Frontend

    @Priit Puru@Valentin Filyov

    Not Started

     

    3.3

    GitBook

    2

    Use Case Backend

    @Oleksii Danyliuk @Vladislav Todorov

    Done

    Use Case Backend | sandbox

    3.4

    GitBook

    2

    Building Blocks

    @Oleksii Danyliuk @Vladislav Todorov @Tsvetomir Krumov @Vasil Kolev @jarkkohyoty

    DONE

    Just references to their respective specs and repositories of the products used?

    Nico: Subpages for each BB with table stating candidate and adaptor with reference to usage in use case

    https://github.com/GovStackWorkingGroup/sandbox/pull/31

    3.4.1

    GitBook

    3

    Emulators

    @Vladislav Todorov @Vasil Kolev

    Done

     

    3.5

    GitBook

    2

    DevOps

    @Tsvetomir Krumov @jarkkohyoty

    Draft done

     

    3.6

    GitBook

    2

    Infrastructure

    @Tsvetomir Krumov @jarkkohyoty

    Draft done

     

    4

    GitBook

    1

    Follow Methodology

     

     

     

    4.1

    GitBook

    2

    Our Service Design Approach

    @Artun Gürkan @Jonas Bergmeier

    Draft Done

     

    4.2.1

    GitBook

    3

    Designing along the GovStack specifications

    @Jonas Bergmeier @Artun Gürkan

    Draft Done

     

    4.2.2

    GitBook

    3

    Service Design Best Practice Use Case Building Permit

    @Artun Gürkan@Jonas Bergmeier

    Draft Done

     

    4.2

    GitBook

    2

    Our DPI/DPG Contributions

    @Satyajit Suri

    WIP

    (optional - @Nico Lueck will sync with Satya)

    4.3

    GitBook

    2

    Our Management Recommendations

    @Nico Lueck

    Not Started

    Project retro, teaching and learnings for carrying out the development of a Govstack

    Structure for Access Demo Pages

    Chapter Title

    Guiding Question

    Chapter Title

    Guiding Question

    No title

    Graphic showing: Key Aspects the demo shows. Indication of stack usage

    What is [use case name]?

    Short description of use case

    Access Points

    How can the demo be accessed?

    One or more links to the demo. Instructions on how to use the demo

    Demonstrated GovStack Features

    What aspects does the demo demonstrate? (long version of diagram)

    Data Privacy Note

    GIZ regulations

    Structure for Explore Stack Pages

    Chapter Title

    Guiding Question

    Chapter Title

    Guiding Question

    No title

    What is this component?

    Explain the purpose of this component (e.g. Backend application for API orchestration etc.)

    What do we use to build it?

    Which assets did we use to build it?

    It can be software, libraries, frameworks etc. (e.g. MOSIP under Building Blocks or React, Vite on Frontend App). Do not list every language - that can be seen on github.

    Where do we demo it?

    Where is this component in use?

    It can be a chapter explaining use case specific designs (example under Architecture) or a table listing assets and where they are used (can be combined with the question before, example under "Building Blocks"

    Which decisions to we follow?

    Further explanations (e.g. Why did we made certain decision? How does function?)

    Use adr.github.io

     

     

    ID

    Deliverable

    Level

    Parent Item

    Item

    Owner

    Status

    Notes

    ID

    Deliverable

    Level

    Parent Item

    Item

    Owner

    Status

    Notes

    1

    GitBook

    1

    -

    Introduction to the Sandbox

    @Meelis Zujev (Deactivated) + @jarkkohyoty + @Vasil Kolev

    WIP

    This needs structure and fleshing out

    2

    GitBook

    1

    -

    Access public demos

     

    WIP

     

    3

    GitBook

    1

    -

    Do it yourself

    @Oleksii Danyliuk +

    WIP

     

    4

    GitBook

    1

    -

    Use Case Analysis and Documentation

    @Artun Gürkan + @Jonas Bergmeier

    Not started

    Provide overview and refer to impl. playbook and UX/UI WG deliverables

    5

    GitBook

    2

    4

    Unconditional Social Cash Transfer

    Sandbox Team

    wip

     

    6

    GitBook

    2

    4

    Building Permits

     

    not started

    see Building Permit

    7

    GitBook

    3

    5

    Demo Implementation (POC)

    @Oleksii Danyliuk(USCT Backend) + @Vladislav Todorov (Used BB emulators adaptors) + (USCT- overview and USCT- Frontend)

    Description of our USCT use-case implementation

    • Frontend @Priit Puru , please leave some docs here in alignment with @Oleksii Danyliuk @Vladislav Todorov

    8

    GitBook

    3

    5

    Analysis and Service Design

    @Artun Gürkan @Jonas Bergmeier

    Not started

     

    9

    GitBook

    3

    6

    Demo Implementation

     

     

     

    10

    GitBook

    3

    6

    Analysis and Service Design

    @Artun Gürkan @Jonas Bergmeier

    Not started