Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
root: ./spec/
root: ./docs/
structure:
readme: README.md
summary: SUMMARY.md
Expand Down
38 changes: 4 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,7 @@
# GovStack Sandbox

This template is intended to be used by the various GovStack building block
repos. Each building block repo will have at least 4 main sections, outlined in
the directory structure below.
The GovStack Sandbox is a unified environment for all the GovStack and digital government
ecosystem actors to discover, understand, engage, experiment, innovate, and build digital
government solutions using the [GovStack platform](https://govstack.global).

## Gitbook and the published "Building Block Specifications" document

Note that pushes to the `main` branch will automatically trigger a Gitbook build
and deployment from the `/spec` directory.

## Repo Structure

```sh
README.md
/spec # the markdown files which are used to build the specification in GitBook
/api # the openapi specification
/test # the test plan and tests
plan.md
/examples # examples for deploying, configuring, and testing applications which implement the behaviors specified by this building block
/application-a
README.md # instructions for deployment/testing
docker-compose.yaml # example deployment file
db
web
adaptor
security-server
Caddyfile # example config for "adaptor"
Dockerfile # dockerfile to build "adaptor"
/application-b
/application-c
```

## ORB setup

Documentation for ORB setup is available here:
[ORB setup instruction](https://govstack-global.atlassian.net/wiki/spaces/GH/pages/191692823/ORB+setup+instruction)
For more details, please check out the [documentation](https://govstack.gitbook.io/sandbox/).
File renamed without changes.