Skip to content

Commit

Permalink
tutorial resources
Browse files Browse the repository at this point in the history
  • Loading branch information
rob-metalinkage committed Oct 28, 2024
1 parent eeffdb5 commit 140a27a
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 2 deletions.
4 changes: 4 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ docs:
children:
- title: Local Build
url: /build/local
- title: Github Configuration
url: /build/github
- title: Tutorial
url: /build/tutorial
- title: Using the Building Blocks
children:
- title: Finding Building Blocks
Expand Down
8 changes: 6 additions & 2 deletions _pages/build/github.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Configuring Github build

Github repositories need configuration to allow automated building.

1. Fork the template or another repository to a git organisation you have admin access for.
1. In settings set "pages build" to "Github actions"
![](pages.png)
2. Run the "validate and postprocess" action
![](run.png)
3. Link the generated output pages to the repo overview by selecting "show"
![](link.png)

You can now navigate between repository sources and the published Building Blocks [Watch]()
You can now navigate between repository sources and the published Building Blocks:

![From Repo to docs](to_register.png)

![From Docs to Repo](to_repo.png)
Binary file added _pages/build/link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _pages/build/pages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _pages/build/run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _pages/build/to_register.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _pages/build/to_repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions _pages/build/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Building Blocks Tutorials

A range of tutorials will provide step by step introduction to the features of OGC Building Blocks.

Please raise an [issue](https://github.com/ogcincubator/bblocks-docs/issues) for new tutorial requests

## Tutorials

### [Core](https://ogcincubator.github.io/bblocks-tutorial/)

This steps through the core features of the OGC Building Blocks framework with an emphasis on OGC API ready, semantically enabled JSON schemas.


## Planned tutorials

### Governance

A description of various governance patterns and an introduction to OGC Policies and Procedures in relation to Building Blocks.

### Building interoperable metadata profiles (STAC, Records, 19115, DCAT etc)

This will focus on metadata design and the various extension and profiling mechanisms for metadata standards relevant to the OGC mission.

Transformations and testing will be a key aspect due to the variations schemas and encoding technologies in use.

### Data transformations

Transformations will be a constant challenge, and a wide range of transformation languages and tools may be needed - this tutorial will show options and how to extend the framework to include your own transformation tools.

### Semantic Model Publishing

Publishing semantic (RDF, OWL, SHACL) etc models is difficult due to limitations of existing tools. This tutorial will demonstrate how to factor semantic models into FAIR building blocks and make the model itself FAIR.

### UML models

UML models are notoriously difficult to manage in a modular fashion - this tutorial will focus on FAIR UML models - composition and testing.

0 comments on commit 140a27a

Please sign in to comment.