Restructure files/pages, add YAML headers

to generate the desired navigation
Phu2 · Mar 28, 2024 · 865d8ff · 865d8ff
1 parent ca2b9c1
commit 865d8ff
Show file tree

Hide file tree

Showing 15 changed files with 139 additions and 45 deletions.
diff --git a/...hing a transformation with metafacture.md → ...hing a transformation with metafacture.md b/...hing a transformation with metafacture.md → ...hing a transformation with metafacture.md
@@ -1,3 +1,9 @@
+---
+layout: default
+title: Approaching a transformation with metafacture
+nav_order: 4
+---
+
 Every approach to transform metadata with metafacture is quite similiar:
 
 - You need to know the type and source of the input and the type and destination of the output:

diff --git a/Documentation-Maintainer-Guide.md → docs/Documentation-Maintainer-Guide.md b/Documentation-Maintainer-Guide.md → docs/Documentation-Maintainer-Guide.md
@@ -1,3 +1,10 @@
+---
+layout: default
+title: Maintainer Guide
+nav_order: 8
+---
+
+# Maintainer Guide
 
 ## how to change flux-commands.md
 

diff --git a/Getting-Started.md → docs/Getting-Started.md b/Getting-Started.md → docs/Getting-Started.md
@@ -1,3 +1,9 @@
+---
+layout: default
+title: Getting Started
+nav_order: 2
+---
+
 ![logo](https://github.com/culturegraph/metafacture-core/wiki/img/metafacture_small.png)
 
 

diff --git a/LICENSE → docs/LICENSE b/LICENSE → docs/LICENSE
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
@@ -0,0 +1,27 @@
+---
+layout: default
+title: LICENSE
+nav_order: 9
+---
+
+MIT License
+
+Copyright (c) 2022 just-the-docs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/MF-in-5-min.md → docs/MF-in-5-min.md b/MF-in-5-min.md → docs/MF-in-5-min.md
@@ -1,3 +1,9 @@
+---
+layout: default
+title: 5 min Intro into MF
+nav_order: 3
+---
+
 # Introduction - A quick 5 minute introduction to Metafacture
 
 ## HELLO WORLD

diff --git a/Fix-User-Guide.md → docs/fix/Fix-User-Guide.md b/Fix-User-Guide.md → docs/fix/Fix-User-Guide.md
@@ -1,3 +1,10 @@
+---
+layout: default
+title: Fix User Guide
+parent: Fix
+nav_order: 1
+---
+
 ![logo](https://github.com/culturegraph/metafacture-core/wiki/img/metafacture_small.png)
 
 # Fix User Guide

diff --git a/Fix-function-and-Cookbook.md → docs/fix/Fix-function-and-Cookbook.md b/Fix-function-and-Cookbook.md → docs/fix/Fix-function-and-Cookbook.md
@@ -1,3 +1,10 @@
+---
+layout: default
+title: Fix Functions and Cookbook
+parent: Fix
+nav_order: 2
+---
+
 This page is a replication of the passage of the Fix Readme.md.
 
 ## Functions and cookbook

diff --git a/docs/fix/fix.md b/docs/fix/fix.md
@@ -0,0 +1,19 @@
+---
+layout: default
+title: Fix
+nav_order: 6
+has_children: true
+---
+
+Metafix is a domain specific language for metadata transformation based on Catmandu FIX. The FIX object performing the transformation is used as part of a processing pipeline.
+
+If you are using **Metafacture with CLI or Playground** and therefore the Flux scripting language to build and run pipelines, use the `fix` command in your FLUX-Pipeline. 
+
+If you are using **Metafacture as a Java library**, just create a Metafix object and add it to your pipeline (see also the [Framework User Guide](#framework)).
+
+The transformation itself is declared in a fix-object which can be a file. For more information on how to declare transformations see [Metafix User Guide](/Fix-User-Guide.md).
+
+See [here a list for all available FIX functions and a cookbook for using fix](/Fix-function-and-Cookbook.md).
+
+> [!NOTE]
+> PS: There is also the transformation modul MORPH. Have a look at[ the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/).
diff --git a/Flux-User-Guide.md → docs/flux/Flux-User-Guide.md b/Flux-User-Guide.md → docs/flux/Flux-User-Guide.md
@@ -1,3 +1,10 @@
+---
+layout: default
+title: Flux User Guide
+parent: Flux
+nav_order: 1
+---
+
 ![logo](https://github.com/culturegraph/metafacture-core/wiki/img/metafacture_small.png)
 
 # Flux User Guide

diff --git a/flux-commands.md → docs/flux/flux-commands.md b/flux-commands.md → docs/flux/flux-commands.md
@@ -1,3 +1,10 @@
+---
+layout: default
+title: Flux Commands
+parent: Flux
+nav_order: 2
+---
+
 Available flux commands
 =======================
 

diff --git a/docs/flux/flux.md b/docs/flux/flux.md
@@ -0,0 +1,14 @@
+---
+layout: default
+title: Flux
+nav_order: 5
+has_children: true
+---
+
+# FLUX
+
+Flux is a scripting language to easily build and run processing pipelines. No Java programming is necessary - it's used as a command line. To use Flux you may download the binary distribution of Metafacture.
+
+For more information on how to use Flux, see the [Flux User Guide](/Flux-User-Guide.md).
+
+See [here a list for all available FLUX-Commands](/flux-commands.md).
diff --git a/Framework-User-Guide.md → .../java-integration/Framework-User-Guide.md b/Framework-User-Guide.md → .../java-integration/Framework-User-Guide.md
@@ -1,3 +1,10 @@
+---
+layout: default
+title: Framework User Guide
+parent: Java Integration
+nav_order: 1
+---
+
 ![logo](https://github.com/culturegraph/metafacture-core/wiki/img/metafacture_small.png)
 
 # Framework User Guide

diff --git a/docs/java-integration/java-integration.md b/docs/java-integration/java-integration.md
@@ -0,0 +1,15 @@
+---
+layout: default
+title: Java Integration
+nav_order: 7
+has_children: true
+---
+
+## Framework for Java integration/development
+
+> [!NOTE]
+>Relevant for developers
+
+The framework includes the interfaces and abstract classes which form the foundation of the data processing pipelines. This part of Metafacture is only relevant for you if you plan to use Metafacture as a Java library or if you wish to add pipe elements to Flux.
+
+For more information see the [Framework User Guide](/Framework-User-Guide.md).
diff --git a/index.md b/index.md
@@ -1,6 +1,9 @@
 ---
+layout: default
 title: Home
-layout: home
+nav_order: 1
+description: "This is the central place for the documentation about Metafacture."
+permalink: /
 ---
 
 ![logo](https://github.com/culturegraph/metafacture-core/wiki/img/metafacture_small.png)
@@ -32,47 +35,3 @@ Deciding which parts are relevant to you depends on the way you are using Metafa
 
 While working with the playground or the command line you only need [Flux](#flux) and the transformation module [Fix](#fix).
 Have a look here for [Getting started](/Getting-Started.md).
-
-## Framework for Java integration/development
-
-If you plan to use Metafacture as a Java library or if you wish to add commands to Flux. You should get familar with the [Framework](#framework).
-
-__________________
-
-## FLUX
-
-Flux is a scripting language to easily build and run processing pipelines. No Java programming is necessary - it's used as a command line. To use Flux you may download the binary distribution of Metafacture.
-
-For more information on how to use Flux, see the [Flux User Guide](/Flux-User-Guide.md).
-
-See [here a list for all available FLUX-Commands](/flux-commands.md).
-
-__________________
-
-## FIX
-
-Metafix is a domain specific language for metadata transformation based on Catmandu FIX. The FIX object performing the transformation is used as part of a processing pipeline.
-
-If you are using **Metafacture with CLI or Playground** and therefore the Flux scripting language to build and run pipelines, use the `fix` command in your FLUX-Pipeline. 
-
-If you are using **Metafacture as a Java library**, just create a Metafix object and add it to your pipeline (see also the [Framework User Guide](#framework)).
-
-The transformation itself is declared in a fix-object which can be a file. For more information on how to declare transformations see [Metafix User Guide](/Fix-User-Guide.md).
-
-See [here a list for all available FIX functions and a cookbook for using fix](/Fix-function-and-Cookbook.md).
-
-> [!NOTE]
-> PS: There is also the transformation modul MORPH. Have a look at[ the old documentation](https://github.com/metafacture/metafacture-core/wiki/Metamorph-User-Guide) and the german cookbook by [Swissbib](https://swissbib.gitlab.io/metamorph-doku/).
-
-__________________
-
-## Framework
-
-> [!NOTE]
->Relevant for developers
-
-The framework includes the interfaces and abstract classes which form the foundation of the data processing pipelines. This part of Metafacture is only relevant for you if you plan to use Metafacture as a Java library or if you wish to add pipe elements to Flux.
-
-For more information see the [Framework User Guide](/Framework-User-Guide.md).
-
-