diff --git a/README.md b/README.md index 16f3308..d6e6ea2 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,4 @@ The GovStack Sandbox is a unified environment for all the GovStack and digital g ecosystem actors to discover, understand, engage, experiment, innovate, and build digital government solutions using the [GovStack platform](https://govstack.global). -For more details, please check out the [documentation](https://govstack.gitbook.io/sandbox/). \ No newline at end of file +For more information, see the [documentation](https://govstack.gitbook.io/sandbox/). \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 07c7ffe..8ec490d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,12 +21,6 @@ such as APIs, [building blocks](https://govstack.gitbook.io/specification/buildi cases and transaction flows. This helps developers and digital government agencies to achieve a more holistic view of the GovStack. -## Get started -The sandbox is reusable and replicable, which means you can set up your own GovStack sandbox within your own environment. - -To get more details on how to up and run your instance check out the -[infrastructure documentation](https://github.com/GovStackWorkingGroup/sandbox-infra). - ## Candidates for building blocks In the Sandbox, you have the freedom to configure your own setup and run any [building blocks](https://govstack.gitbook.io/specification/building-blocks/about-building-blocks) of your choice. @@ -36,7 +30,6 @@ Try out BB candidates: * [Information mediator/X-Road](https://github.com/GovStackWorkingGroup/sandbox-bb-information-mediator) * [Registration/OpenIMIS](https://github.com/GovStackWorkingGroup/sandbox-bb-registration) * [Payment/Mifos](https://github.com/GovStackWorkingGroup/sandbox-bb-payments) -* … ## Portal diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 6568323..4ee458e 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,5 +1,7 @@ # Table of contents -* [Sandbox](README.md) -* [Technology stack](technologies.md) -* [Requirements for building blocks](guidelines-for-bbs.md) +* [GovStack Sandbox](README.md) +* [Public Demo - Access public demo Sandbox](demo.md) +* [Built your own Sandbox - How to up and run your own Govstack](diy.md) +* [Use Cases - Service design along Implementation Playbook](service-design.md) +* [Guidelines for building block Sandbox deployment](guidelines-for-bbs.md) \ No newline at end of file diff --git a/docs/demo.md b/docs/demo.md new file mode 100644 index 0000000..17ca37e --- /dev/null +++ b/docs/demo.md @@ -0,0 +1,26 @@ +# Public Demo - Access public demo Sandbox + +## Unconditional social cash transfer +This use case profiles specifically the digital integration steps within the delivery journey of a generalized unconditional social cash transfer service. Unconditional cash transfers are cash payments provided to financially disadvantaged or vulnerable people or households without requiring anything in return (i.e. without conditionality). + +Implementation and more details in the [Mock-SRIS repository](https://github.com/GovStackWorkingGroup/product-use-cases/blob/main/product-use-case/inst-1-unconditional-social-cash-transfer.md). + +{% hint style="warning" %} +Release of the demo is expected for September 2023 +{% endhint %} + +## Building Permits +This use case profiles the implementation process of a construction permit. A service that automates the entire construction permit approval process - from enabling online application submissions of building construction plans, to initiating verification and final approval by the local government authorities. + +For more information, see [product-use-cases repository](https://github.com/GovStackWorkingGroup/product-use-cases/blob/aec2c37c97579a6abafc3034f404de00f6145c52/product-use-case/inf-1-construction-permit.md). + +{% hint style="warning" %} +This use case demo is under development and expected to be released in Q4/2023. +{% endhint %} + +{% embed url="https://www.figma.com/file/dVDSKvR2RY99w1zhRZbnSI/Analyses---Construction-Permit-Service?type=design&node-id=578%3A330&mode=design&t=EBRbAF4mCmNfSl3m-1" %} + +## High school certificates +{% hint style="warning" %} +This use case demo is under development and expected to be released in Q1/2024. +{% endhint %} \ No newline at end of file diff --git a/docs/diy.md b/docs/diy.md new file mode 100644 index 0000000..e82b3a6 --- /dev/null +++ b/docs/diy.md @@ -0,0 +1,6 @@ +# Built your own Sandbox - How to up and run your own GovStack + +The sandbox is reusable and replicable, which means you can set up your own GovStack sandbox within your own environment. + +To get more details on how to up and run your instance check out the +[infrastructure documentation](https://github.com/GovStackWorkingGroup/sandbox-infra). \ No newline at end of file diff --git a/docs/service-design.md b/docs/service-design.md new file mode 100644 index 0000000..045832f --- /dev/null +++ b/docs/service-design.md @@ -0,0 +1,5 @@ +# Use Cases - Service design along Implementation Playbook + +{% hint style="warning" %} +This section is under development. +{% endhint %} \ No newline at end of file diff --git a/docs/technologies.md b/docs/technologies.md deleted file mode 100644 index 8dbf0dd..0000000 --- a/docs/technologies.md +++ /dev/null @@ -1,17 +0,0 @@ -# Sandbox technology stack - -* [OCI](https://opencontainers.org/) compliant container images, e.g. [Docker](https://www.docker.com/) -* [Kubernetes](https://kubernetes.io/) -* [Helm charts](https://helm.sh/docs/topics/charts/) -* [CI/CD](https://en.wikipedia.org/wiki/CI/CD) pipeline configurations - -## Secret management -The sandbox is a testing and development environment, so it has the following requirements for managing secrets: - -* Use [Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/) -* Don't keep secret in git repository (encrypted as well, due to rotation policy) -* Use random generated passwords, e.g. [Helm randAlphaNum method](https://helm.sh/docs/chart_template_guide/function_list/#randalphanum-randalpha-randnumeric-and-randascii) - -## Figma - -{% embed url="https://www.figma.com/file/qVUaK5Z5FmgQV16C71RRCn/USCT---Vertical-Prototype?node-id=178-5054&type=design" %} \ No newline at end of file