SchemaBlocks Repositories

The SchemaBlocks Github organisation contains several specifically scoped repositories. Please use the relevant Github Issues to and/or GH pull requests comment and contribute there.

{S}[B] Tool & Web Repositories

schemablocks.github.io

• website repository
• contains
  • documentation pages (formats, general)
  • representation of schemas (“blocks”), rendered from the code repositories, in /pages/_schemas (website source files for Github Pages rendering) and /schemas/ga4gh (schema source code in JSON Schema format)
• Github issues here should address general SchemaBlocks topics and governance, as well as formats documentation

tools

• scripts for processing the source code in the blocks (and possibly other) repository and rendering the reference schema files and documentation pages into this website project

{S}[B] Code Repositories

The structure of the code repositories is a pre-requisite for the parsing of the schema files. Please refer to the documentation in the tools repository.

sb-this-donor-project

SchemaBlocks is organized around individual “donor”-repositories. The standard setup is to have a donor schema and the derived documents represented in its own repository. Those repositories follow an “sb-“ prefixed naming convention.

{S}[B] code repositories adhere a consistent structure & naming:

sb-code           # each of the code repositories
  |
  |- source       # original code
  |- working      # for editing, temporary...
  |- schemas      # master transformed JSON Schema files as YAML; read to produce the output files
  |- generated    # contains files generated from main schema YAML files
      |- json     # .json version of the schema
      |- examples # .json example data, from inline examples
      |- doc      # .md documentation, from inline documentation

blocks

• schema repository
• contains the source code as well as rendered representations and example data
• main repository to create code specific pull requests and issues

playground

• repository for suggeting & testing possible additions to the {S}[B] environment
• items there should be considered “experimental”, with no reliable endorsement by the {S}[B] community